Class GrouperPrincipalAttributesProperties

java.lang.Object
org.apereo.cas.configuration.model.core.authentication.GrouperPrincipalAttributesProperties
All Implemented Interfaces:
Serializable

@RequiresModule(name="cas-server-support-person-directory", automated=true) public class GrouperPrincipalAttributesProperties extends Object implements Serializable
Since:
5.2.0
See Also:
  • Constructor Details

    • GrouperPrincipalAttributesProperties

      public GrouperPrincipalAttributesProperties()
  • Method Details

    • getOrder

      public int getOrder()
      The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.
    • getState

      public AttributeRepositoryStates getState()
      Whether attribute resolution based on this source is enabled.
    • getId

      public String getId()
      A value can be assigned to this field to uniquely identify this resolver.
    • getSubjectType

      public String getSubjectType()
      Indicate how the username passed to the attribute repository should be set and treated by the grouper client to look up records.

      Accepted values are: SUBJECT_IDENTIFIER, SUBJECT_ATTRIBUTE_NAME, SUBJECT_ID.

    • getUsernameAttribute

      public String getUsernameAttribute()
      The attribute name that would be used to look up and determine the user id from the query map. The value linked to this attribute would be used as the username or subject by the attribute repository to pass on to the ultimate source to locate the user record.
    • getParameters

      public Map<String,String> getParameters()
      Custom parameters defined as a Map to pass onto the attribute repository which ultimately will be passed onto the grouper client. Key is the parameter name and value is the parameter value.
    • setOrder

      public GrouperPrincipalAttributesProperties setOrder(int order)
      The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.
      Returns:
      this.
    • setState

      Whether attribute resolution based on this source is enabled.
      Returns:
      this.
    • setId

      A value can be assigned to this field to uniquely identify this resolver.
      Returns:
      this.
    • setSubjectType

      public GrouperPrincipalAttributesProperties setSubjectType(String subjectType)
      Indicate how the username passed to the attribute repository should be set and treated by the grouper client to look up records.

      Accepted values are: SUBJECT_IDENTIFIER, SUBJECT_ATTRIBUTE_NAME, SUBJECT_ID.

      Returns:
      this.
    • setUsernameAttribute

      public GrouperPrincipalAttributesProperties setUsernameAttribute(String usernameAttribute)
      The attribute name that would be used to look up and determine the user id from the query map. The value linked to this attribute would be used as the username or subject by the attribute repository to pass on to the ultimate source to locate the user record.
      Returns:
      this.
    • setParameters

      public GrouperPrincipalAttributesProperties setParameters(Map<String,String> parameters)
      Custom parameters defined as a Map to pass onto the attribute repository which ultimately will be passed onto the grouper client. Key is the parameter name and value is the parameter value.
      Returns:
      this.