Package org.pac4j.saml.config

Class SAML2Configuration

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.client.config.BaseClientConfiguration

org.pac4j.saml.config.SAML2Configuration

public class SAML2Configuration
extends org.pac4j.core.client.config.BaseClientConfiguration

The class is responsible for capturing client settings and passing them around.

Since:

1.7

Author:

Misagh Moayyed, Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CLASSPATH_PREFIX
protected static final String	DEFAULT_PROVIDER_NAME
protected static final String	FILE_PREFIX
protected static final String	RESOURCE_PREFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
	SAML2Configuration()
	SAML2Configuration(String keystorePath, String keystorePassword, String privateKeyPassword, String identityProviderMetadataPath)
protected	SAML2Configuration(String keyStoreAlias, String keyStoreType, org.springframework.core.io.Resource keystoreResource, String keystorePassword, String privateKeyPassword, org.springframework.core.io.Resource identityProviderMetadataResource, String identityProviderEntityId, String serviceProviderEntityId, String providerName, Supplier<List<org.opensaml.core.xml.schema.XSAny>> authnRequestExtensions, String attributeAsId)
	SAML2Configuration(org.springframework.core.io.Resource keystoreResource, String keyStoreAlias, String keyStoreType, String keystorePassword, String privateKeyPassword, org.springframework.core.io.Resource identityProviderMetadataResource)
	SAML2Configuration(org.springframework.core.io.Resource keystoreResource, String keystorePassword, String privateKeyPassword, org.springframework.core.io.Resource identityProviderMetadataResource)

Method Summary

Modifier and Type	Method	Description
protected void	determineSingleSignOutServiceUrl(BaseSAML2MetadataGenerator generator)
org.pac4j.core.logout.handler.LogoutHandler	findLogoutHandler()
String	getCertificateNameToAppend()
CredentialProvider	getCredentialProvider()
org.apache.http.client.HttpClient	getHttpClient()
SAML2MetadataResolver	getIdentityProviderMetadataResolver()
SAML2KeystoreGenerator	getKeystoreGenerator()
SAML2MetadataGenerator	getMetadataGenerator()
protected void	internalInit(boolean forceReinit)
protected static org.springframework.core.io.UrlResource	newUrlResource(String url)
void	setCallbackUrl(String callbackUrl)
void	setCertificateNameToAppend(String certificateNameToAppend)
void	setIdentityProviderMetadataPath(String path)
void	setIdentityProviderMetadataResourceClasspath(String path)
void	setIdentityProviderMetadataResourceFilepath(String path)
void	setIdentityProviderMetadataResourceUrl(String url)
void	setKeystorePath(String path)
void	setKeystoreResourceClasspath(String path)
void	setKeystoreResourceFilepath(String path)
void	setKeystoreResourceUrl(String url)
void	setPrivateKeyPassword(String privateKeyPassword)
void	setServiceProviderMetadataPath(String path)
void	setServiceProviderMetadataResourceFilepath(String path)
SAML2MetadataGenerator	toMetadataGenerator()

Methods inherited from class org.pac4j.core.util.InitializableObject

afterInternalInit, beforeInternalInit, getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

RESOURCE_PREFIX

protected static final String RESOURCE_PREFIX

See Also:

• Constant Field Values

CLASSPATH_PREFIX

protected static final String CLASSPATH_PREFIX

See Also:

• Constant Field Values

FILE_PREFIX

protected static final String FILE_PREFIX

See Also:

• Constant Field Values

DEFAULT_PROVIDER_NAME

protected static final String DEFAULT_PROVIDER_NAME

See Also:

• Constant Field Values

Constructor Details

SAML2Configuration

public SAML2Configuration()

SAML2Configuration

public SAML2Configuration(String keystorePath,
 String keystorePassword,
 String privateKeyPassword,
 String identityProviderMetadataPath)

SAML2Configuration

public SAML2Configuration(org.springframework.core.io.Resource keystoreResource,
 String keystorePassword,
 String privateKeyPassword,
 org.springframework.core.io.Resource identityProviderMetadataResource)

SAML2Configuration

public SAML2Configuration(org.springframework.core.io.Resource keystoreResource,
 String keyStoreAlias,
 String keyStoreType,
 String keystorePassword,
 String privateKeyPassword,
 org.springframework.core.io.Resource identityProviderMetadataResource)

SAML2Configuration

protected SAML2Configuration(String keyStoreAlias,
 String keyStoreType,
 org.springframework.core.io.Resource keystoreResource,
 String keystorePassword,
 String privateKeyPassword,
 org.springframework.core.io.Resource identityProviderMetadataResource,
 String identityProviderEntityId,
 String serviceProviderEntityId,
 String providerName,
 Supplier<List<org.opensaml.core.xml.schema.XSAny>> authnRequestExtensions,
 String attributeAsId)

Method Details

newUrlResource

protected static org.springframework.core.io.UrlResource newUrlResource(String url)

setCallbackUrl

public void setCallbackUrl(String callbackUrl)

internalInit

protected void internalInit(boolean forceReinit)

Specified by:

internalInit in class org.pac4j.core.util.InitializableObject

getKeystoreGenerator

public SAML2KeystoreGenerator getKeystoreGenerator()

setIdentityProviderMetadataResourceFilepath

public void setIdentityProviderMetadataResourceFilepath(String path)

setIdentityProviderMetadataResourceClasspath

public void setIdentityProviderMetadataResourceClasspath(String path)

setIdentityProviderMetadataResourceUrl

public void setIdentityProviderMetadataResourceUrl(String url)

setIdentityProviderMetadataPath

public void setIdentityProviderMetadataPath(String path)

setKeystoreResourceFilepath

public void setKeystoreResourceFilepath(String path)

setKeystoreResourceClasspath

public void setKeystoreResourceClasspath(String path)

setKeystoreResourceUrl

public void setKeystoreResourceUrl(String url)

setKeystorePath

public void setKeystorePath(String path)

setPrivateKeyPassword

public void setPrivateKeyPassword(String privateKeyPassword)

getCertificateNameToAppend

public String getCertificateNameToAppend()

setCertificateNameToAppend

public void setCertificateNameToAppend(String certificateNameToAppend)

setServiceProviderMetadataResourceFilepath

public void setServiceProviderMetadataResourceFilepath(String path)

setServiceProviderMetadataPath

public void setServiceProviderMetadataPath(String path)

findLogoutHandler

public org.pac4j.core.logout.handler.LogoutHandler findLogoutHandler()

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

getCredentialProvider

public CredentialProvider getCredentialProvider()

toMetadataGenerator

public SAML2MetadataGenerator toMetadataGenerator()

determineSingleSignOutServiceUrl

protected void determineSingleSignOutServiceUrl(BaseSAML2MetadataGenerator generator)

getMetadataGenerator

public SAML2MetadataGenerator getMetadataGenerator()

getIdentityProviderMetadataResolver

public SAML2MetadataResolver getIdentityProviderMetadataResolver()