org.wso2.charon3.core.objects

Class Role

java.lang.Object

org.wso2.charon3.core.objects.ScimAttributeAware

org.wso2.charon3.core.objects.AbstractSCIMObject

org.wso2.charon3.core.objects.Role

All Implemented Interfaces:

Serializable, SCIMObject

public class Role
extends AbstractSCIMObject

Represents the Role object which is a collection of attributes defined by SCIM Role schema.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.wso2.charon3.core.objects.AbstractSCIMObject

attributeList, schemaList

Constructor Summary

Constructors

Constructor and Description
Role()

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Get the display name of the role.
List<String>	getGroups() Get the groups of the role.
List<String>	getGroupsWithDisplayName() Get the groups of the role with their display names.
List<String>	getPermissions() Get the permissions of SCIM role object.
List<String>	getUsers() Get the users of the role.
List<String>	getUsersWithDisplayName() Get the users of the role with their display names.
void	replaceDisplayName(String displayName) Deletes the current value of display name and rename it with the given value.
void	setDisplayName(String displayName) Set the display name of the role.
void	setGroup(Group group) Set a group to the role, where user will have three default attributes such as name, value and $ref.
void	setPermissions(List<String> permissions) Set the permissions for SCIM role object.
void	setSchemas() Set the schemas for SCIM role object.
void	setSystemRole(boolean isSystemRole) Set the systemRole attribute of the meta attribute.
void	setUser(User user) Set a user to the role, where user will have three default attributes such as name, value and $ref.

Methods inherited from class org.wso2.charon3.core.objects.AbstractSCIMObject

createMetaAttribute, deleteAttribute, deleteSubAttribute, deleteSubSubAttribute, deleteSubValuesSubAttribute, deleteValuesSubAttribute, getAttribute, getAttributeList, getCreatedDate, getLastModified, getMetaAttribute, getResource, getSchemaList, isAttributeExist, isMetaAttributeExist, isSchemaExists, setAttribute, setAttribute, setCreatedDate, setCreatedInstant, setExternalId, setId, setLastModified, setLastModifiedInstant, setLocation, setResourceType, setSchema, toString

Methods inherited from class org.wso2.charon3.core.objects.ScimAttributeAware

addMultivaluedComplexAtribute, attributeMetaEquals, attributesEquals, complexAttributeEquals, equals, getComplexAttribute, getCreatedDateTime, getCreatedInstant, getCreatedLong, getExternalId, getId, getLastModifiedDateTime, getLastModifiedInstant, getLastModifiedLong, getLocation, getMultiValuedAttribute, getMultivaluedComplexType, getOrCrateComplexAttribute, getResourceType, getSetSubAttributeConsumer, getSimpleAttribute, getSimpleAttribute, getSimpleAttributeValue, hashCode, isBlank, isNotBlank, multiValuedAttributeEquals, replaceCreated, replaceCreated, replaceCreated, replaceExternalId, replaceId, replaceLastModified, replaceLastModified, replaceLastModified, replaceLocation, replaceResourceType, replaceSimpleAttribute, simpleAttributeEquals, stripToNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Role

public Role()

Method Detail

getDisplayName

public String getDisplayName()

Get the display name of the role.

Returns:

Display name of the role.

setDisplayName

public void setDisplayName(String displayName)
                    throws CharonException,
                           BadRequestException

Set the display name of the role.

Parameters:

displayName - Display name.

Throws:

CharonException - CharonException.

BadRequestException - BadRequestException.

replaceDisplayName

public void replaceDisplayName(String displayName)

Deletes the current value of display name and rename it with the given value.

Parameters:

displayName - New display name.

getUsers

public List<String> getUsers()

Get the users of the role.

Returns:

List of users.

getUsersWithDisplayName

public List<String> getUsersWithDisplayName()

Get the users of the role with their display names.

Returns:

List of display names.

setUser

public void setUser(User user)
             throws BadRequestException,
                    CharonException

Set a user to the role, where user will have three default attributes such as name, value and $ref.

Parameters:

user - User object.

Throws:

BadRequestException - BadRequestException.

CharonException - CharonException.

getGroups

public List<String> getGroups()

Get the groups of the role.

Returns:

List of groups.

getGroupsWithDisplayName

public List<String> getGroupsWithDisplayName()

Get the groups of the role with their display names.

Returns:

List of display names.

setGroup

public void setGroup(Group group)
              throws BadRequestException,
                     CharonException

Set a group to the role, where user will have three default attributes such as name, value and $ref.

Parameters:

group - Group object.

Throws:

BadRequestException - BadRequestException.

CharonException - CharonException.

setSchemas

public void setSchemas()

Set the schemas for SCIM role object.

setPermissions

public void setPermissions(List<String> permissions)

Set the permissions for SCIM role object.

getPermissions

public List<String> getPermissions()

Get the permissions of SCIM role object.

setSystemRole

public void setSystemRole(boolean isSystemRole)
                   throws CharonException,
                          BadRequestException

Set the systemRole attribute of the meta attribute.

Parameters:

isSystemRole - Whether this is a read only system role.

Throws:

CharonException - CharonException.

BadRequestException - BadRequestException.