# All Classes and Interfaces

Class
Description
AbstractAttributePredicate
Abstract base class for predicates operating on an `AttributeContext`.
AbstractConditionalProfileConfiguration
Base class for `ConditionalProfileConfiguration` implementations.
AbstractDefaultSecurityConfigurationLookupFunction<T>
Base class for lookup functions that require access to the default security configuration for a profile via the `RelyingPartyConfiguration` interface.
AbstractDefaultSecurityConfigurationLookupFunction<T>
Base class for lookup functions that require access to the default security configuration for a profile via the `RelyingPartyConfiguration` interface.
AbstractModule
`Module` base class implementing basic file management.
AbstractPlugin<T extends Module>
A base class implementing `Plugin` that defaults common settings.
AbstractProfileConfiguration
Base class for `ProfileConfiguration` implementations.
AbstractRelyingPartyLookupFunction<ResultType>
Abstract base class for a function that requires a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
AbstractRelyingPartyLookupFunction<ResultType>
Abstract base class for a function that requires a `ProfileRequestContext` obtained via a lookup function, by default the parent of the specified `MessageContext`, and a `RelyingPartyContext` obtained via a lookup function, by default a child of the aforementioned parent.
AbstractRelyingPartyPredicate
Base class for a predicate that evaluates a `ProfileRequestContext` and requires access to a `RelyingPartyContext`.
AbstractRelyingPartyPredicate
Abstract base class for a predicate that evaluates a `MessageContext` and which requires a `RelyingPartyContext` obtained via a lookup function, by default a child of the `InOutOperationContext` the parent of the specified `MessageContext`.
ArtifactResolutionProfileConfiguration
Configuration support for SAML 1.x artifact resolution profile.
ArtifactResolutionProfileConfiguration
Configuration support for SAML 2.0 artifact resolution profile.
AssertionAudiencesLookupFunction
A function that returns `SAMLAssertionProducingProfileConfiguration.getAssertionAudiences(ProfileRequestContext)` if such a profile is available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
AssertionLifetimeLookupFunction
A function that returns `SAMLAssertionProducingProfileConfiguration.getAssertionLifetime(ProfileRequestContext)` if such a profile is available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
AttributeQueryProfileConfiguration
Configuration support for SAML 1.x attribute query profile.
AttributeQueryProfileConfiguration
Configuration support for SAML 2.0 attribute query profile.
AttributeResolvingProfileConfiguration
`ProfileConfiguration` with optional resolution of attributes.
AttributesAuditExtractor
`Function` that returns the attribute IDs from an `AttributeContext`.
AudienceRestrictionsLookupFunction
A function that returns the effective audience restrictions to include in assertions, based on combining a relying party's entityID with the result of `SAMLAssertionProducingProfileConfiguration.getAssertionAudiences(ProfileRequestContext)`, if such a profile is available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
AuditContext
`BaseContext` containing information to preserve for auditing/logging.
BaseCriteriaRelyingPartyConfiigurationResolver<ReturnType>
Abstract base resolver which uses an instance of `RelyingPartyConfigurationResolver` to resolve a `RelyingPartyConfiguration` using an input `CriteriaSet` only.
BasicRelyingPartyConfiguration
The configuration that applies to a peer with which the software is communicating.
BasicSAMLArtifactConfiguration
Concrete class for outbound SAML artifact configuration.
BindingDescriptor
Subclass that adds awareness of a Spring bean ID for a binding's `MessageEncoder`.
BrowserSSOProfileConfiguration
Configuration for SAML 1.x Browser SSO profile.
BrowserSSOProfileConfiguration
Configuration for SAML 2.0 Browser SSO profile.
CheckAddressPredicate
A predicate that evaluates a `ProfileRequestContext` and extracts the effective setting of `BrowserSSOProfileConfiguration.isCheckAddress(ProfileRequestContext)`.
CheckInResponseToPredicate
A predicate that evaluates a `ProfileRequestContext` and extracts the effective setting of `BrowserSSOProfileConfiguration.isCheckInResponseTo(ProfileRequestContext)`.
ClientTLSArtifactRequestsPredicate
A predicate implementation that forwards to `SAMLArtifactConsumerProfileConfiguration.isClientTLSArtifactRequests(MessageContext)`.
ClientTLSSOAPAttributeQueriesPredicate
A predicate implementation that forwards to `AttributeQueryProfileConfiguration.isClientTLSSOAPRequests(MessageContext)`.
ClientTLSSOAPLogoutRequestsPredicate
A predicate implementation that forwards to `SingleLogoutProfileConfiguration.isClientTLSSOAPRequests(MessageContext)`.
ClientTLSValidationConfigurationLookupFunction
A function that returns a `ClientTLSValidationConfiguration` list by way of various lookup strategies.
ConditionalProfileConfiguration
A `ProfileConfiguration` supporting an activation condition.
CriteriaDecryptionConfigurationResolver
Resolver which uses an instance of `RelyingPartyConfigurationResolver` to resolve a list of `DecryptionConfiguration` applicable for a peer entity.
CriteriaSelfEntityIDResolver
Resolver which uses an instance of `RelyingPartyConfigurationResolver` to resolve our own entityID.
DateAttributePredicate
Provides a date/time matching predicate that compares a date-based attribute value against current system time with optional offset.
DecryptionConfigurationLookupFunction
A function that returns a `DecryptionConfiguration` list by way of various lookup strategies.
DefaultRelyingPartyConfigurationResolver
Retrieves a per-relying party configuration for a given profile request based on the supplied `CriteriaSet`.
DetailedErrorsPredicate
Predicate to determine whether a relying party should see detailed error information.
DynamicAttributePredicate
Predicate over an `AttributeContext` that derives the value(s) to match based on one or more supplied Functions instead of static values.
ECPProfileConfiguration
Configuration support for SAML 2.0 ECP profile.
EncryptionConfigurationLookupFunction
A function that returns a `EncryptionConfiguration` list using injected lookup strategies.
HttpClientSecurityConfigurationLookupFunction
A `MessageContext` function that returns a `HttpClientSecurityConfiguration` list by way of various lookup strategies.
IdentifierGenerationStrategyLookupFunction
A function that returns an `IdentifierGenerationStrategy` by way of a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
IgnoreRequestSignaturesPredicate
Predicate that decides whether to ignore a request signature.
InstallableComponentInfo
Class which encapsulates the information about a given Installable Component as downloaded from the appropriate location (as a Properties file).
InstallableComponentInfo.VersionInfo
Encapsulation of the information about a given IdP version.
InstallableComponentSupport
Useful methods for supporting Installable Components.
InstallableComponentSupport.SupportLevel
Value for support level pointed to by `InstallableComponentSupport.SUPPORT_LEVEL_INTERFIX`.
InstallableComponentVersion
A version string (Major.minor.patch) as a handy class.
IssuerLookupFunction
A function that returns `RelyingPartyConfiguration.getIssuer(org.opensaml.profile.context.ProfileRequestContext)`() if available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
LoopDetectionPredicate
A condition that relies on a `Meter` to detect looping SPs.
MappedEntityAttributesPredicate
Extended version of EntityAttributes-driven predicate that uses an optimization to check for mapped attributes in an `AttributesMapContainer` structure.
MaximumTimeSinceAuthnLookupFunction
A function that returns `BrowserSSOProfileConfiguration.getMaximumTimeSinceAuthn(ProfileRequestContext)` if such a profile is available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
MessageHandlerLookupFunction
A function that returns `SAMLProfileConfiguration.getMessageHandler(MessageContext)` if such a profile is available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
MockProfileConfiguration
Mock implementation of `ProfileConfiguration`.
Module
This interface is the base of those exported via the service API into the IdP and in the future other applications.
Module.ModuleResource
Interface to a resource managed by the module.
Module.ResourceResult
Resource management outcome.
ModuleContext
Information required to perform some module operations.
ModuleContext.OperationType
What is the caller doing?
ModuleException
Module exception class.
NotBeforeProfileConfigPredicate
A predicate that returns `SAMLAssertionProducingProfileConfiguration.isIncludeConditionsNotBefore(ProfileRequestContext)` if such a profile is available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
OpenSAMLConfigBean
A simple bean that may be used with Spring to initialize the OpenSAML library with injected instances of some critical objects.
OverriddenIssuerProfileConfiguration
`ProfileConfiguration` with optional override of issuer setting.
Plugin<T extends Module>
The base interface for plugins into the IdP and SP.
Plugin.Package
An abstraction for "a thing that we want to unpack into idp home (outside webapps)".
PluginException
Plugin exception class.
ProfileConfiguration
Represents the configuration of a particular communication profile.
PropertyDrivenModule
Implementation of `Module` relying on Java `Properties`.
PropertyDrivenPlugin<T extends Module>
Implementation of `Plugin` relying on Java `Properties`.
PropertyDrivenPlugin.PackageDescriptor
Implementation of `Plugin.Package` for our use.
ProxyCountLookupFunction
A function that returns the allowable proxy count based on the result of `BrowserSSOProfileConfiguration.getProxyCount(ProfileRequestContext)`, if such a profile is available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
QualifiedNameIDFormatsLookupFunction
A function that returns the `NameID` Formats whose NameQualifier attributes should allow for defaulting based on the result of `SingleLogoutProfileConfiguration.getQualifiedNameIDFormats(ProfileRequestContext)` if such a profile is available from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
RegexAttributePredicate
Predicate that evaluates an `AttributeContext` and checks a specific attribute for value(s) that match a regular expression.
RelyingPartiesActivationConditionFactory
Factory function for manufacturing activation conditions based on `AttributeTranscoderRegistry.PROP_RELYINGPARTIES`.
RelyingPartyConfiguration
The configuration that applies to a peer with which the software is communicating.
RelyingPartyConfigurationResolver
Interface to a resolution service that identifies the applicable `RelyingPartyConfiguration` instance for a request based on extensible criteria.
RelyingPartyConfigurationSupport
Support functions for building `RelyingPartyConfiguration` objects with SAML-aware activation conditions.
RelyingPartyContext
`BaseContext` containing relying party specific information, usually a subcontext of `ProfileRequestContext`.
RelyingPartyCredentialResolver
Credential resolver whose purpose is to resolve configured IdP signing credentials.
RelyingPartyIdLookupFunction
A function that returns `RelyingPartyContext.getRelyingPartyId()` from a `RelyingPartyContext` obtained via a lookup function, by default a child of the `ProfileRequestContext`.
RelyingPartyIdPredicate
Predicate that evaluates a `ProfileRequestContext` by looking for a relying party ID that matches one of a designated set, or a generic predicate.
ResolveAttributesPredicate
Predicate to determine whether a profile request should resolve attributes.
SAML2AssertionProducingProfileConfiguration
Interface for SAML 2.0 profiles that produce assertions.
SAML2ProfileConfiguration
Base interface for SAML 2 profile configurations.
SAMLArtifactAwareProfileConfiguration
Common interface for SAML profile configurations involving artifact production.
SAMLArtifactConfiguration
Interface for outbound SAML artifact configuration.
SAMLArtifactConsumerProfileConfiguration
Common interface for SAML profile configurations involving artifact consumption, for example artifact resolution requests.
SAMLAssertionConsumingProfileConfiguration
Interface for configuration of SAML profiles that consume assertions.
SAMLAssertionProducingProfileConfiguration
Interface for SAML profiles that produce assertions.
SAMLMetadataContextLookupFunction
A function to access a `SAMLMetadataContext` underlying a `RelyingPartyContext` located via a lookup function.
SAMLMetadataContextLookupFunction
A function to access a `SAMLMetadataContext` underlying a `RelyingPartyContext` located via a lookup function, by default a child of the profile request context.
SAMLProfileConfiguration
Common interface for SAML profile configurations.
ScriptedContextLookupFunction<T extends BaseContext>
A `Function` over a `BaseContext` which calls out to a supplied script.
ScriptedPredicate
A `Predicate` which calls out to a supplied script.
ServletRequestProfileRequestContextLookup
Looks up the profile request context from a servlet request attribute.
SignArtifactRequestsPredicate
A predicate implementation that forwards to `SAMLArtifactConsumerProfileConfiguration.isSignArtifactRequests(MessageContext)`.
SignAssertionsPredicate
A predicate implementation that forwards to profile configuration lookup or follows `SPSSODescriptor.getWantAssertionsSigned()` if so configured.
SignatureSigningConfigurationLookupFunction
A `MessageContext` function that returns a `SignatureSigningConfiguration` list by way of various lookup strategies.
SignatureSigningConfigurationLookupFunction
A function that returns a `SignatureSigningConfiguration` list by way of various lookup strategies.
SignatureValidationConfigurationLookupFunction
A `MessageContext` function that returns a `SignatureValidationConfiguration` list by way of various lookup strategies.
SignatureValidationConfigurationLookupFunction
A function that returns a `SignatureValidationConfiguration` list by way of various lookup strategies.
SignRequestsPredicate
A predicate implementation that forwards to `SAMLProfileConfiguration.isSignRequests(ProfileRequestContext)` or follows `IDPSSODescriptor.getWantAuthnRequestsSigned()` if so configured.
SignResponsesPredicate
A predicate implementation that forwards to `SAMLProfileConfiguration.isSignResponses(ProfileRequestContext)`.
SignSOAPAttributeQueriesPredicate
A predicate implementation that forwards to `AttributeQueryProfileConfiguration.isSignSOAPRequests(MessageContext)`.
SignSOAPLogoutRequestsPredicate
A predicate implementation that forwards to `SingleLogoutProfileConfiguration.isSignSOAPRequests(MessageContext)`.
SimpleAttributePredicate
Predicate that evaluates an `AttributeContext` and checks for particular attribute/value pairs.
SingleLogoutProfileConfiguration
Configuration support for SAML 2 Single Logout.
SpringExpressionContextLookupFunction<T extends BaseContext,U>
A `Function` over a `BaseContext` which calls out to a Spring Expression.
SpringExpressionPredicate
Predicate whose condition is defined by an Spring EL expression.
VerifiedProfileCriterion
`Criterion` indicating whether a relying party has been verified in a profile-specific fashion.
VerifiedProfilePredicate
Predicate to determine whether a profile request is from a verified source.