Package org.pac4j.saml.client
Class SAML2Client
- java.lang.Object
-
- org.pac4j.core.util.InitializableObject
-
- org.pac4j.core.client.BaseClient<C>
-
- org.pac4j.core.client.IndirectClient<SAML2Credentials>
-
- org.pac4j.saml.client.SAML2Client
-
- All Implemented Interfaces:
Client<SAML2Credentials>
public class SAML2Client extends IndirectClient<SAML2Credentials>
This class is the client to authenticate and logout users with a SAML2 Identity Provider.- Since:
- 1.5.0
- Author:
- Michael Remond, Misagh Moayyed, Ruochao Zheng, Jerome Leleu
-
-
Field Summary
Fields Modifier and Type Field Description protected SAML2ResponseValidator
authnResponseValidator
protected SAML2Configuration
configuration
protected SAMLContextProvider
contextProvider
protected org.opensaml.saml.saml2.encryption.Decrypter
decrypter
protected SAML2MetadataResolver
idpMetadataResolver
protected SAML2ProfileHandler<org.opensaml.saml.saml2.core.LogoutRequest>
logoutProfileHandler
protected SAML2LogoutValidator
logoutValidator
protected SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest>
profileHandler
protected ReplayCacheProvider
replayCache
protected SignatureSigningParametersProvider
signatureSigningParametersProvider
protected SAML2SignatureTrustEngineProvider
signatureTrustEngineProvider
protected SOAPPipelineProvider
soapPipelineProvider
protected SAML2MetadataResolver
spMetadataResolver
protected ValueGenerator
stateGenerator
-
Fields inherited from class org.pac4j.core.client.IndirectClient
ATTEMPTED_AUTHENTICATION_SUFFIX, callbackUrl, callbackUrlResolver, urlResolver
-
Fields inherited from class org.pac4j.core.client.BaseClient
logger
-
-
Constructor Summary
Constructors Constructor Description SAML2Client()
SAML2Client(SAML2Configuration configuration)
-
Method Summary
-
Methods inherited from class org.pac4j.core.client.IndirectClient
computeFinalCallbackUrl, defaultLogoutActionBuilder, defaultRedirectionActionBuilder, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getCredentials, getLogoutAction, getLogoutActionBuilder, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, internalInit, newDefaultCallbackUrlResolver, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setLogoutActionBuilder, setRedirectionActionBuilder, setUrlResolver, toString
-
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, defaultAuthenticator, defaultCredentialsExtractor, defaultProfileCreator, getAuthenticator, getAuthorizationGenerators, getCredentialsExtractor, getCustomProperties, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getUserProfile, renewUserProfile, retrieveCredentials, retrieveUserProfile, setAuthenticator, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setCredentialsExtractor, setCustomProperties, setName, setProfileCreator, setProfileFactoryWhenNotAuthenticated
-
Methods inherited from class org.pac4j.core.util.InitializableObject
init, isInitialized
-
-
-
-
Field Detail
-
contextProvider
protected SAMLContextProvider contextProvider
-
signatureSigningParametersProvider
protected SignatureSigningParametersProvider signatureSigningParametersProvider
-
profileHandler
protected SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest> profileHandler
-
logoutProfileHandler
protected SAML2ProfileHandler<org.opensaml.saml.saml2.core.LogoutRequest> logoutProfileHandler
-
authnResponseValidator
protected SAML2ResponseValidator authnResponseValidator
-
logoutValidator
protected SAML2LogoutValidator logoutValidator
-
signatureTrustEngineProvider
protected SAML2SignatureTrustEngineProvider signatureTrustEngineProvider
-
idpMetadataResolver
protected SAML2MetadataResolver idpMetadataResolver
-
spMetadataResolver
protected SAML2MetadataResolver spMetadataResolver
-
decrypter
protected org.opensaml.saml.saml2.encryption.Decrypter decrypter
-
configuration
protected SAML2Configuration configuration
-
stateGenerator
protected ValueGenerator stateGenerator
-
replayCache
protected ReplayCacheProvider replayCache
-
soapPipelineProvider
protected SOAPPipelineProvider soapPipelineProvider
-
-
Constructor Detail
-
SAML2Client
public SAML2Client()
-
SAML2Client
public SAML2Client(SAML2Configuration configuration)
-
-
Method Detail
-
clientInit
protected void clientInit()
- Specified by:
clientInit
in classIndirectClient<SAML2Credentials>
-
initSOAPPipelineProvider
protected void initSOAPPipelineProvider()
-
initSAMLProfileHandler
protected void initSAMLProfileHandler()
-
initSAMLLogoutProfileHandler
protected void initSAMLLogoutProfileHandler()
-
initSAMLLogoutResponseValidator
protected void initSAMLLogoutResponseValidator()
-
initSAMLResponseValidator
protected void initSAMLResponseValidator()
-
initSignatureTrustEngineProvider
protected void initSignatureTrustEngineProvider()
-
initSAMLContextProvider
protected void initSAMLContextProvider()
-
initServiceProviderMetadataResolver
protected void initServiceProviderMetadataResolver()
-
initIdentityProviderMetadataResolver
protected void initIdentityProviderMetadataResolver()
-
initDecrypter
protected void initDecrypter()
-
initSignatureSigningParametersProvider
protected void initSignatureSigningParametersProvider()
-
initSAMLReplayCache
protected void initSAMLReplayCache()
-
destroy
public void destroy()
-
notifySessionRenewal
public void notifySessionRenewal(String oldSessionId, WebContext context)
- Overrides:
notifySessionRenewal
in classBaseClient<SAML2Credentials>
-
getAuthnResponseValidator
public SAML2ResponseValidator getAuthnResponseValidator()
-
getServiceProviderMetadataResolver
public final SAML2MetadataResolver getServiceProviderMetadataResolver()
-
getIdentityProviderMetadataResolver
public final SAML2MetadataResolver getIdentityProviderMetadataResolver()
-
getIdentityProviderResolvedEntityId
public final String getIdentityProviderResolvedEntityId()
-
getServiceProviderResolvedEntityId
public final String getServiceProviderResolvedEntityId()
-
setConfiguration
public void setConfiguration(SAML2Configuration configuration)
-
getConfiguration
public final SAML2Configuration getConfiguration()
-
getContextProvider
public SAMLContextProvider getContextProvider()
-
getLogoutValidator
public SAML2LogoutValidator getLogoutValidator()
-
getIdpMetadataResolver
public SAML2MetadataResolver getIdpMetadataResolver()
-
getSpMetadataResolver
public SAML2MetadataResolver getSpMetadataResolver()
-
getProfileHandler
public SAML2ProfileHandler<org.opensaml.saml.saml2.core.AuthnRequest> getProfileHandler()
-
getSignatureSigningParametersProvider
public SignatureSigningParametersProvider getSignatureSigningParametersProvider()
-
getSignatureTrustEngineProvider
public SAML2SignatureTrustEngineProvider getSignatureTrustEngineProvider()
-
getStateGenerator
public ValueGenerator getStateGenerator()
-
setStateGenerator
public void setStateGenerator(ValueGenerator stateGenerator)
-
getLogoutProfileHandler
public SAML2ProfileHandler<org.opensaml.saml.saml2.core.LogoutRequest> getLogoutProfileHandler()
-
setLogoutProfileHandler
public void setLogoutProfileHandler(SAML2ProfileHandler<org.opensaml.saml.saml2.core.LogoutRequest> logoutProfileHandler)
-
getReplayCache
public ReplayCacheProvider getReplayCache()
-
-