com.atlassian.user
Interface GroupManager

All Superinterfaces:

EntityManager

All Known Implementing Classes:

CachingGroupManager, DelegatingGroupManager, HibernateGroupManager, MemoryGroupManager, OSUGroupManager, ReadOnlyGroupManager

public interface GroupManager

extends EntityManager

A group manager is responsible for all CRUD operations on groups and group memberships in a given repository. Where an operation requires a Group as an argument, calling the method with a group from another repository will typically throw an IllegalArgumentException. The group manager is responsible for ensuring the consistency of the underlying repository where relevant. For example, if membership information needs to be updated as part of the removeGroup(Group) operation, the group manager is responsible for ensuring it happens. This interface is an extension of the EntityManager interface which is common to user and group management. The common functionality includes initialisation and access to the repository description.

Method Summary

void	addMembership(Group group, User user) Adds the user to the specified group.
Group	createGroup(java.lang.String groupName) Create a new group with the specified name.
Pager	getExternalMemberNames(Group group) Retrieves the names of those members of the specified group which are stored in another repository.
Group	getGroup(java.lang.String groupName) Retrieves the group with the given name.
Pager	getGroups() Retrieves all groups in this repository.
Pager	getGroups(User user) Retrieves the groups to which the given user belongs.
Pager	getLocalMemberNames(Group group) Retrieves the names of those members of the specified group which are also stored in this repository.
Pager	getMemberNames(Group group) Retrieves the names of all members of the specified group.
java.util.List	getWritableGroups() Gets all editable groups.
boolean	hasMembership(Group group, User user) Returns true if the user is a member of the specified group.
boolean	isReadOnly(Group group) Returns true if the specified group and membership of the specified group cannot be modified in the repository.
void	removeGroup(Group group) Remove the group specified, if it exists in this repository.
void	removeMembership(Group group, User user) Removes the user from the specified group.
boolean	supportsExternalMembership() Returns true if the repository supports users in other repositories being members of groups in this repository.

Methods inherited from interface com.atlassian.user.EntityManager

getIdentifier, getRepository, isCreative

Method Detail

getGroups

public Pager getGroups()
                throws EntityException

Retrieves all groups in this repository.

Returns:

a Pager containing a Group for each group managed by the repository. An empty pager will be returned if the repository does not contain any groups.

Throws:

EntityException

getGroups

public Pager getGroups(User user)
                throws EntityException

Retrieves the groups to which the given user belongs. Only groups which are managed by this repository are included.

Returns:

a Pager containing a Group for each group the user belongs to. An empty pager will be returned if the user does not belong to any groups that this manager knows about.

Throws:

java.lang.IllegalArgumentException - if the user provided is null

EntityException

getWritableGroups

public java.util.List getWritableGroups()

Gets all editable groups. That is, returns any groups that belong to read/write repositories. Groups in readonly repositories that are ReadOnly are not returned.

Returns:

list of Groups that can be edited.

getMemberNames

public Pager getMemberNames(Group group)
                     throws EntityException

Retrieves the names of all members of the specified group. The names are ordered by a Collator for the JVM's default locale (as returned by Collator.getInstance().

Returns:

a Pager containing a String with the name of each member of the group. An empty pager will be returned if the group has no members.

Throws:

EntityException

getLocalMemberNames

public Pager getLocalMemberNames(Group group)
                          throws EntityException

Retrieves the names of those members of the specified group which are also stored in this repository. The names are ordered by a Collator for the JVM's default locale (as returned by Collator.getInstance().

If supportsExternalMembership() returns false, this call is equivalent to getMemberNames(Group).

Returns:

a Pager containing a String with the name of each member of the group which is stored in the same repository. An empty pager will be returned if the group has no local members.

Throws:

EntityException

getExternalMemberNames

public Pager getExternalMemberNames(Group group)
                             throws EntityException

Retrieves the names of those members of the specified group which are stored in another repository. For example, an LDAP user which is a member of a Hibernate group is an external member of the Hibernate group.

The names are ordered by a Collator for the JVM's default locale (as returned by Collator.getInstance().

If supportsExternalMembership() returns false, this method throws UnsupportedOperationException.

Returns:

a Pager containing a String with the name of each member of the group which is stored in a different repository. An empty pager will be returned if the group has no external members.

Throws:

java.lang.UnsupportedOperationException - if supportsExternalMembership() returns false.

EntityException

getGroup

public Group getGroup(java.lang.String groupName)
               throws EntityException

Retrieves the group with the given name. Returns null if the group does not exist in this repository.

Returns:

a Group or null if the group does not exist.

Throws:

EntityException

createGroup

public Group createGroup(java.lang.String groupName)
                  throws EntityException

Create a new group with the specified name.

Throws:

DuplicateEntityException - if a group with the provided name already exists.

EntityException - if the Group could not be created.

java.lang.UnsupportedOperationException - if EntityManager.isCreative() returns false

removeGroup

public void removeGroup(Group group)
                 throws EntityException

Remove the group specified, if it exists in this repository. If the group does not belong to this repository, an IllegalArgumentException will be thrown. If required to maintain the consistency of the repository, the group manager should remove users from the group before removing the group itself.

Throws:

EntityException - if the Group could not be removed.

java.lang.UnsupportedOperationException - if isReadOnly(Group) returns true.

addMembership

public void addMembership(Group group,
                          User user)
                   throws EntityException,
                          java.lang.IllegalArgumentException

Adds the user to the specified group.

If the user is not in this repository, and supportsExternalMembership() returns true, the user will be added as an external user.

Throws:

java.lang.UnsupportedOperationException - if isReadOnly(Group) returns true.

java.lang.IllegalArgumentException - if the group is not handled by this group manager or the group is null.

EntityException

hasMembership

public boolean hasMembership(Group group,
                             User user)
                      throws EntityException

Returns true if the user is a member of the specified group.

If the user is not in this repository, and supportsExternalMembership() returns true, external members will be checked as well.

If the group is not handled by this manager, returns false.

Returns:

true if the user is a member of the specified group, otherwise false.

Throws:

EntityException

removeMembership

public void removeMembership(Group group,
                             User user)
                      throws EntityException,
                             java.lang.IllegalArgumentException

Removes the user from the specified group.

Throws:

EntityException - if the membership could not be removed.

java.lang.UnsupportedOperationException - if isReadOnly(Group) returns true.

java.lang.IllegalArgumentException - if the group is not handled by this manager

supportsExternalMembership

public boolean supportsExternalMembership()
                                   throws EntityException

Returns true if the repository supports users in other repositories being members of groups in this repository.

Typically this is true of an application-specific Hibernate repository, but not of a company's LDAP server. It is designed to allow the LDAP users to be members of the application's groups for flexible application-level security.

Returns:

true if users from other repositories can be granted membership to groups in this repository, otherwise false.

Throws:

EntityException

isReadOnly

public boolean isReadOnly(Group group)
                   throws EntityException

Returns true if the specified group and membership of the specified group cannot be modified in the repository.

If this returns true, invoking methods which attempt to modify the group or membership of the group will fail with UnsupportedOperationException.

Returns:

true if the group and membership of the group cannot be modified, otherwise false.

Throws:

EntityException