Package org.apereo.cas.configuration.model.support.wsfed

Class WsFederationDelegationProperties

java.lang.Object
org.apereo.cas.configuration.model.support.wsfed.WsFederationDelegationProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-support-wsfederation-webflow") public class WsFederationDelegationProperties extends Object implements Serializable
This is WsFederationDelegationProperties.
Since:
5.0.0
See Also:

  • Constructor Details

    • WsFederationDelegationProperties

      public WsFederationDelegationProperties()

  • Method Details

    • getIdentityAttribute

      public String getIdentityAttribute()
      The attribute extracted from the assertion and used to construct the CAS principal id.

    • getIdentityProviderIdentifier

      public String getIdentityProviderIdentifier()
      The entity id or the identifier of the Wsfed instance.

    • getIdentityProviderUrl

      public String getIdentityProviderUrl()
      Wsfed identity provider url.

    • getSigningCertificateResources

      public String getSigningCertificateResources()
      Locations of signing certificates used to verify assertions. Locations could be specified as static file-system resources(certificates) or they could also be federation XML metadata, either as a URL or an XML file. If federation metadata XML is provided, the signing certificate is extracted from the IDPSSODescriptor's key descriptor that is marked for signing.

    • getRelyingPartyIdentifier

      public String getRelyingPartyIdentifier()
      The identifier for CAS (RP) registered with wsfed.

    • getTolerance

      public String getTolerance()
      Tolerance value used to skew assertions to support clock drift.

    • getAttributesType

      public String getAttributesType()
      Indicates how attributes should be recorded into the principal object. Useful if you wish to additionally resolve attributes on top of what wsfed provides. Accepted values are CAS,WSFED,BOTH.

    • isAttributeResolverEnabled

      public boolean isAttributeResolverEnabled()
      Whether CAS should enable its own attribute resolution machinery after having received a response from wsfed.

    • getAutoRedirectType

      public DelegationAutoRedirectTypes getAutoRedirectType()
      Whether CAS should auto redirect to this wsfed instance.

    • getEncryptionPrivateKey

      public String getEncryptionPrivateKey()
      The path to the private key used to handle and verify encrypted assertions.

    • getEncryptionCertificate

      public String getEncryptionCertificate()
      The path to the public key/certificate used to handle and verify encrypted assertions.

    • getEncryptionPrivateKeyPassword

      public String getEncryptionPrivateKeyPassword()
      The private key password.

    • getId

      public String getId()
      Internal identifier for this wsfed configuration. If undefined, the identifier would be auto-generated by CAS itself. In the event that there is more than on CAS server defined in a clustered deployment, this identifier must be statically defined in the configuration.

    • getPrincipal

      public PersonDirectoryPrincipalResolverProperties getPrincipal()
      Principal resolution settings.

    • getName

      public String getName()
      Name of the authentication handler.

    • getOrder

      public int getOrder()
      The order of the authentication handler in the chain.

    • getAttributeMutatorScript

      public GroovyWsFederationDelegationProperties getAttributeMutatorScript()
      Path to attribute mutator groovy script that allows one to modify wsfed attributes before establishing a final principal.

    • getCookie

      public WsFederationDelegatedCookieProperties getCookie()
      Signing/encryption settings related to managing the cookie that is used to keep track of the session.

    • setIdentityAttribute

      public WsFederationDelegationProperties setIdentityAttribute(String identityAttribute)
      The attribute extracted from the assertion and used to construct the CAS principal id.
      Returns:
      this.

    • setIdentityProviderIdentifier

      public WsFederationDelegationProperties setIdentityProviderIdentifier(String identityProviderIdentifier)
      The entity id or the identifier of the Wsfed instance.
      Returns:
      this.

    • setIdentityProviderUrl

      public WsFederationDelegationProperties setIdentityProviderUrl(String identityProviderUrl)
      Wsfed identity provider url.
      Returns:
      this.

    • setSigningCertificateResources

      public WsFederationDelegationProperties setSigningCertificateResources(String signingCertificateResources)
      Locations of signing certificates used to verify assertions. Locations could be specified as static file-system resources(certificates) or they could also be federation XML metadata, either as a URL or an XML file. If federation metadata XML is provided, the signing certificate is extracted from the IDPSSODescriptor's key descriptor that is marked for signing.
      Returns:
      this.

    • setRelyingPartyIdentifier

      public WsFederationDelegationProperties setRelyingPartyIdentifier(String relyingPartyIdentifier)
      The identifier for CAS (RP) registered with wsfed.
      Returns:
      this.

    • setTolerance

      public WsFederationDelegationProperties setTolerance(String tolerance)
      Tolerance value used to skew assertions to support clock drift.
      Returns:
      this.

    • setAttributesType

      public WsFederationDelegationProperties setAttributesType(String attributesType)
      Indicates how attributes should be recorded into the principal object. Useful if you wish to additionally resolve attributes on top of what wsfed provides. Accepted values are CAS,WSFED,BOTH.
      Returns:
      this.

    • setAttributeResolverEnabled

      public WsFederationDelegationProperties setAttributeResolverEnabled(boolean attributeResolverEnabled)
      Whether CAS should enable its own attribute resolution machinery after having received a response from wsfed.
      Returns:
      this.

    • setAutoRedirectType

      public WsFederationDelegationProperties setAutoRedirectType(DelegationAutoRedirectTypes autoRedirectType)
      Whether CAS should auto redirect to this wsfed instance.
      Returns:
      this.

    • setEncryptionPrivateKey

      public WsFederationDelegationProperties setEncryptionPrivateKey(String encryptionPrivateKey)
      The path to the private key used to handle and verify encrypted assertions.
      Returns:
      this.

    • setEncryptionCertificate

      public WsFederationDelegationProperties setEncryptionCertificate(String encryptionCertificate)
      The path to the public key/certificate used to handle and verify encrypted assertions.
      Returns:
      this.

    • setEncryptionPrivateKeyPassword

      public WsFederationDelegationProperties setEncryptionPrivateKeyPassword(String encryptionPrivateKeyPassword)
      The private key password.
      Returns:
      this.

    • setId

      public WsFederationDelegationProperties setId(String id)
      Internal identifier for this wsfed configuration. If undefined, the identifier would be auto-generated by CAS itself. In the event that there is more than on CAS server defined in a clustered deployment, this identifier must be statically defined in the configuration.
      Returns:
      this.

    • setPrincipal

      public WsFederationDelegationProperties setPrincipal(PersonDirectoryPrincipalResolverProperties principal)
      Principal resolution settings.
      Returns:
      this.

    • setName

      public WsFederationDelegationProperties setName(String name)
      Name of the authentication handler.
      Returns:
      this.

    • setOrder

      public WsFederationDelegationProperties setOrder(int order)
      The order of the authentication handler in the chain.
      Returns:
      this.

    • setAttributeMutatorScript

      public WsFederationDelegationProperties setAttributeMutatorScript(GroovyWsFederationDelegationProperties attributeMutatorScript)
      Path to attribute mutator groovy script that allows one to modify wsfed attributes before establishing a final principal.
      Returns:
      this.

    • setCookie

      public WsFederationDelegationProperties setCookie(WsFederationDelegatedCookieProperties cookie)
      Signing/encryption settings related to managing the cookie that is used to keep track of the session.
      Returns:
      this.