com.edorasware.one.identity.group

Class Group

java.lang.Object

com.edorasware.one.identity.group.Group

public class Group
extends Object

Represents a group.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Group.Builder Builder for Group class.

Method Summary

Modifier and Type	Method and Description
static Group.Builder	builder() Creates a builder for a new concrete Group instance.
static Group.Builder	builder(Group groupTemplate) Creates a builder for a new concrete Group instance based on the given Group template.
boolean	equals(Object other)
static Group	from(String id, String tenantId, String accountId, String displayName) Creates a new Group instance from the given attributes.
static Group	from(String id, String externalId, String tenantId, String accountId, String displayName, GroupType type) Creates a new Group instance from the given attributes with the ability to set an external group id.
String	getAccountId() Returns the id of the account to which the group belongs.
String	getDisplayName() Returns the display name of the group.
String	getExternalId() Returns the external id of the group.
String	getId() Returns the id of the group.
String	getTenantId() Returns the id of the main tenant to which the group belongs.
GroupType	getType() Returns the type of the group.
Map<String,Object>	getVariables() Returns any optional additional variables attached to this group.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static Group.Builder builder()

Creates a builder for a new concrete Group instance.

Returns:

the builder

builder

public static Group.Builder builder(Group groupTemplate)

Creates a builder for a new concrete Group instance based on the given Group template.

Parameters:

groupTemplate - the group template.

Returns:

the builder based on the given template

getId

public String getId()

Returns the id of the group.

Returns:

the id of the group, never null

getExternalId

public String getExternalId()

Returns the external id of the group.

Returns:

the external id of the group, never null

getTenantId

public String getTenantId()

Returns the id of the main tenant to which the group belongs. Note that the <i>current</i> tenant id might be different from the tenant id returned by this method.

Returns:

the id of the group’s main tenant, never null

getAccountId

public String getAccountId()

Returns the id of the account to which the group belongs.

Returns:

the id of the group’s account, never null

getDisplayName

public String getDisplayName()

Returns the display name of the group.

Returns:

the display name of the group, never null

getType

public GroupType getType()

Returns the type of the group.

Returns:

the type of the group, never null

getVariables

public Map<String,Object> getVariables()

Returns any optional additional variables attached to this group.

Returns:

any optional values of this group, might be null or empty

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

from

public static Group from(String id,
                         String tenantId,
                         String accountId,
                         String displayName)

Creates a new Group instance from the given attributes. The type of the group is per default the GroupType.CUSTOM group type.

Parameters:

id - the id of the group

tenantId - the main tenant of the group

accountId - the account to which the group belongs

displayName - the display name of the group

Returns:

the new instance

from

public static Group from(String id,
                         String externalId,
                         String tenantId,
                         String accountId,
                         String displayName,
                         GroupType type)

Creates a new Group instance from the given attributes with the ability to set an external group id.

Parameters:

id - the id of the group

externalId - the external id of the group

tenantId - the main tenant of the group

accountId - the account to which the group belongs

displayName - the display name of the group

type - the type of the group

Returns:

the new instance