Package org.pac4j.saml.client
Class SAML2Client
java.lang.Object
org.pac4j.core.util.InitializableObject
org.pac4j.core.client.BaseClient
org.pac4j.core.client.IndirectClient
org.pac4j.saml.client.SAML2Client
- All Implemented Interfaces:
org.pac4j.core.client.Client
public class SAML2Client
extends org.pac4j.core.client.IndirectClient
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
Modifier and TypeFieldDescriptionprotected SAML2ResponseValidator
protected SAML2Configuration
protected SAMLContextProvider
protected org.opensaml.saml.saml2.encryption.Decrypter
protected SAML2MetadataResolver
protected SAML2LogoutValidator
protected ReplayCacheProvider
protected SAML2MetadataResolver
protected SignatureSigningParametersProvider
protected SAML2SignatureTrustEngineProvider
protected SOAPPipelineProvider
protected org.pac4j.core.util.generator.ValueGenerator
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, saveProfileInSession
-
Constructor Summary
ConstructorDescriptionConstructor for SAML2Client.SAML2Client
(SAML2Configuration configuration) Constructor for SAML2Client. -
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
destroy.final String
getIdentityProviderResolvedEntityId.getLogoutRequestMessageSender.final String
getServiceProviderResolvedEntityId.getSSOMessageSender.protected void
initDecrypter.protected void
initIdentityProviderMetadataResolver.protected void
initSAMLContextProvider.protected void
initSAMLLogoutResponseValidator.protected void
initSAMLReplayCache.protected void
initSAMLResponseValidator.protected void
initServiceProviderMetadataResolver.protected void
initSignatureSigningParametersProvider.protected void
initSignatureTrustEngineProvider.protected void
initSOAPPipelineProvider.protected void
internalInit
(boolean forceReinit) void
notifySessionRenewal
(org.pac4j.core.context.CallContext ctx, String oldSessionId) Methods inherited from class org.pac4j.core.client.IndirectClient
afterInternalInit, beforeInternalInit, checkCredentials, computeFinalCallbackUrl, getAjaxRequestResolver, getCallbackUrl, getCallbackUrlResolver, getCodeVerifierSessionAttributeName, getLogoutAction, getLogoutActionBuilder, getLogoutProcessor, getNonceSessionAttributeName, getRedirectionAction, getRedirectionActionBuilder, getStateSessionAttributeName, getUrlResolver, isCheckAuthenticationAttempt, newDefaultCallbackUrlResolver, processLogout, setAjaxRequestResolver, setCallbackUrl, setCallbackUrlResolver, setCheckAuthenticationAttempt, setLogoutActionBuilder, setLogoutActionBuilderIfUndefined, setLogoutProcessor, setLogoutProcessorIfUndefined, setRedirectionActionBuilder, setRedirectionActionBuilderIfUndefined, setUrlResolver, toString
Methods inherited from class org.pac4j.core.client.BaseClient
addAuthorizationGenerator, addAuthorizationGenerators, findSessionLogoutHandler, getAuthenticator, getAuthorizationGenerators, getConfig, getCredentials, getCredentialsExtractor, getCustomProperties, getLogger, getName, getProfileCreator, getProfileFactoryWhenNotAuthenticated, getSaveProfileInSession, getSaveProfileInSession, getUserProfile, internalValidateCredentials, isMultiProfile, isMultiProfile, renewUserProfile, setAuthenticator, setAuthenticatorIfUndefined, setAuthorizationGenerator, setAuthorizationGenerators, setAuthorizationGenerators, setConfig, setCredentialsExtractor, setCredentialsExtractorIfUndefined, setCustomProperties, setMultiProfile, setName, setProfileCreator, setProfileCreatorIfUndefined, setProfileFactoryWhenNotAuthenticated, setSaveProfileInSession, validateCredentials
Methods inherited from class org.pac4j.core.util.InitializableObject
getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize
-
Field Details
-
contextProvider
-
signatureSigningParametersProvider
-
authnResponseValidator
-
logoutValidator
-
signatureTrustEngineProvider
-
identityProviderMetadataResolver
-
serviceProviderMetadataResolver
-
decrypter
protected org.opensaml.saml.saml2.encryption.Decrypter decrypter -
configuration
-
stateGenerator
protected org.pac4j.core.util.generator.ValueGenerator stateGenerator -
replayCache
-
soapPipelineProvider
-
-
Constructor Details
-
SAML2Client
public SAML2Client()Constructor for SAML2Client.
-
SAML2Client
Constructor for SAML2Client.
- Parameters:
configuration
- aSAML2Configuration
object
-
-
Method Details
-
internalInit
protected void internalInit(boolean forceReinit) - Specified by:
internalInit
in classorg.pac4j.core.util.InitializableObject
-
initSOAPPipelineProvider
protected void initSOAPPipelineProvider()initSOAPPipelineProvider.
-
getLogoutRequestMessageSender
getLogoutRequestMessageSender.
- Returns:
- a
SAML2LogoutRequestMessageSender
object
-
getSSOMessageSender
getSSOMessageSender.
- Returns:
- a
SAML2WebSSOMessageSender
object
-
initSAMLLogoutResponseValidator
protected void initSAMLLogoutResponseValidator()initSAMLLogoutResponseValidator.
-
initSAMLResponseValidator
protected void initSAMLResponseValidator()initSAMLResponseValidator.
-
initSignatureTrustEngineProvider
protected void initSignatureTrustEngineProvider()initSignatureTrustEngineProvider.
-
initSAMLContextProvider
protected void initSAMLContextProvider()initSAMLContextProvider.
-
initServiceProviderMetadataResolver
protected void initServiceProviderMetadataResolver()initServiceProviderMetadataResolver.
-
initIdentityProviderMetadataResolver
protected void initIdentityProviderMetadataResolver()initIdentityProviderMetadataResolver.
-
initDecrypter
protected void initDecrypter()initDecrypter.
-
initSignatureSigningParametersProvider
protected void initSignatureSigningParametersProvider()initSignatureSigningParametersProvider.
-
initSAMLReplayCache
protected void initSAMLReplayCache()initSAMLReplayCache.
-
destroy
public void destroy()destroy.
-
notifySessionRenewal
- Overrides:
notifySessionRenewal
in classorg.pac4j.core.client.BaseClient
-
getIdentityProviderResolvedEntityId
getIdentityProviderResolvedEntityId.
- Returns:
- a
String
object
-
getServiceProviderResolvedEntityId
getServiceProviderResolvedEntityId.
- Returns:
- a
String
object
-