Package org.apereo.cas.authentication

Class DefaultAuthenticationAttributeReleasePolicy

  • All Implemented Interfaces:
    org.apereo.cas.validation.AuthenticationAttributeReleasePolicy
    public class DefaultAuthenticationAttributeReleasePolicy
extends java.lang.Object
implements org.apereo.cas.validation.AuthenticationAttributeReleasePolicy
    Default AuthenticationAttributeReleasePolicy implementation.
    Since:
    5.2.0

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void decideAttributeReleaseBasedOnServiceAttributePolicy​(java.util.Map<java.lang.String,​java.lang.Object> attributes, java.lang.String attributeValue, java.lang.String attributeName, org.apereo.cas.services.RegisteredService service, boolean doesAttributePolicyAllow)
      Decide attribute release based on service attribute policy.
      protected void decideIfCredentialPasswordShouldBeReleasedAsAttribute​(java.util.Map<java.lang.String,​java.lang.Object> attributes, org.apereo.cas.authentication.Authentication authentication, org.apereo.cas.services.RegisteredService service)
      Decide if credential password should be released as attribute.
      protected void decideIfProxyGrantingTicketShouldBeReleasedAsAttribute​(java.util.Map<java.lang.String,​java.lang.Object> attributes, java.util.Map<java.lang.String,​java.lang.Object> model, org.apereo.cas.services.RegisteredService service)
      Decide if PGT should be released as attribute.
      java.util.Map<java.lang.String,​java.lang.Object> getAuthenticationAttributesForRelease​(org.apereo.cas.authentication.Authentication authentication, org.apereo.cas.validation.Assertion assertion, java.util.Map<java.lang.String,​java.lang.Object> model, org.apereo.cas.services.RegisteredService service)  
      protected boolean isAttributeAllowedForRelease​(java.lang.String attributeName)
      Is attribute allowed for release?

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • DefaultAuthenticationAttributeReleasePolicy

        public DefaultAuthenticationAttributeReleasePolicy​(java.lang.String authenticationContextAttribute)

    • Method Detail

      • getAuthenticationAttributesForRelease

        public java.util.Map<java.lang.String,​java.lang.Object> getAuthenticationAttributesForRelease​(org.apereo.cas.authentication.Authentication authentication,
                                                                                                    org.apereo.cas.validation.Assertion assertion,
                                                                                                    java.util.Map<java.lang.String,​java.lang.Object> model,
                                                                                                    org.apereo.cas.services.RegisteredService service)
        Specified by:
        getAuthenticationAttributesForRelease in interface org.apereo.cas.validation.AuthenticationAttributeReleasePolicy

      • isAttributeAllowedForRelease

        protected boolean isAttributeAllowedForRelease​(java.lang.String attributeName)
        Is attribute allowed for release?
        Parameters:
        attributeName - the attribute name
        Returns:
        the boolean

      • decideIfCredentialPasswordShouldBeReleasedAsAttribute

        protected void decideIfCredentialPasswordShouldBeReleasedAsAttribute​(java.util.Map<java.lang.String,​java.lang.Object> attributes,
                                                                     org.apereo.cas.authentication.Authentication authentication,
                                                                     org.apereo.cas.services.RegisteredService service)
        Decide if credential password should be released as attribute. The credential must have been cached as an authentication attribute and the attribute release policy must be allowed to release the attribute.
        Parameters:
        attributes - the attributes
        authentication - the authentication
        service - the service

      • decideIfProxyGrantingTicketShouldBeReleasedAsAttribute

        protected void decideIfProxyGrantingTicketShouldBeReleasedAsAttribute​(java.util.Map<java.lang.String,​java.lang.Object> attributes,
                                                                      java.util.Map<java.lang.String,​java.lang.Object> model,
                                                                      org.apereo.cas.services.RegisteredService service)
        Decide if PGT should be released as attribute. The PGT must have been cached as an authentication attribute and the attribute release policy must be allowed to release the attribute.
        Parameters:
        attributes - the attributes
        model - the model
        service - the service

      • decideAttributeReleaseBasedOnServiceAttributePolicy

        protected void decideAttributeReleaseBasedOnServiceAttributePolicy​(java.util.Map<java.lang.String,​java.lang.Object> attributes,
                                                                   java.lang.String attributeValue,
                                                                   java.lang.String attributeName,
                                                                   org.apereo.cas.services.RegisteredService service,
                                                                   boolean doesAttributePolicyAllow)
        Decide attribute release based on service attribute policy.
        Parameters:
        attributes - the attributes
        attributeValue - the attribute value
        attributeName - the attribute name
        service - the service
        doesAttributePolicyAllow - does attribute policy allow release of this attribute?