|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.atlassian.crowd.integration.atlassianuser.CrowdGroupManager
public class CrowdGroupManager
Crowd implementation of the atlassian-user group manager.
A group manager is responsible for all CRUD operations on groups and group memberships in a given repository. Where an operation requires aGroup
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.
Constructor Summary | |
---|---|
CrowdGroupManager()
Default contructor. |
Method Summary | |
---|---|
void |
addMembership(Group group,
User user)
Adds the user to the specified group. |
Group |
createGroup(String name)
Create a new group with the specified name. |
protected List |
findAllGroupNames()
|
protected SOAPGroup |
findGroupByName(String name)
|
Pager |
getExternalMemberNames(Group group)
Sett #getLocalMemberNames(com.atlassian.user.Group) } |
Group |
getGroup(String name)
Retrieves the group with the given name. |
protected List |
getGroupMembership(User user)
Retrieves the groups to which the given user belongs. |
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. |
Repository |
getRepository()
Returns information about the respository implementation. |
Repository |
getRepository(Entity entity)
Returns information about the respository for a specific entity. |
boolean |
hasMembership(Group group,
User user)
Returns true if the user is a member of the specified group. |
void |
init(HashMap args)
Used for configuration by a config. |
boolean |
isCreative()
|
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 class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CrowdGroupManager()
CacheManagerAtlassianUser
.
Method Detail |
---|
public Pager getGroups() throws EntityException
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.
EntityException
public Pager getGroups(User user) throws EntityException
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.
EntityException
protected List getGroupMembership(User user) throws EntityException
List
containing a Group
for each group the user
belongs to. An empty list will be returned if the user does not belong to
any groups that this manager knows about.
EntityException
public Pager getMemberNames(Group group) throws EntityException
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.
EntityException
public Pager getLocalMemberNames(Group group) throws EntityException
supportsExternalMembership()
returns false
, this
call is equivalent to getMemberNames(Group)
.
group
- The group to lookup.
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.
EntityException
public Pager getExternalMemberNames(Group group) throws EntityException
#getLocalMemberNames(com.atlassian.user.Group)
}
group
- The group to lookup.
EntityException
- Search exception.public Group getGroup(String name) throws EntityException
null
if the
group does not exist in this repository.
Group
or null if the group does not exist.
EntityException
public Group createGroup(String name) throws EntityException
EntityException
- if the Group
could not be created.
UnsupportedOperationException
- if isCreative()
returns falsepublic void removeGroup(Group group) throws EntityException
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.
EntityException
- if the Group
could not be removed.
UnsupportedOperationException
- if isReadOnly(Group)
returns true.public void addMembership(Group group, User user) throws EntityException
supportsExternalMembership()
returns true
, the user will be added as an external user.
UnsupportedOperationException
- if isReadOnly(Group)
returns true.
EntityException
public boolean hasMembership(Group group, User user) throws EntityException
supportsExternalMembership()
returns true
, external members will be checked as well.
EntityException
public void removeMembership(Group group, User user) throws EntityException
EntityException
- if the membership could not be removed.
UnsupportedOperationException
- if GroupManager#isReadOnly(Group)
returns true.public boolean supportsExternalMembership() throws EntityException
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.
EntityException
public boolean isReadOnly(Group group) throws EntityException
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
.
EntityException
public Repository getRepository()
public Repository getRepository(Entity entity) throws EntityException
entity
- The entity.
EntityException
public boolean isCreative()
public void init(HashMap args) throws ConfigurationException
args
-
ConfigurationException
protected List findAllGroupNames() throws InvalidAuthorizationTokenException, RemoteException
InvalidAuthorizationTokenException
RemoteException
protected SOAPGroup findGroupByName(String name) throws InvalidAuthorizationTokenException, RemoteException, ObjectNotFoundException
InvalidAuthorizationTokenException
RemoteException
ObjectNotFoundException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |