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
This is
GrouperPrincipalAttributesProperties
.- Since:
- 5.2.0
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetId()
A value can be assigned to this field to uniquely identify this resolver.int
getOrder()
The order of this attribute repository in the chain of repositories.Custom parameters defined as aMap
to pass onto the attribute repository which ultimately will be passed onto the grouper client.getState()
Whether attribute resolution based on this source is enabled.Indicate how the username passed to the attribute repository should be set and treated by the grouper client to look up records.The attribute name that would be used to look up and determine the user id from the query map.A value can be assigned to this field to uniquely identify this resolver.setOrder
(int order) The order of this attribute repository in the chain of repositories.setParameters
(Map<String, String> parameters) Custom parameters defined as aMap
to pass onto the attribute repository which ultimately will be passed onto the grouper client.Whether attribute resolution based on this source is enabled.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.setUsernameAttribute
(String usernameAttribute) The attribute name that would be used to look up and determine the user id from the query map.
-
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
Whether attribute resolution based on this source is enabled. -
getId
A value can be assigned to this field to uniquely identify this resolver. -
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
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
Custom parameters defined as aMap
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
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
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
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
Custom parameters defined as aMap
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
.
-