org.wso2.charon3.core.objects

Class Group

java.lang.Object

org.wso2.charon3.core.objects.ScimAttributeAware

org.wso2.charon3.core.objects.AbstractSCIMObject

org.wso2.charon3.core.objects.Group

All Implemented Interfaces:

Serializable, SCIMObject

public class Group
extends AbstractSCIMObject

Represents the Group object which is a collection of attributes defined by SCIM Group-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
Group()

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() get the display name of the group
List<String>	getMemberIdsOfType(String searchType) Returns the ID list of all members of specified type
List<Object>	getMembers() get the members of the group
List<String>	getMembersWithDisplayName() get the members of the group with their display names
List<String>	getSubGroupIds() Returns the ID list of all members of type Group
List<String>	getUserIds() Returns the ID list of all members of type User
void	replaceDisplayName(String displayname) deletes the current value of displayname and exchanges it with the given value
void	setDisplayName(String displayName) set the display name of the group
void	setMember(String value, String display) Deprecated. use setMember(User user) instead.
void	setMember(String value, String display, String ref, String type)
void	setMember(User user) Set a member to the group, where member will have three default attributes such as name, value and $ref.
void	setRole(Role role) Set the associated roles of the group.
void	setSchemas() set the schemas for scim object -group

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

Group

public Group()

Method Detail

getDisplayName

public String getDisplayName()

get the display name of the group

Returns:

Throws:

CharonException

setDisplayName

public void setDisplayName(String displayName)
                    throws CharonException,
                           BadRequestException

set the display name of the group

Parameters:

displayName -

Throws:

CharonException

BadRequestException

replaceDisplayName

public void replaceDisplayName(String displayname)

deletes the current value of displayname and exchanges it with the given value

getMembers

public List<Object> getMembers()

get the members of the group

Returns:

getMembersWithDisplayName

public List<String> getMembersWithDisplayName()

get the members of the group with their display names

Returns:

setMember

@Deprecated
public void setMember(String value,
                                  String display)
                           throws BadRequestException,
                                  CharonException

Deprecated. use setMember(User user) instead.

This method used to add member (user) to a group. According to the SCIM specification need to add ref attribute as well along with display and value. Hence deprecated this method.

Throws:

BadRequestException

CharonException

setMember

public void setMember(String value,
                      String display,
                      String ref,
                      String type)
               throws BadRequestException,
                      CharonException

Throws:

BadRequestException

CharonException

setMember

public void setMember(User user)
               throws BadRequestException,
                      CharonException

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

Parameters:

user -

Throws:

BadRequestException

CharonException

setSchemas

public void setSchemas()

set the schemas for scim object -group

getUserIds

public List<String> getUserIds()

Returns the ID list of all members of type User

getSubGroupIds

public List<String> getSubGroupIds()

Returns the ID list of all members of type Group

getMemberIdsOfType

public List<String> getMemberIdsOfType(String searchType)

Returns the ID list of all members of specified type

setRole

public void setRole(Role role)
             throws CharonException,
                    BadRequestException

Set the associated roles of the group.

Parameters:

role - Role object.

Throws:

CharonException - CharonException.

BadRequestException - BadRequestException.