com.atlassian.crowd.model.group

Class GroupWithMembershipChanges

java.lang.Object

com.atlassian.crowd.model.group.GroupWithMembershipChanges

All Implemented Interfaces:

DirectoryEntity, Group, Comparable<Group>

public class GroupWithMembershipChanges
extends Object
implements Group

Represents a new or modified group for incremental synchronisation. In addition to the group properties this class also contains identifiers of users and groups that have joined the underlying group or left it. This is particularly suitable for directories that provide a list of new and removed memberships for changed groups, for example Azure Active Directory.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GroupWithMembershipChanges.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GroupWithMembershipChanges(ImmutableGroup group, Iterable<String> userChildrenIdsToAdd, Iterable<String> userChildrenIdsToDelete, Iterable<String> groupChildrenIdsToAdd, Iterable<String> groupChildrenIdsToDelete)

Method Summary

Modifier and Type	Method and Description
static GroupWithMembershipChanges.Builder	builder()
static GroupWithMembershipChanges.Builder	builder(Group group)
static GroupWithMembershipChanges.Builder	builder(GroupWithMembershipChanges data)
int	compareTo(Group other)
boolean	equals(Object o) Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().
String	getDescription()
long	getDirectoryId()
String	getExternalId() This will return null for directories which do not support external ids
ImmutableGroup	getGroup()
Set<String>	getGroupChildrenIdsToAdd()
Set<String>	getGroupChildrenIdsToDelete()
String	getName()
GroupType	getType()
Set<String>	getUserChildrenIdsToAdd()
Set<String>	getUserChildrenIdsToDelete()
int	hashCode() Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().
boolean	isActive()
GroupWithMembershipChanges	merge(GroupWithMembershipChanges other)
GroupWithMembershipChanges.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupWithMembershipChanges

protected GroupWithMembershipChanges(ImmutableGroup group,
                                     Iterable<String> userChildrenIdsToAdd,
                                     Iterable<String> userChildrenIdsToDelete,
                                     Iterable<String> groupChildrenIdsToAdd,
                                     Iterable<String> groupChildrenIdsToDelete)

Method Detail

compareTo

public int compareTo(@Nonnull
                     Group other)

Specified by:

compareTo in interface Comparable<Group>

getDirectoryId

public long getDirectoryId()

Specified by:

getDirectoryId in interface DirectoryEntity

Returns:

id of the directory in which the DirectoryEntity is stored.

getName

public String getName()

Specified by:

getName in interface DirectoryEntity

Returns:

name of the entity.

getType

public GroupType getType()

Specified by:

getType in interface Group

Returns:

the type of the group.

isActive

public boolean isActive()

Specified by:

isActive in interface Group

Returns:

true if and only if the user is allowed to authenticate.

getDescription

public String getDescription()

Specified by:

getDescription in interface Group

Returns:

description of the group or null if there is no description.

getExternalId

@Nullable
public String getExternalId()

Description copied from interface: Group

This will return null for directories which do not support external ids

Specified by:

getExternalId in interface Group

Returns:

external id of the group or null it there is no external id

merge

public GroupWithMembershipChanges merge(GroupWithMembershipChanges other)

toBuilder

public GroupWithMembershipChanges.Builder toBuilder()

builder

public static GroupWithMembershipChanges.Builder builder(Group group)

getGroup

public ImmutableGroup getGroup()

getUserChildrenIdsToAdd

public Set<String> getUserChildrenIdsToAdd()

getUserChildrenIdsToDelete

public Set<String> getUserChildrenIdsToDelete()

getGroupChildrenIdsToAdd

public Set<String> getGroupChildrenIdsToAdd()

getGroupChildrenIdsToDelete

public Set<String> getGroupChildrenIdsToDelete()

builder

public static GroupWithMembershipChanges.Builder builder()

builder

public static GroupWithMembershipChanges.Builder builder(GroupWithMembershipChanges data)

equals

public boolean equals(Object o)

Description copied from interface: DirectoryEntity

Implementations must ensure equality based on getDirectoryId() and case-insensitive getName().

Specified by:

equals in interface DirectoryEntity

Overrides:

equals in class Object

Parameters:

o - object to compare to.

Returns:

true if and only if the directoryId and the lowercase names of the directory entities match.

hashCode

public int hashCode()

Description copied from interface: DirectoryEntity

Implementations must produce a hashcode based on getDirectoryId() and case-insensitive getName().

Specified by:

hashCode in interface DirectoryEntity

Overrides:

hashCode in class Object

Returns:

hashcode.

toString

public String toString()

Overrides:

toString in class Object