public interface GroupManager extends ResourceManager
Modifier and Type | Method and Description |
---|---|
void |
addAssociation(CentraSiteGroup localGroup,
CentraSiteGroup unregisteredGroup)
Associates Unregistered Group with Local Group and thus the unregistered Group becomes Registered Group.
|
void |
close()
Clears the map when the session is closed.
|
CentraSiteGroup |
createGroup()
Create a new instance of
CentraSiteGroup ; By default a Local Group instance created. |
void |
deleteGroup(CentraSiteGroup group)
Delete specified group.
|
CentraSiteGroup |
getGroup(javax.xml.registry.infomodel.RegistryObject groupRegistryObject)
Utility method to obtain
CentraSiteGroup instance of RegistryObject of type "Group". |
CentraSiteGroup |
getGroup(java.lang.String id)
Get a group by its id.
|
java.util.Collection<CentraSiteGroup> |
getGroups(CentraSiteUser user)
Get the groups that the specified user is a member of.
|
java.util.Collection<CentraSiteGroup> |
getGroups(CentraSiteUser user,
CentraSitePermission permission)
Get the groups that the specified user has the specified permission for.
|
java.util.Collection<CentraSiteGroup> |
getGroups(javax.xml.registry.infomodel.Organization organization)
Get the groups that are related to the specified organization.
|
java.util.Collection<CentraSiteGroup> |
getGroups(java.lang.String filter)
Get the groups using the specified search filter.
|
java.util.Collection<CentraSiteGroup> |
getGroupsEx(CentraSiteUser user)
Get the groups that the specified user is a member of.
|
java.util.Collection<CentraSiteGroup> |
getGroupsEx(javax.xml.registry.infomodel.Organization organization)
Get the groups that are related to the specified organization.
|
java.util.Collection<CentraSiteGroup> |
getGroupsEx(java.lang.String filter)
Get the groups using the specified search filter.
|
java.util.Collection<CentraSiteGroup> |
getUnregisteredGroups(java.lang.String filter)
Get unregistered groups using the specified filter.
|
delete, save
CentraSiteGroup createGroup() throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
CentraSiteGroup
; By default a Local Group instance created.CentraSiteGroup
instancejavax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursvoid deleteGroup(CentraSiteGroup group) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
group
- The CentraSiteGroup
instance to deletejavax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursjava.util.Collection<CentraSiteGroup> getGroups(java.lang.String filter) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
filter
- Search filter - if the filter is an empty string then no filtering occursCollection
of CentraSiteGroup
s matching the given search filter (may be empty but not null)javax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursjava.util.Collection<CentraSiteGroup> getGroupsEx(java.lang.String filter) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
filter
- Search filter - if the filter is an empty string then no filtering occursCollection
of CentraSiteGroup
s matching the given search filter (may be empty but not null)javax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursjava.util.Collection<CentraSiteGroup> getGroups(CentraSiteUser user) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
user
- The CentraSiteUser
for whom group membership has to be retrievedCollection
of CentraSiteGroup
s which the given user is a part of (may be empty but not null)javax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursjava.util.Collection<CentraSiteGroup> getGroupsEx(CentraSiteUser user) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
user
- The CentraSiteUser
for whom group membership has to be retrievedCollection
of CentraSiteGroup
s which the given user is a part of (may be empty but not null)javax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursjava.util.Collection<CentraSiteGroup> getGroups(javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
organization
- The Organization
for which the groups have to be obtainedCollection
of CentraSiteGroup
s belonging to the given Organizationjavax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursjava.util.Collection<CentraSiteGroup> getGroupsEx(javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
organization
- The Organization
for which the groups have to be obtainedCollection
of CentraSiteGroup
s belonging to the given Organizationjavax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursjava.util.Collection<CentraSiteGroup> getGroups(CentraSiteUser user, CentraSitePermission permission) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
user
- The CentraSiteUser
belonging groupspermission
- The CentraSitePermission
that the group should haveCollection
of CentraSiteGroup
s where the given user is a member of and where the group has the given permission (may be empty but not null)javax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursjava.util.Collection<CentraSiteGroup> getUnregisteredGroups(java.lang.String filter) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
filter
- search filter - if filter is empty string then no filtering occursCollection
of CentraSiteGroup
s which are not yet registered with CentraSite (may be empty but not null)javax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursvoid addAssociation(CentraSiteGroup localGroup, CentraSiteGroup unregisteredGroup) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
localGroup
- The Local Group instance to associate with the unregistered groupunregisteredGroup
- externally managed groupjavax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursCentraSiteGroup getGroup(java.lang.String id) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
id
- Usually taken from ResourceAccessConstants
;javax.xml.registry.JAXRException
- if a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- if a security error occursCentraSiteGroup getGroup(javax.xml.registry.infomodel.RegistryObject groupRegistryObject) throws javax.xml.registry.JAXRException
CentraSiteGroup
instance of RegistryObject
of type "Group".groupRegistryObject
- The group RegistryObject
.CentraSiteGroup
instancejavax.xml.registry.JAXRException
- if a JAXR error occursjava.lang.IllegalArgumentException
- If groupRegistryObject is not of Group type.void close()