public interface CentraSiteUser extends ResourceAccessType
Modifier and Type | Method and Description |
---|---|
void |
activate()
The method activates the User.
|
void |
addOrganization(Organization organization)
Add an organization to this user's organizations.
|
void |
addRoles(java.util.Collection<CentraSiteRole> roles)
Add specified roles to this user.
|
java.util.Collection<RegistryObject> |
adjustImported()
Adjust the user object during import.
|
void |
deactivate()
The method deactivates the User.
|
java.util.Collection<EmailAddress> |
getEmailAddresses()
Get user's email addresses.
|
java.util.Collection<Organization> |
getOrganizations()
Get all organizations this user belongs to.
|
java.util.Collection<CentraSitePermission> |
getPermissions()
Returns the permissions that are applicable to this user.
|
PersonName |
getPersonName()
Gets the user's
PersonName object. |
java.util.Collection<PostalAddress> |
getPostalAddresses()
Get the user's postal addresses.
|
User |
getRegistryObject()
Returns the underlying JAXR
User object. |
java.util.Collection<CentraSiteRole> |
getRoles()
Returns all the roles directly assigned to this user as well as all roles assigned through group membership.
|
java.util.Collection<CentraSiteRole> |
getRoles(CentraSitePermission permission)
Returns all roles that this user has the specified permission for.
|
java.util.Collection<TelephoneNumber> |
getTelephoneNumbers(java.lang.String phoneType)
Get the user's telephone numbers.
|
java.util.Collection<RegistryObject> |
getUserAssets(java.util.Collection<java.lang.String> findQualifiers)
Gets the top-level assets owned by the given user.
|
Organization |
getWorkingOrganization()
Get the current working Organization of this user.
|
boolean |
hasCorrespondingPermission(CentraSitePermission permission)
This method verifies if the user has the specified permission.
|
boolean |
hasCorrespondingRole(java.lang.String roleId,
Organization organization)
This method verifies if the user has a specified role for a specified organization.
|
boolean |
hasFull(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro)
Check whether the group has full permission on the given registry object.
|
boolean |
hasModify(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro)
Check whether the group has modify permission on the given registry object.
|
boolean |
hasPermission(CentraSitePermission permission)
This method verifies if the user has a specified permission.
|
boolean |
hasPermission(CentraSitePermission permission,
Organization organization)
This method verifies if the user has a specified permission for a specified organization.
|
boolean |
hasView(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro)
Check whether the group has view permission on the given registry object.
|
boolean |
isActive()
Check if the User is active or not.
|
boolean |
isCentraSiteAdministrator()
Check if the user is the CentraSite Administrator.
|
boolean |
isGuestUser()
Check if this
CentraSiteUser instance is the predefined Guest User. |
boolean |
isPrimaryContact(Organization organization)
Check if the user is a primary contact for the given organization.
|
boolean |
isRegistered()
Checks whether this user registered with CentraSite or not.
|
void |
register()
Register this external repository user with CentraSite.
|
void |
removeOrganization(Organization organization)
Remove single organization from this user's organizations.
|
void |
removeRoles(java.util.Collection<CentraSiteRole> roles)
Remove specified roles from this user.
|
void |
save()
Persist the user.
|
void |
setEmailAddresses(java.util.Collection<EmailAddress> emailAddresses)
Set user's email addresses.
|
void |
setPersonName(PersonName personName)
Set the user's person name.
|
void |
setPostalAddresses(java.util.Collection<PostalAddress> postalAddresses)
Set the user's postal addresses.
|
void |
setTelephoneNumbers(java.util.Collection<TelephoneNumber> telephoneNumbers)
Set user's telephone numbers.
|
void |
setWorkingOrganization(Organization organization)
Set the current working organization of this user.
|
void |
synchronizePropertiesAndSave()
Synchronize external repository properties with the respective User registry Object properties, using a predefined
mapping between them.
|
void |
unregister()
Unregister this user from CentraSite.
|
addAssociations, addClassifications, addExternalLinks, addSlots, getAssociations, getClassifications, getDescription, getDisplayName, getExternalLinks, getExternalProperties, getId, getProperties, getSlots, preDelete, preSave, removeAssociations, removeClassifications, removeExternalLinks, removeProperties, removeSlots, setDescription, setDisplayName, setProperties, synchronizeProperties
void removeOrganization(Organization organization)
organization
- The Organization
to be removed for the user.void addOrganization(Organization organization)
organization
- The Organization
to add for the user.java.util.Collection<Organization> getOrganizations()
Collection
of Organization
instances to which this user belongs.Organization getWorkingOrganization()
Organization
of this user.void setWorkingOrganization(Organization organization)
organization
- The working Organization
to be set.PersonName getPersonName() throws JAXRException, SagGeneralSecurityException
PersonName
object.PersonName
for the userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursUser#getPersonName()
void setPersonName(PersonName personName) throws JAXRException, SagGeneralSecurityException
personName
- The PersonName
to set for the userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursUser#setPersonName(PersonName)
java.util.Collection<PostalAddress> getPostalAddresses() throws JAXRException, SagGeneralSecurityException
PostalAddress
objects for the userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursUser#getPostalAddresses()
void setPostalAddresses(java.util.Collection<PostalAddress> postalAddresses) throws JAXRException, SagGeneralSecurityException
postalAddresses
- The Collection
of PostalAddress
values for the userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursUser#setPostalAddresses(Collection)
java.util.Collection<TelephoneNumber> getTelephoneNumbers(java.lang.String phoneType) throws JAXRException, SagGeneralSecurityException
phoneType
- The phone type for retrieving the telephone numbers. Ex: Office, Mobile, Home, Fax, etc.,Collection
of TelephoneNumber
s for the userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursUser#getTelephoneNumbers(String)
void setTelephoneNumbers(java.util.Collection<TelephoneNumber> telephoneNumbers) throws JAXRException, SagGeneralSecurityException
telephoneNumbers
- The Collection
of TelephoneNumber
s for the userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursUser#setTelephoneNumbers(Collection)
java.util.Collection<EmailAddress> getEmailAddresses() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursUser#getEmailAddresses()
void setEmailAddresses(java.util.Collection<EmailAddress> emailAddresses) throws JAXRException, SagGeneralSecurityException
emailAddresses
- The email addresses to set for the userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursUser#setEmailAddresses(Collection)
void addRoles(java.util.Collection<CentraSiteRole> roles) throws JAXRException, SagGeneralSecurityException
roles
- The roles to assign to this userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid removeRoles(java.util.Collection<CentraSiteRole> roles) throws JAXRException, SagGeneralSecurityException
roles
- The roles to remove for this userJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursjava.util.Collection<CentraSitePermission> getPermissions() throws JAXRException, SagGeneralSecurityException
Collection
of CentraSitePermission
objects that are applicable to this user (may be empty but not null)JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean hasPermission(CentraSitePermission permission) throws JAXRException, SagGeneralSecurityException
permission
- The CentraSitePermission
that the user should be checked forJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean hasPermission(CentraSitePermission permission, Organization organization) throws JAXRException, SagGeneralSecurityException
permission
- The CentraSitePermission
that the user should be checked fororganization
- The Organization
which the user should have permission inJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean hasCorrespondingPermission(CentraSitePermission permission) throws JAXRException, SagGeneralSecurityException
permission
- The CentraSitePermission
to check for (must be system level)JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean hasCorrespondingRole(java.lang.String roleId, Organization organization) throws JAXRException, SagGeneralSecurityException
roleId
- System level role id or default organization's role idorganization
- The Organization
where the user should have the specified roleJAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursjava.util.Collection<CentraSiteRole> getRoles() throws JAXRException, SagGeneralSecurityException
Collection
of CentraSiteRole
s that the user is assigned directly or has inherited (may be empty but not null)JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursjava.util.Collection<CentraSiteRole> getRoles(CentraSitePermission permission) throws JAXRException, SagGeneralSecurityException
permission
- The CentraSitePermission
which the user should haveCollection
of CentraSiteRole
s that the user has with the specified permission (may be empty but not null)JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursboolean isRegistered() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid register() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid unregister() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursvoid save() throws JAXRException, SagGeneralSecurityException
JAXRException
- If a JAXR error occursSagGeneralSecurityException
- If a security error occursjava.util.Collection<RegistryObject> getUserAssets(java.util.Collection<java.lang.String> findQualifiers) throws JAXRException
findQualifiers
- The JAXR find qualifiers for this queryCollection
of RegistryObject
instances having the assets owning by this user (may be empty but not null)JAXRException
- If a JAXR error occursCentraSiteQueryManager.findUserAssets(Collection, javax.xml.registry.infomodel.User)
boolean isGuestUser()
CentraSiteUser
instance is the predefined Guest User.void activate()
void deactivate()
boolean isActive()
boolean isPrimaryContact(Organization organization) throws JAXRException
organization
- The Organization
which should be checkedJAXRException
- If a JAXR error occursboolean isCentraSiteAdministrator() throws SagGeneralSecurityException, JAXRException
SagGeneralSecurityException
- If a security error occursJAXRException
- If a JAXR error occursboolean hasView(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro) throws JAXRException
ro
- The RegistryObject
for which the user should be checked for privilegesJAXRException
- If a JAXR error occursboolean hasModify(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro) throws JAXRException
ro
- The RegistryObject
for which the user should be checked for privilegesJAXRException
- If a JAXR error occursboolean hasFull(com.centrasite.jaxr.infomodel.CentraSiteRegistryObject ro) throws JAXRException
ro
- The RegistryObject
for which the user should be checked for privilegesJAXRException
- If a JAXR error occursjava.util.Collection<RegistryObject> adjustImported() throws JAXRException
Collection
of updated system objects (roles)JAXRException
- If a JAXR error occursUser getRegistryObject()
User
object.User
objectvoid synchronizePropertiesAndSave() throws java.lang.Exception
java.lang.Exception