org.osiam.resources.scim

Class Group.Builder

java.lang.Object

org.osiam.resources.scim.Resource.Builder

org.osiam.resources.scim.Group.Builder

Enclosing class:

Group

public static class Group.Builder
extends Resource.Builder

Builder class that is used to build Group instances

Field Summary

Fields inherited from class org.osiam.resources.scim.Resource.Builder

externalId

Constructor Summary

Constructors

Constructor and Description
Group.Builder() creates a new Group without a displayName
Group.Builder(Group group) Constructs a new builder by copying all values from the given Group
Group.Builder(String displayName) Constructs a new builder and sets the display name (See Group.getDisplayName()).
Group.Builder(String displayName, Group group) creates a new Group.Builder based on the given displayName and group.

Method Summary

Methods

Modifier and Type	Method and Description
Group	build() Builds the Object of the Builder
Group.Builder	setExternalId(String externalId) Sets the external id (See Resource.getExternalId()).
Group.Builder	setId(String id) Sets the id of the resource.
Group.Builder	setMembers(Set<MemberRef> members) Sets the list of members as Set (See Group.getMembers()).
Group.Builder	setMeta(Meta meta) Sets the meta data client info: The meta information of a User will be created and set by the OSIAM server.
Group.Builder	setSchemas(Set<String> schemas) sets the schemas of the Resource

Methods inherited from class org.osiam.resources.scim.Resource.Builder

addSchema

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Group.Builder

public Group.Builder(String displayName,
             Group group)

creates a new Group.Builder based on the given displayName and group. All values of the given group will be copied expect the displayName will be be overridden by the given one

Parameters:

displayName - the new displayName of the group

group - a existing group

Group.Builder

public Group.Builder()

creates a new Group without a displayName

Group.Builder

public Group.Builder(Group group)

Constructs a new builder by copying all values from the given Group

Parameters:

group - Group to be copied from

Throws:

SCIMDataValidationException - if the given group is null

Group.Builder

public Group.Builder(String displayName)

Constructs a new builder and sets the display name (See Group.getDisplayName()).

Parameters:

displayName - the display name

Throws:

SCIMDataValidationException - if the displayName is null or empty

Method Detail

setId

public Group.Builder setId(String id)

Description copied from class: Resource.Builder

Sets the id of the resource.

client info: The id of a User will be created and set by the OSIAM server. If a User or Group which is send to the OSIAM server has this value filled, the value will be ignored or the action will be rejected.

Overrides:

setId in class Resource.Builder

Parameters:

id - if of the resource

Returns:

the builder itself

setMeta

public Group.Builder setMeta(Meta meta)

Description copied from class: Resource.Builder

Sets the meta data

client info: The meta information of a User will be created and set by the OSIAM server. If a User or Group which is send to the OSIAM server has this value filled, the value will be ignored or the action will be rejected. For an update(PATCH) the attribute value can be set by the client. In normal case this should be set by the UpdateUser or UpdateGroup and not by the client directly.

Overrides:

setMeta in class Resource.Builder

Parameters:

meta - the meta object

Returns:

the builder itself

setExternalId

public Group.Builder setExternalId(String externalId)

Description copied from class: Resource.Builder

Sets the external id (See Resource.getExternalId()).

Overrides:

setExternalId in class Resource.Builder

Parameters:

externalId - the external id

Returns:

the builder itself

setSchemas

public Group.Builder setSchemas(Set<String> schemas)

Description copied from class: Resource.Builder

sets the schemas of the Resource

Overrides:

setSchemas in class Resource.Builder

Parameters:

schemas - actual schemas

Returns:

the builder itself

setMembers

public Group.Builder setMembers(Set<MemberRef> members)

Sets the list of members as Set (See Group.getMembers()).

Parameters:

members - the set of members

Returns:

the builder itself

build

public Group build()

Description copied from class: Resource.Builder

Builds the Object of the Builder

Specified by:

build in class Resource.Builder

Returns:

a new main Object of the Builder