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 Details

    • DEFAULT_PROVIDER_NAME

      protected static final String DEFAULT_PROVIDER_NAME
      Constant DEFAULT_PROVIDER_NAME="pac4j-saml"
      See Also:

  • Constructor Details

    • SAML2Configuration

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

      Constructor for SAML2Configuration.

      Parameters:
      keystorePath - a String object
      keystorePassword - a String object
      privateKeyPassword - a String object
      identityProviderMetadataPath - a String object

    • SAML2Configuration

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

      Constructor for SAML2Configuration.

      Parameters:
      keystoreResource - a Resource object
      keystorePassword - a String object
      privateKeyPassword - a String object
      identityProviderMetadataResource - a Resource object

    • 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

    • setCallbackUrl

      public void setCallbackUrl(String callbackUrl)

      Setter for the field callbackUrl.

      Parameters:
      callbackUrl - a String object

    • internalInit

      protected void internalInit(boolean forceReinit)
      Specified by:
      internalInit in class org.pac4j.core.util.InitializableObject

    • getKeystoreGenerator

      @Deprecated public org.pac4j.core.keystore.generation.KeystoreGenerator getKeystoreGenerator()
      Deprecated.

    • setKeystoreGenerator

      @Deprecated public void setKeystoreGenerator(org.pac4j.core.keystore.generation.KeystoreGenerator keystoreGenerator)
      Deprecated.

    • setIdentityProviderMetadataResourceFilepath

      public void setIdentityProviderMetadataResourceFilepath(String path)

      setIdentityProviderMetadataResourceFilepath.

      Parameters:
      path - a String object

    • setIdentityProviderMetadataResourceClasspath

      public void setIdentityProviderMetadataResourceClasspath(String path)

      setIdentityProviderMetadataResourceClasspath.

      Parameters:
      path - a String object

    • setIdentityProviderMetadataResourceUrl

      public void setIdentityProviderMetadataResourceUrl(String url)

      setIdentityProviderMetadataResourceUrl.

      Parameters:
      url - a String object

    • setIdentityProviderMetadataPath

      public void setIdentityProviderMetadataPath(String path)

      setIdentityProviderMetadataPath.

      Parameters:
      path - a String object

    • setServiceProviderMetadataResourceFilepath

      public void setServiceProviderMetadataResourceFilepath(String path)

      setServiceProviderMetadataResourceFilepath.

      Parameters:
      path - a String object

    • setServiceProviderMetadataPath

      public void setServiceProviderMetadataPath(String path)

      setServiceProviderMetadataPath.

      Parameters:
      path - a String object

    • getKeystoreResource

      @Deprecated public org.springframework.core.io.Resource getKeystoreResource()
      Deprecated.
      use getKeystore().getKeystoreResource() instead of getKeystoreResource()

    • setKeystoreResource

      @Deprecated public void setKeystoreResource(org.springframework.core.io.Resource resource)
      Deprecated.
      use getKeystore().setKeystoreResource(resource) instead of setKeystoreResource(resource)

    • getKeystorePassword

      @Deprecated public String getKeystorePassword()
      Deprecated.
      use getKeystore().getKeystorePassword() instead of getKeystorePassword()

    • setKeystorePassword

      @Deprecated public void setKeystorePassword(String password)
      Deprecated.
      use getKeystore().setKeystorePassword(password) instead of setKeystorePassword(password)

    • getPrivateKeyPassword

      @Deprecated public String getPrivateKeyPassword()
      Deprecated.
      use getKeystore().getPrivateKeyPassword() instead of getPrivateKeyPassword()

    • setPrivateKeyPassword

      @Deprecated public void setPrivateKeyPassword(String password)
      Deprecated.
      use getKeystore().setPrivateKeyPassword(password) instead of setPrivateKeyPassword(password)

    • getKeyStoreAlias

      @Deprecated public String getKeyStoreAlias()
      Deprecated.
      use getKeystore().getKeyStoreAlias() instead of getKeyStoreAlias()

    • setKeyStoreAlias

      @Deprecated public void setKeyStoreAlias(String alias)
      Deprecated.
      use getKeystore().setKeyStoreAlias(alias) instead of setKeyStoreAlias(alias)

    • getKeyStoreType

      @Deprecated public String getKeyStoreType()
      Deprecated.
      use getKeystore().getKeyStoreType() instead of getKeyStoreType()

    • setKeyStoreType

      @Deprecated public void setKeyStoreType(String type)
      Deprecated.
      use getKeystore().setKeyStoreType(type) instead of setKeyStoreType(type)

    • isForceKeystoreGeneration

      @Deprecated public boolean isForceKeystoreGeneration()
      Deprecated.
      use getKeystore().isForceKeystoreGeneration() instead of isForceKeystoreGeneration()

    • setForceKeystoreGeneration

      @Deprecated public void setForceKeystoreGeneration(boolean force)
      Deprecated.
      use getKeystore().setForceKeystoreGeneration(force) instead of setForceKeystoreGeneration(force)

    • getCertificateNameToAppend

      @Deprecated public String getCertificateNameToAppend()
      Deprecated.
      use getKeystore().getCertificateNameToAppend() instead of getCertificateNameToAppend()

    • setCertificateNameToAppend

      @Deprecated public void setCertificateNameToAppend(String name)
      Deprecated.
      use getKeystore().setCertificateNameToAppend(name) instead of setCertificateNameToAppend(name)

    • getCertificateExpirationPeriod

      @Deprecated public Period getCertificateExpirationPeriod()
      Deprecated.
      use getKeystore().getCertificateExpirationPeriod() instead of getCertificateExpirationPeriod()

    • setCertificateExpirationPeriod

      @Deprecated public void setCertificateExpirationPeriod(Period period)
      Deprecated.
      use getKeystore().setCertificateExpirationPeriod(period) instead of setCertificateExpirationPeriod(period)

    • getCertificateSignatureAlg

      @Deprecated public String getCertificateSignatureAlg()
      Deprecated.
      use getKeystore().getCertificateSignatureAlg() instead of getCertificateSignatureAlg()

    • setCertificateSignatureAlg

      @Deprecated public void setCertificateSignatureAlg(String alg)
      Deprecated.
      use getKeystore().setCertificateSignatureAlg(alg) instead of setCertificateSignatureAlg(alg)

    • getPrivateKeySize

      @Deprecated public int getPrivateKeySize()
      Deprecated.
      use getKeystore().getPrivateKeySize() instead of getPrivateKeySize()

    • setPrivateKeySize

      @Deprecated public void setPrivateKeySize(int size)
      Deprecated.
      use getKeystore().setPrivateKeySize(size) instead of setPrivateKeySize(size)

    • setKeystoreResourceFilepath

      @Deprecated public void setKeystoreResourceFilepath(String path)
      Deprecated.
      use getKeystore().setKeystoreResourceFilepath(path) instead of setKeystoreResourceFilepath(path)

    • setKeystoreResourceClasspath

      @Deprecated public void setKeystoreResourceClasspath(String path)
      Deprecated.
      use getKeystore().setKeystoreResourceClasspath(path) instead of setKeystoreResourceClasspath(path)

    • setKeystoreResourceUrl

      @Deprecated public void setKeystoreResourceUrl(String url)
      Deprecated.
      use getKeystore().setKeystoreResourceUrl(url) instead of setKeystoreResourceUrl(url)

    • setKeystorePath

      @Deprecated public void setKeystorePath(String path)
      Deprecated.
      use getKeystore().setKeystorePath(path) instead of setKeystorePath(path)

    • getHttpClient

      public org.apache.hc.client5.http.classic.HttpClient getHttpClient()

      Getter for the field httpClient.

      Returns:
      a HttpClient object

    • getCredentialProvider

      public CredentialProvider getCredentialProvider()

      getCredentialProvider.

      Returns:
      a CredentialProvider object

    • toMetadataGenerator

      public SAML2MetadataGenerator toMetadataGenerator()

      toMetadataGenerator.

      Returns:
      a SAML2MetadataGenerator object

    • resolveAssertionConsumerServiceUrl

      public String resolveAssertionConsumerServiceUrl()

    • resolveRequestInitiatorLocation

      public String resolveRequestInitiatorLocation()

    • determineSingleSignOutServiceUrl

      protected void determineSingleSignOutServiceUrl(BaseSAML2MetadataGenerator generator)

      determineSingleSignOutServiceUrl.

      Parameters:
      generator - a BaseSAML2MetadataGenerator object

    • getMetadataGenerator

      public SAML2MetadataGenerator getMetadataGenerator()

      Getter for the field metadataGenerator.

      Returns:
      a SAML2MetadataGenerator object

    • getIdentityProviderMetadataResolver

      public SAML2MetadataResolver getIdentityProviderMetadataResolver()

      Getter for the field identityProviderMetadataResolver.

      Returns:
      a SAML2MetadataResolver object