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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionPath to attribute mutator groovy script that allows one to modify wsfed attributes before establishing a final principal.Indicates how attributes should be recorded into the principal object.Whether CAS should auto redirect to this wsfed instance.Signing/encryption settings related to managing the cookie that is used to keep track of the session.The path to the public key/certificate used to handle and verify encrypted assertions.The path to the private key used to handle and verify encrypted assertions.The private key password.getId()
Internal identifier for this wsfed configuration.The attribute extracted from the assertion and used to construct the CAS principal id.The entity id or the identifier of the Wsfed instance.Wsfed identity provider url.getName()
Name of the authentication handler.int
getOrder()
The order of the authentication handler in the chain.Principal resolution settings.The identifier for CAS (RP) registered with wsfed.Locations of signing certificates used to verify assertions.Tolerance value used to skew assertions to support clock drift.boolean
Whether CAS should enable its own attribute resolution machinery after having received a response from wsfed.setAttributeMutatorScript
(GroovyWsFederationDelegationProperties attributeMutatorScript) Path to attribute mutator groovy script that allows one to modify wsfed attributes before establishing a final principal.setAttributeResolverEnabled
(boolean attributeResolverEnabled) Whether CAS should enable its own attribute resolution machinery after having received a response from wsfed.setAttributesType
(String attributesType) Indicates how attributes should be recorded into the principal object.setAutoRedirectType
(DelegationAutoRedirectTypes autoRedirectType) Whether CAS should auto redirect to this wsfed instance.Signing/encryption settings related to managing the cookie that is used to keep track of the session.setEncryptionCertificate
(String encryptionCertificate) The path to the public key/certificate used to handle and verify encrypted assertions.setEncryptionPrivateKey
(String encryptionPrivateKey) The path to the private key used to handle and verify encrypted assertions.setEncryptionPrivateKeyPassword
(String encryptionPrivateKeyPassword) The private key password.Internal identifier for this wsfed configuration.setIdentityAttribute
(String identityAttribute) The attribute extracted from the assertion and used to construct the CAS principal id.setIdentityProviderIdentifier
(String identityProviderIdentifier) The entity id or the identifier of the Wsfed instance.setIdentityProviderUrl
(String identityProviderUrl) Wsfed identity provider url.Name of the authentication handler.setOrder
(int order) The order of the authentication handler in the chain.Principal resolution settings.setRelyingPartyIdentifier
(String relyingPartyIdentifier) The identifier for CAS (RP) registered with wsfed.setSigningCertificateResources
(String signingCertificateResources) Locations of signing certificates used to verify assertions.setTolerance
(String tolerance) Tolerance value used to skew assertions to support clock drift.
-
Constructor Details
-
WsFederationDelegationProperties
public WsFederationDelegationProperties()
-
-
Method Details
-
getIdentityAttribute
The attribute extracted from the assertion and used to construct the CAS principal id. -
getIdentityProviderIdentifier
The entity id or the identifier of the Wsfed instance. -
getIdentityProviderUrl
Wsfed identity provider url. -
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 theIDPSSODescriptor
's key descriptor that is marked for signing. -
getRelyingPartyIdentifier
The identifier for CAS (RP) registered with wsfed. -
getTolerance
Tolerance value used to skew assertions to support clock drift. -
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 areCAS,WSFED,BOTH
. -
isAttributeResolverEnabled
public boolean isAttributeResolverEnabled()Whether CAS should enable its own attribute resolution machinery after having received a response from wsfed. -
getAutoRedirectType
Whether CAS should auto redirect to this wsfed instance. -
getEncryptionPrivateKey
The path to the private key used to handle and verify encrypted assertions. -
getEncryptionCertificate
The path to the public key/certificate used to handle and verify encrypted assertions. -
getEncryptionPrivateKeyPassword
The private key password. -
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
Principal resolution settings. -
getName
Name of the authentication handler. -
getOrder
public int getOrder()The order of the authentication handler in the chain. -
getAttributeMutatorScript
Path to attribute mutator groovy script that allows one to modify wsfed attributes before establishing a final principal. -
getCookie
Signing/encryption settings related to managing the cookie that is used to keep track of the session. -
setIdentityAttribute
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
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 theIDPSSODescriptor
's key descriptor that is marked for signing.- Returns:
this
.
-
setRelyingPartyIdentifier
The identifier for CAS (RP) registered with wsfed.- Returns:
this
.
-
setTolerance
Tolerance value used to skew assertions to support clock drift.- Returns:
this
.
-
setAttributesType
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 areCAS,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
The path to the private key used to handle and verify encrypted assertions.- Returns:
this
.
-
setEncryptionCertificate
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
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
Name of the authentication handler.- Returns:
this
.
-
setOrder
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
Signing/encryption settings related to managing the cookie that is used to keep track of the session.- Returns:
this
.
-