# OpenSAML 5.2.3 API

Packages
Package
Description
org.opensaml.core
Classes at the most general level of the library.
org.opensaml.core.config
Interfaces and classes related to library configuration and initialization.
org.opensaml.core.config.provider
Implementation of library configuration and initialization.
org.opensaml.core.criterion
Core `Criterion` subclasses.
org.opensaml.core.metrics
Classes supporting code instrumentation.
org.opensaml.core.metrics.impl
Implementation classes supporting code instrumentation.
org.opensaml.core.testing
org.opensaml.core.xml
Base classes for working with XML as Java objects and configuring the library.
org.opensaml.core.xml.config
Configuration of XML object providers and related functionality.
org.opensaml.core.xml.config.impl
Configuration implementation of XML object providers and related functionality.
org.opensaml.core.xml.io
Interfaces and abstract implementations of marshallers and unmarshallers.
org.opensaml.core.xml.mock
org.opensaml.core.xml.persist
Components for persisting XMLObjects.
org.opensaml.core.xml.persist.impl
Implementations of XML persistence interfaces.
org.opensaml.core.xml.schema
Interfaces for XMLObjects that represent XML schema types.
org.opensaml.core.xml.schema.impl
Implementations of the interfaces for XMLObjects that represent XML schema types.
org.opensaml.core.xml.util
Utility classes for working with XML, XMLObjects, and various data types.
org.opensaml.messaging
General interfaces and classes related to message processing and bindings to transport protocols.
org.opensaml.messaging.context
Interfaces and classes for tracking message processing state.
org.opensaml.messaging.context.httpclient
Interfaces and classes for tracking HTTP message processing state.
org.opensaml.messaging.context.navigate
A set of functions used to navigate and lookup data from a tree of `BaseContext`s.
org.opensaml.messaging.decoder
Interfaces and classes for decoding messages.
org.opensaml.messaging.decoder.httpclient
Interfaces and classes for decoding HTTP messages.
org.opensaml.messaging.decoder.servlet
Interfaces and classes for decoding messages that come from an `HttpServletRequest`.
org.opensaml.messaging.encoder
Interfaces and classes for encoding messages.
org.opensaml.messaging.encoder.httpclient
Interfaces and classes for encoding HTTP messages.
org.opensaml.messaging.encoder.servlet
Interfaces and classes for encoding messages to a `HttpServletResponse`.
org.opensaml.messaging.error
Interfaces and classes for message-related error handling.
org.opensaml.messaging.handler
Interfaces and classes for message context handlers.
org.opensaml.messaging.handler.impl
Implementations of message context handlers.
org.opensaml.messaging.logic
Interfaces and classes for messaging logic.
org.opensaml.messaging.pipeline
Interfaces and classes for message processing pipelines.
org.opensaml.messaging.pipeline.httpclient
Interfaces and classes for HTTP message processing pipelines.
org.opensaml.messaging.pipeline.servlet
Interfaces and classes for HTTP Servlet message processing pipelines.
org.opensaml.profile.action
Interfaces and classes for profile actions, discrete units of behavior that make up a profile.
org.opensaml.profile.action.impl
Implementations of general profile actions.
org.opensaml.profile.context
Context classes in support of profile behavior.
org.opensaml.profile.context.navigate
Functions for navigating profile context information.
org.opensaml.profile.criterion
Profile `Criterion` implementations.
org.opensaml.profile.logic
First order logic predicates and functions used for working with profile request data.
org.opensaml.profile.testing
org.opensaml.saml.common
Base classes for working with SAML as Java objects.
org.opensaml.saml.common.assertion
Common classes for validating SAML Assertions.
org.opensaml.saml.common.binding
Classes related to SAML binding operations.
org.opensaml.saml.common.binding.artifact
Classes supporting SAML artifact use.
org.opensaml.saml.common.binding.artifact.impl
Implementation of SAML artifact mapping.
org.opensaml.saml.common.binding.decoding
Classes used to decode SAML messages.
org.opensaml.saml.common.binding.encoding
Classes used to encode SAML messages.
org.opensaml.saml.common.binding.impl
Implementation of SAML binding-level functionality, such as MessageHandlers.
org.opensaml.saml.common.binding.security.impl
Classes responsible for performing transport-related and basic message validation of decoded SAML messages.
org.opensaml.saml.common.messaging
Support classes for SAML message security operations.
org.opensaml.saml.common.messaging.context
Context classes for SAML-based messaging function.
org.opensaml.saml.common.messaging.context.navigate
Functions to navigate SAML message contexts.
org.opensaml.saml.common.messaging.logic
Predicates related to SAML message contexts.
org.opensaml.saml.common.messaging.soap
Support classes for SAML SOAP message operations.
org.opensaml.saml.common.profile
Classes supporting general SAML profile behavior.
org.opensaml.saml.common.profile.impl
Actions and classes common to both SAML versions.
org.opensaml.saml.common.profile.logic
Functions and predicates supporting common SAML profile behavior.
org.opensaml.saml.common.xml
SAML constants and and misc XML functionality.
org.opensaml.saml.config
SAML library configuration.
org.opensaml.saml.config.impl
SAML configuration initializers.
org.opensaml.saml.criterion
`Criterion` based on SAML message/protocol information.
org.opensaml.saml.ext.idpdisco
Interfaces for SAML 2 Metadata Extension Identity Provider Discovery.
org.opensaml.saml.ext.idpdisco.impl
Implementation for SAML v2.0 Identity Provider Discovery Profile.
org.opensaml.saml.ext.reqattr
Interface for SAML V2.0 Protocol Extension For Requesting Attributes Per Request.
org.opensaml.saml.ext.reqattr.impl
Implementations for SAML V2.0 Protocol Extension For Requesting Attributes Per Request.
org.opensaml.saml.ext.saml1md
Interfaces for SAML 2 Metadata Profile for SAML 1.x.
org.opensaml.saml.ext.saml1md.impl
Implementation for SAML 1.x Metadata Profile.
org.opensaml.saml.ext.saml2alg
Interfaces for SAML v2.0 Metadata Profile for Algorithm Support Version 1.0.
org.opensaml.saml.ext.saml2alg.impl
Implementation for SAML v2.0 Metadata Profile for Algorithm Support Version 1.0.
org.opensaml.saml.ext.saml2aslo
Interfaces for SAML 2 Protocol Extension for Async Logout.
org.opensaml.saml.ext.saml2aslo.impl
Implementation for SAML 2 Protocol Extension for Async Logout objects.
org.opensaml.saml.ext.saml2cb
Interfaces for SAML 2 Channel Binding Extensions.
org.opensaml.saml.ext.saml2cb.impl
Implementation for SAML v2.0 Channel Binding Extensions Version 1.0.
org.opensaml.saml.ext.saml2delrestrict
Interfaces for SAML 2 Condition for Delegation Restriction.
org.opensaml.saml.ext.saml2delrestrict.impl
Implementation for SAML v2.0 Condition for Delegation Restriction Version 1.0.
org.opensaml.saml.ext.saml2mdattr
Interfaces for SAML 2 Metadata Extension for Entity Attributes.
org.opensaml.saml.ext.saml2mdattr.impl
Implementation for SAML v2.0 Metadata Extension for Entity Attributes Version 1.0.
org.opensaml.saml.ext.saml2mdquery
Interfaces for SAML 2 Metadata Profile for Standalone Query Requesters.
org.opensaml.saml.ext.saml2mdquery.impl
Implementation for SAML v2.0 Metadata Extension for Stand-Alone Query Requesters.
org.opensaml.saml.ext.saml2mdreqinit
Interfaces for SAML 2 Metadata Extension for SSO Service Provider Request Initiation.
org.opensaml.saml.ext.saml2mdreqinit.impl
Concrete implementations of the interfaces for the SAML 2 Metadata Extension for SSO Service Provider Request Initiation.
org.opensaml.saml.ext.saml2mdrpi
The package to define the SAML V2.0 Metadata Extensions for Registration and Publication Information Version 1.0.
org.opensaml.saml.ext.saml2mdrpi.impl
Concrete implementations of the interfaces for the SAML V2.0 Metadata Extensions for Registration and Publication Information Version 1.0.
org.opensaml.saml.ext.saml2mdui
Interfaces for SAML 2 Metadata Extensions for Login UI and Discovery.
org.opensaml.saml.ext.saml2mdui.impl
Implementation for SAML V2 Metadata Extensions for UI and Discovery.
org.opensaml.saml.ext.samlec
Interfaces for SAML-EC GSS-API Mechanism.
org.opensaml.saml.ext.samlec.impl
Implementation for SAML-EC GSS-API schema content.
org.opensaml.saml.ext.samlpthrpty
Interfaces for SAML 2 Metadata Extension for Third-Party Request Protocol Extension.
org.opensaml.saml.ext.samlpthrpty.impl
Implementation for SAML V2 Protocol Extension for Third-Party Requests.
org.opensaml.saml.metadata
Classes for fetching and querying SAML metadata.
org.opensaml.saml.metadata.criteria.entity
Classes for SAML metadata entity criteria.
org.opensaml.saml.metadata.criteria.entity.impl
Implementation classes related to `EntityDescriptor` criteria, particularly evaluable (predicate) criteria.
org.opensaml.saml.metadata.criteria.role
Classes for SAML metadata role criteria.
org.opensaml.saml.metadata.criteria.role.impl
Implementation classes related to `RoleDescriptor` criteria, particularly evaluable (predicate) criteria.
org.opensaml.saml.metadata.generator.impl
Implementation of Velocity-based metadata generation.
org.opensaml.saml.metadata.resolver
Classes for SAML metadata resolution.
org.opensaml.saml.metadata.resolver.filter
Classes for SAML metadata filtering.
org.opensaml.saml.metadata.resolver.filter.data.impl
Data classes for use with `MetadataFilterContext`.
org.opensaml.saml.metadata.resolver.filter.impl
Implementation of Metadata Filters.
org.opensaml.saml.metadata.resolver.impl
Classes for retrieving, filtering, and querying metadata.
org.opensaml.saml.metadata.resolver.index
Classes for SAML metadata indexing.
org.opensaml.saml.metadata.resolver.index.impl
Implementation of the metadata resolver indexes.
org.opensaml.saml.metadata.support
Classes in support of SAML metadata.
org.opensaml.saml.saml1.binding.artifact
Classes that may be used to create and manipulate SAML 1 artifacts.
org.opensaml.saml.saml1.binding.decoding.impl
SAML 1.x message decoders.
org.opensaml.saml.saml1.binding.encoding.impl
SAML 1.x message encoders.
org.opensaml.saml.saml1.binding.impl
General message handlers for SAML 1.x.
org.opensaml.saml.saml1.core
Interfaces for SAML 1.0 and 1.1 types and elements.
org.opensaml.saml.saml1.core.impl
Implementations of SAML 1.x core specification types and elements.
org.opensaml.saml.saml1.profile
Classes for SAML 1.x profile behavior.
org.opensaml.saml.saml1.profile.impl
Implementations of SAML 1.x profile behavior.
org.opensaml.saml.saml1.testing
org.opensaml.saml.saml2.assertion
Interfaces and API classes for validating SAML 2 Assertions.
org.opensaml.saml.saml2.assertion.impl
Implementation classes for validating SAML 2 Assertions.
org.opensaml.saml.saml2.assertion.messaging
Interfaces and API classes related to networking and messaging APIs that support validating SAML 2 Assertions.
org.opensaml.saml.saml2.assertion.messaging.impl
Implementation classes related to networking and messaging APIs that support validating SAML 2 Assertions.
org.opensaml.saml.saml2.binding.artifact
Classes that may be used to create and manipulate SAML 2 artifacts.
org.opensaml.saml.saml2.binding.decoding.impl
SAML 2.0 message decoders.
org.opensaml.saml.saml2.binding.encoding.impl
SAML 2.0 message encoders.
org.opensaml.saml.saml2.binding.impl
General message handlers for SAML 2.0.
org.opensaml.saml.saml2.binding.security.impl
Security-related message handlers for SAML 2.0.
org.opensaml.saml.saml2.common
Interfaces for elements and attributes used in multiple SAML 2.0 specification.
org.opensaml.saml.saml2.core
Interfaces for SAML 2.0 core and protocol interfaces.
org.opensaml.saml.saml2.core.impl
Implementations of SAML 2.0 core specification types and elements.
org.opensaml.saml.saml2.ecp
Interfaces for SAML 2 ECP Elements.
org.opensaml.saml.saml2.ecp.impl
Implementations of SAML 2.0 ECP types and elements.
org.opensaml.saml.saml2.encryption
Classes for encrypting and decrypting SAML.
org.opensaml.saml.saml2.metadata
Concrete definitions of the objects described in saml-metadata-2.0-os work.
org.opensaml.saml.saml2.metadata.impl
Concrete implementations of SAML 2.0 metadata objects.
org.opensaml.saml.saml2.profile
Classes for SAML 2.0 profile behavior.
org.opensaml.saml.saml2.profile.context
Context classes supporting SAML 2 profiles.
org.opensaml.saml.saml2.profile.impl
Implementations of SAML 2.0 profile behavior.
org.opensaml.saml.saml2.testing
org.opensaml.saml.saml2.wssecurity
Classes for SAML WS-Security.
org.opensaml.saml.saml2.wssecurity.messaging.impl
Implementation of SAML WS-Security message handler functionality.
org.opensaml.saml.security
Classes related to general security components within a SAML system.
org.opensaml.saml.security.impl
Classes related to verifying various credentials within a SAML system.
org.opensaml.security
Interfaces and classes used in representing cryptographic credentials, evaluating the trustworthiness of security of tokens, etc.
org.opensaml.security.config
OpenSAML configuration classes.
org.opensaml.security.config.impl
Security configuration implementation classes.
org.opensaml.security.credential
Interfaces and classes related to credentials and ways to represent them.
org.opensaml.security.credential.criteria.impl
Implementations of `Criterion` where the parameterized evaluation target type is `Credential`.
org.opensaml.security.credential.impl
`CredentialResolver` implementation classes.
org.opensaml.security.criteria
Classes which model lookup criteria used as input to a `Resolver`.
org.opensaml.security.crypto
General cryptographic functionality.
org.opensaml.security.crypto.dh
Support for Diffie-Hellman cryptography.
org.opensaml.security.crypto.ec
Support for Elliptic-Curve cryptography.
org.opensaml.security.crypto.ec.curves
Implementations of `NamedCurve` used with Elliptic-Curve cryptography.
org.opensaml.security.httpclient
Security API support for Apache HttpClient.
org.opensaml.security.httpclient.impl
Security implementation support for Apache HttpClient.
org.opensaml.security.messaging
Messaging-related security classes.
org.opensaml.security.messaging.impl
Message handler implementations.
org.opensaml.security.testing
org.opensaml.security.trust
Interfaces and classes used to evaluate the trustworthiness and validity of `Credential`s.
org.opensaml.security.trust.impl
`TrustEngine` implementation classes.
org.opensaml.security.x509
X.509-based credential and trust classes.
org.opensaml.security.x509.impl
`TrustEngine` implementation classes related to PKIX.
org.opensaml.security.x509.tls
TLS security functionality.
org.opensaml.security.x509.tls.impl
Implementation classes for client TLS security.
org.opensaml.soap.client
SOAP client functionality.
org.opensaml.soap.client.http
SOAP HTTP client functionality.
org.opensaml.soap.client.messaging
SOAP HTTP client messaging functionality.
org.opensaml.soap.client.security
Classes related to SOAP client security.
org.opensaml.soap.client.soap11.decoder.http.impl
SOAP 1.1 client message decoding support implementations.
org.opensaml.soap.client.soap11.encoder.http.impl
SOAP 1.1 client message encoding support implementations.
org.opensaml.soap.common
Common classes shared across SOAP versions, clients, and transports.
org.opensaml.soap.config
SOAP library configuration.
org.opensaml.soap.config.impl
Configuration and initialization of SOAP XMLObject providers.
org.opensaml.soap.messaging
SOAP messaging support components.
org.opensaml.soap.messaging.context
Context classes in support of SOAP messaging.
org.opensaml.soap.soap11
XMLObject interfaces for SOAP 1.1 elements.
org.opensaml.soap.soap11.decoder.http.impl
SOAP over HTTP 1.1 message decoder and handlers.
org.opensaml.soap.soap11.encoder.http.impl
SOAP over HTTP 1.1 message encoder and handlers.
org.opensaml.soap.soap11.impl
Provided implementations of the SOAP 1.1 XMLObject interfaces.
org.opensaml.soap.soap11.messaging.impl
SOAP messaging support implementations.
org.opensaml.soap.soap11.profile.impl
Profile actions related to SOAP 1.1.
org.opensaml.soap.soap12
XMLObject interfaces for SOAP 1.2 elements.
org.opensaml.soap.util
General SOAP utility classes.
org.opensaml.soap.wsaddressing
XMLObject interfaces for WS-Addressing 1.0 elements.
org.opensaml.soap.wsaddressing.impl
XML Object provider implementations for WS-Addressing.
org.opensaml.soap.wsaddressing.messaging
WS-Addressing messaging support components.
org.opensaml.soap.wsaddressing.messaging.impl
WS-Addressing message handling components.
org.opensaml.soap.wsaddressing.util
Support classes for WS-Addressing.
org.opensaml.soap.wsfed
XMLObject interfaces for WS-Federation elements.
org.opensaml.soap.wsfed.impl
XML Object provider implementations for WS-Federation.
org.opensaml.soap.wspolicy
XMLObject interfaces for WS-Policy 1.2 elements.
org.opensaml.soap.wspolicy.impl
XML Object provider implementations for WS-Policy.
org.opensaml.soap.wssecurity
XMLObject interfaces for WS-Security 1.1 elements.
org.opensaml.soap.wssecurity.impl
XML Object provider implementations for WS-Security.
org.opensaml.soap.wssecurity.messaging
WS-Security messaging support components.
org.opensaml.soap.wssecurity.messaging.impl
WS-Security message handling components.
org.opensaml.soap.wssecurity.util
Support classes for WS-Security.
org.opensaml.soap.wstrust
XMLObject interfaces for WS-Trust 1.3 elements.
org.opensaml.soap.wstrust.impl
XML Object provider implementations for WS-Trust.
org.opensaml.spring.config
Beans for configuration classes.
org.opensaml.spring.credential
Factory beans for various credential classes.
org.opensaml.spring.httpclient
Factory beans for various classes related to use of HttpClient.
org.opensaml.spring.tls
Spring support for TLS configuration.
org.opensaml.spring.trust
Factory beans for trust engines.
org.opensaml.storage
Interfaces and classes for storing state data of the type used in replay caches, conversation identifiers, etc.
org.opensaml.storage.annotation
Annotations in support of `StorageService` use by custom objects.
org.opensaml.storage.impl
Storage-related implementation classes.
org.opensaml.storage.impl.client
Implementation of `StorageService` that unifies cookie and HTML Local Storage.
org.opensaml.storage.impl.memcached
Implementation of memcached `StorageService`.
org.opensaml.storage.testing
org.opensaml.xacml
General XACML classes.
org.opensaml.xacml.config.impl
Configuration classes for XACML classes.
org.opensaml.xacml.ctx
XMLObject interfaces for XACML context schema.
org.opensaml.xacml.ctx.impl
XMLObject implementations for XACML context schema.
org.opensaml.xacml.ctx.provider.impl
Implementations of XACML functionality.
org.opensaml.xacml.impl
XMLObject provider implementation support for XACML.
org.opensaml.xacml.policy
XMLObject interfaces for XACML policy schema.
org.opensaml.xacml.policy.impl
XMLObject provider implementation classes for XACML policy schema.
org.opensaml.xacml.profile.saml
XMLObject interfaces for SAML XACML profile.
org.opensaml.xacml.profile.saml.config.impl
Configuration classes for XACML SAML profile classes.
org.opensaml.xacml.profile.saml.impl
XMLObject implementation classes for XACML SAML profile.
org.opensaml.xmlsec
Configuration and support classes for security.
org.opensaml.xmlsec.agreement
API components related to key agreement operations.
org.opensaml.xmlsec.agreement.impl
Implementation components related to key agreement operations.
org.opensaml.xmlsec.algorithm
Configuration and support classes for security algorithms.
org.opensaml.xmlsec.algorithm.descriptors
Algorithm descriptor classes.
org.opensaml.xmlsec.config
OpenSAML configuration classes.
org.opensaml.xmlsec.config.impl
Configuration and initialization of security.
org.opensaml.xmlsec.context
Message context classes for XML Security.
org.opensaml.xmlsec.criterion
Criterion classes for XML Security.
org.opensaml.xmlsec.crypto
Support classes for XML Security operations.
org.opensaml.xmlsec.derivation
API components related to key derivation operations.
org.opensaml.xmlsec.derivation.impl
Implementation components related to key derivation operations.
org.opensaml.xmlsec.encryption
XMLObject interfaces and helper classes for representing encrypted content and encrypting/decrypting content.
org.opensaml.xmlsec.encryption.impl
Implementations of the interfaces for XMLObjects that represent XML encryption types.
org.opensaml.xmlsec.encryption.support
Functional support for XML Encryption.
org.opensaml.xmlsec.impl
Implementation of configuration and parameter resolver classes.
org.opensaml.xmlsec.impl.provider
Provides implementation of Santuario-specific components.
org.opensaml.xmlsec.keyinfo
Classes in support of processing XML Signature KeyInfo material.
org.opensaml.xmlsec.keyinfo.impl
Interfaces and classes for working with XML KeyInfo elements.
org.opensaml.xmlsec.keyinfo.impl.provider
Specific implementations of `KeyInfoProvider`.
org.opensaml.xmlsec.messaging.impl
Message handlers for XML Security functionality.
org.opensaml.xmlsec.signature
XMLObject interfaces and helper classes for representing digitally signed content and signing/validating content.
org.opensaml.xmlsec.signature.impl
Implementations of the interfaces for XMLObjects that represent XML signature types.
org.opensaml.xmlsec.signature.support
Functional support for XML Signature.
org.opensaml.xmlsec.signature.support.impl
Implementations of signature evaluation functions.
org.opensaml.xmlsec.signature.support.impl.provider
Provides Santuario-specific implementation of signing and validation.