Package org.apereo.cas.authentication.principal

Class DefaultPrincipalElectionStrategy

  • All Implemented Interfaces:
    java.io.Serializable, org.apereo.cas.authentication.PrincipalElectionStrategy, org.springframework.core.Ordered
    public class DefaultPrincipalElectionStrategy
extends java.lang.Object
implements org.apereo.cas.authentication.PrincipalElectionStrategy
    This is DefaultPrincipalElectionStrategy that selects the primary principal to be the first principal in the chain of authentication history.
    Since:
    4.2.0
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from interface org.springframework.core.Ordered

        HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

      • Fields inherited from interface org.apereo.cas.authentication.PrincipalElectionStrategy

        BEAN_NAME

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> getPrincipalAttributesForPrincipal​(org.apereo.cas.authentication.principal.Principal principal, java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> principalAttributes)
      Gets principal attributes for principal.
      protected org.apereo.cas.authentication.principal.Principal getPrincipalFromAuthentication​(java.util.Collection<org.apereo.cas.authentication.Authentication> authentications)
      Gets principal from authentication.
      org.apereo.cas.authentication.principal.Principal nominate​(java.util.Collection<org.apereo.cas.authentication.Authentication> authentications, java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> principalAttributes)  
      org.apereo.cas.authentication.principal.Principal nominate​(java.util.List<org.apereo.cas.authentication.principal.Principal> principals, java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> attributes)  

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.apereo.cas.authentication.PrincipalElectionStrategy

        getAttributeMerger, getOrder

    • Constructor Detail

      • DefaultPrincipalElectionStrategy

        public DefaultPrincipalElectionStrategy()

      • DefaultPrincipalElectionStrategy

        public DefaultPrincipalElectionStrategy​(org.apereo.cas.authentication.PrincipalElectionStrategyConflictResolver principalElectionConflictResolver)

    • Method Detail

      • nominate

        public org.apereo.cas.authentication.principal.Principal nominate​(java.util.Collection<org.apereo.cas.authentication.Authentication> authentications,
                                                                  java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> principalAttributes)
        Specified by:
        nominate in interface org.apereo.cas.authentication.PrincipalElectionStrategy

      • nominate

        public org.apereo.cas.authentication.principal.Principal nominate​(java.util.List<org.apereo.cas.authentication.principal.Principal> principals,
                                                                  java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> attributes)
        Specified by:
        nominate in interface org.apereo.cas.authentication.PrincipalElectionStrategy

      • getPrincipalAttributesForPrincipal

        protected java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> getPrincipalAttributesForPrincipal​(org.apereo.cas.authentication.principal.Principal principal,
                                                                                                                    java.util.Map<java.lang.String,​java.util.List<java.lang.Object>> principalAttributes)
        Gets principal attributes for principal.
        Parameters:
        principal - the principal
        principalAttributes - the principal attributes
        Returns:
        the principal attributes for principal

      • getPrincipalFromAuthentication

        protected org.apereo.cas.authentication.principal.Principal getPrincipalFromAuthentication​(java.util.Collection<org.apereo.cas.authentication.Authentication> authentications)
        Gets principal from authentication.
        Parameters:
        authentications - the authentications
        Returns:
        the principal from authentication