public interface UserManager extends ResourceManager
Modifier and Type | Method and Description |
---|---|
void |
addAssociation(CentraSiteUser localUser,
CentraSiteUser unregisteredUser)
Associates unregistered user with local user thus the unregistered user becomes registered user.
|
CentraSiteUser |
createUnknownUser(java.lang.String fqn)
Used for creation of Users not known to the currently effective external user repository.
|
CentraSiteUser |
createUser()
Create a new instance of
CentraSiteUser . |
void |
deleteUser(CentraSiteUser user)
Delete the specified user.
|
void |
deleteUsers(java.util.Collection<CentraSiteUser> users)
Delete the specified users.
|
java.util.Collection<javax.xml.registry.infomodel.Organization> |
getOrganizations(CentraSiteUser user)
Get the organizations that the specified user is a member of.
|
java.util.Collection<javax.xml.registry.infomodel.Organization> |
getOrganizations(CentraSiteUser user,
CentraSitePermission permission)
Get the organizations that the specified user has the specified permission for.
|
CentraSiteUser |
getPrimaryContact(javax.xml.registry.infomodel.Organization organization)
Get the primary contact of the given organization.
|
java.util.Collection<CentraSiteUser> |
getRegisteredUsers()
Get all users registered in CentraSite.
|
java.util.Collection<CentraSiteUser> |
getRegisteredUsers(java.lang.String filter)
Using a filter to get the registered users in CentraSite.
|
java.util.Collection<CentraSiteUser> |
getRegisteredUsersEx()
Get all users registered in CentraSite.
|
java.util.Collection<CentraSiteUser> |
getRegisteredUsersEx(java.lang.String filter)
Using a filter to get the registered users in CentraSite.
|
java.util.Collection<CentraSiteUser> |
getUnregisteredUsers(java.lang.String filter)
Get the external users that are not known to CentraSite using the specified search filter.
|
CentraSiteUser |
getUser(javax.xml.registry.infomodel.User user)
Utility method to obtain
CentraSiteUser instance of User . |
java.util.Collection<CentraSiteUser> |
getUsers(javax.xml.registry.infomodel.Organization organization)
Get the users that are members of the specified organization.
|
java.util.Collection<CentraSiteUser> |
getUsers(java.lang.String filter)
Get the users using the specified search filter.
|
java.util.Collection<CentraSiteUser> |
getUsersEx(javax.xml.registry.infomodel.Organization organization)
Get the users that are members of the specified organization.
|
java.util.Collection<CentraSiteUser> |
getUsersEx(java.lang.String filter)
Get the users using the specified search filter.
|
void |
setPrimaryContact(CentraSiteUser user,
javax.xml.registry.infomodel.Organization organization)
Set the given user as primary contact for the given organization.
|
delete, save
CentraSiteUser createUser() throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
CentraSiteUser
.CentraSiteUser
instancejavax.xml.registry.JAXRException
- If a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security error occursCentraSiteUser createUnknownUser(java.lang.String fqn) throws com.softwareag.security.jaas.principals.SagGeneralSecurityException, javax.xml.registry.JAXRException
fqn
- The fully qualified name of the user e.g. "DOMAIN\username"CentraSiteUser
instance representing the unknown user.com.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security error occursjavax.xml.registry.JAXRException
- If a JAXR error occursvoid deleteUser(CentraSiteUser user) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
user
- The CentraSiteUser
which has to be deletedjavax.xml.registry.JAXRException
- If a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security error occursvoid deleteUsers(java.util.Collection<CentraSiteUser> users) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
users
- The CentraSiteUser
s which have to be deletedjavax.xml.registry.JAXRException
- If a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security error occursjava.util.Collection<CentraSiteUser> getUsers(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 CentraSiteUser
objects which match the specified 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<CentraSiteUser> getUsersEx(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 CentraSiteUser
objects which match the specified 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<CentraSiteUser> getUsers(javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
organization
- The Organization
whose members are being searching forCollection
of CentraSiteUser
objects who belong to the specified organization (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<CentraSiteUser> getUsersEx(javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
organization
- The Organization
whose members are being searching forCollection
of CentraSiteUser
objects who belong to the specified organization (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<javax.xml.registry.infomodel.Organization> getOrganizations(CentraSiteUser user, CentraSitePermission permission) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
user
- The CentraSiteUser
whose organizations are to be retrievedpermission
- The CentraSitePermission
which the user should haveCollection
of Organization
objects (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<javax.xml.registry.infomodel.Organization> getOrganizations(CentraSiteUser user) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
user
- The CentraSiteUser
whose belonging organization is to be retrievedCollection
of Organization
objects (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<CentraSiteUser> getUnregisteredUsers(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 occurs. Filter is in format as declared
by SSX. See SSXRepositoryManager
for details.Collection
of CentraSiteUser
objects 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<CentraSiteUser> getRegisteredUsers() throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
Collection
of CentraSiteUser
objects who are 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 occursjava.util.Collection<CentraSiteUser> getRegisteredUsersEx() throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
Collection
of CentraSiteUser
objects who are 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 occursjava.util.Collection<CentraSiteUser> getRegisteredUsers(java.lang.String filter) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
filter
- Search filter - If filter is empty or null, then it searches for all registered usersCollection
of CentraSiteUser
objects (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<CentraSiteUser> getRegisteredUsersEx(java.lang.String filter) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
filter
- Search filter - If filter is empty or null, then it searches for all registered usersCollection
of CentraSiteUser
objects (may be empty but not null)javax.xml.registry.JAXRException
- If a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security error occursCentraSiteUser getUser(javax.xml.registry.infomodel.User user) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
CentraSiteUser
instance of User
.user
- The User
registry object.CentraSiteUser
instancejavax.xml.registry.JAXRException
- If a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security error occursvoid addAssociation(CentraSiteUser localUser, CentraSiteUser unregisteredUser) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
CentraSiteUser.save()
must be called on the unregistered user instance in order for the registration to occur.localUser
- The local user instance with which the unregistered user must be associatedunregisteredUser
- The external unregistered user which has to be registered with CentraSitejavax.xml.registry.JAXRException
- If a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security error occursvoid setPrimaryContact(CentraSiteUser user, javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException
user
- The CentraSiteUser to be set as primary contact.organization
- The Organization to set primary contact to.javax.xml.registry.JAXRException
- If a JAXR error occursCentraSiteUser getPrimaryContact(javax.xml.registry.infomodel.Organization organization) throws javax.xml.registry.JAXRException, com.softwareag.security.jaas.principals.SagGeneralSecurityException
organization
- The Organization
for which the primary contact is retrievedjavax.xml.registry.JAXRException
- If a JAXR error occurscom.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security error occurs