public interface User extends CentraSiteRegistryObject
Organization
.Modifier and Type | Method and Description |
---|---|
void |
addRoles(java.util.Collection<Role> roles)
Assign the collection of roles to this user.
|
boolean |
canCreateAsset(Organization organization)
Check if the user has privilege to create an asset instance in the given organization.
|
boolean |
canCreatePolicy(Organization organization)
Checks if the user has privilege to create a policy in the given organization.
|
boolean |
canDelete(CentraSiteObject centraSiteObject)
Check if the user has privilege to delete the given RegistryObject.
|
boolean |
canManageAssetTypes()
Checks whether the user has the "Manage Asset Types" permission.
|
boolean |
canManageLCM(Organization organization) |
boolean |
canManageOrganizations()
Checks whether the user has the "Manage Organization" permission.
|
boolean |
canManageOrganizations(Organization organization)
Checks whether the user has the Manage Organizations permission in the given organization.
|
boolean |
canManagePolicy(Organization organization) |
boolean |
canManageReportTemplates()
Checks whether the user has the "Manage Report Templates" permission.
|
boolean |
canManageSystemWideDesignTimePolices() |
boolean |
canManageSystemWideLCM() |
boolean |
canManageTaxonomies()
Checks whether the user has the "Manage Taxonomies" permission.
|
boolean |
canModify(CentraSiteRegistryObject centraSiteRegistryObject)
Check if the user has privilege to modify the given
CentraSiteRegistryObject . |
boolean |
canUseAdministrationUI()
Checks whether the user has the "Use the Administration UI" permission.
|
java.lang.String |
getAvatar()
Get the profile picture's URL of the current user.
|
CentraSiteRepositoryFolder |
getDefaultRepositoryFolder()
Get the default repository folder location of the user.
|
java.lang.String |
getDisplayName()
Returns the Display Name of the current user.
|
java.util.Collection<java.lang.String> |
getEmailAddresses()
Get the collection of email addresses for the current user.
|
java.util.Properties |
getExternalProperties()
Get the user's external repository properties.
|
java.lang.String |
getFirstName()
Get the First Name of the current user.
|
java.util.Collection<Group> |
getGroupsOfUser()
Retrieves the list of groups of which this user is a part of.
|
java.lang.String |
getLastName()
Get Last Name of the current user.
|
java.lang.String |
getMiddleName()
Get Middle Name of the current user.
|
java.util.Collection<Organization> |
getOrganizations()
Get all organizations this user belongs to.
|
java.util.Collection<PostalAddress> |
getPostalAddress()
Get the Postal Addresses for the user.
|
java.util.Collection<Role> |
getRolesOfUser()
Retrieves the roles assigned to a user.
|
java.util.Collection<TelephoneNumber> |
getTelephoneNumbers(java.lang.String phoneType)
Get the collection of telephone numbers for the current user.
|
UserPreferences |
getUserPreferences()
Return
UserPreferences of this user. |
java.util.Collection<Role> |
getVisibleRoles()
Get the roles which are visible to this user.
|
boolean |
hasFullPermission(CentraSiteRegistryObject cso)
Check if the user has read, write and delete permission on the registry object.
|
boolean |
hasRole(java.lang.String roleId)
Check if this user has the role given by the roleId.
|
boolean |
hasRole(java.lang.String roleId,
Organization organization)
Check if the user has the specified role in the specified organization.
|
boolean |
hasRoleInAnyOrganization(java.lang.String roleId)
Checks if the user has the specified role in any organization.
|
boolean |
hasUnreadInboxItems()
Checks if the user has unread items in his/her inbox.
|
boolean |
isActive()
Whether current user is active or inactive.
|
boolean |
isCentraSiteAdministrator()
Checks whether this user has CSA role.
|
boolean |
isGuest()
Check if the user is a guest.
|
boolean |
isHidden()
Checks whether the current user is a Hidden user.
|
boolean |
isLDAPUser() |
void |
removeRoles(java.util.Collection<Role> roles)
Removes the roles assigned to the user.
|
void |
setAvatar(java.io.InputStream inputStreamOfImage)
Upload the given image as the profile picture of the current user.
|
void |
setEmailAddresses(java.util.Collection<java.lang.String> emailAddresses)
Sets the given collection of email addresses to the current user.
|
void |
setFirstName(java.lang.String firstName)
Sets First Name for the current user.
|
void |
setLastName(java.lang.String lastName)
Sets Last Name for the current user.
|
void |
setMiddleName(java.lang.String middleName)
Sets Middle Name for the current user.
|
void |
setTelephoneNumbers(java.util.Collection<TelephoneNumber> telephoneNumbers)
Sets the given collection of telephone numbers to the user.
|
void |
synchronizeLDAPUser() |
getConsumedAssets, getConsumers, getDescription, getDescription, getDisplayVersion, getInitialVirtualAssetName, getLastModifiedTimeStamp, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPendingApprovals, getPreviousVersion, getPreviousVersions, getRegistryObject, getRelationShipValueMap, getRequestedUser, getSubscribers, getSystemVersion, getTitle, getType, getUserVersion, getVisiblePrimaryProfiles, getVisibleProfile, isDeployedOn, isLatestVersionObject, isPropagatePermissions, isPropagateProfilePermissions, removeConsumedAssets, removeConsumers, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setPropagatePermissions, setPropagateProfilePermissions, setRelationShipValueMap, setUserVersion
delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, isModified, isPredefined, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
java.lang.String getFirstName() throws CLLException
CLLException
- If CLL fails to return the user's First Namevoid setFirstName(java.lang.String firstName) throws CLLException
firstName
- First Name to be set for the userCLLException
- If CLL fails to set the First Name for the userjava.lang.String getMiddleName() throws CLLException
CLLException
- If CLL fails to return the user's Middle Namevoid setMiddleName(java.lang.String middleName) throws CLLException
middleName
- Middle Name to be set for the userCLLException
- If CLL fails to set the Middle Name for the userjava.lang.String getLastName() throws CLLException
CLLException
- If CLL fails to return the user's Last Namevoid setLastName(java.lang.String lastName) throws CLLException
lastName
- Last Name to be set for the userCLLException
- If CLL fails to set the Last Name for the userjava.lang.String getDisplayName() throws CLLException
CLLException
- If CLL fails to return the user's Display Namejava.util.Collection<java.lang.String> getEmailAddresses() throws CLLException
Collection
of email addresses of the userCLLException
- If CLL fails to return the user's email addressesvoid setEmailAddresses(java.util.Collection<java.lang.String> emailAddresses) throws CLLException
emailAddresses
- Collection
of email addresses to be set for the userCLLException
- If CLL fails to set the given collection of email addresses to the userboolean isActive() throws CLLException
CLLException
- If CLL fails to return if the user is active or inactivevoid setTelephoneNumbers(java.util.Collection<TelephoneNumber> telephoneNumbers) throws CLLException
telephoneNumbers
- A Collection
of TelephoneNumber
s to setCLLException
- If CLL fails to add the given telephone number to the user.java.util.Collection<TelephoneNumber> getTelephoneNumbers(java.lang.String phoneType) throws CLLException
phoneType
- The phone type for the telephone numberCollection
of telephone numbers for the userCLLException
- If CLL fails to return the user's telephone numbersjava.util.Collection<Organization> getOrganizations() throws CLLException
Collection
of Organization
s this user belongs toCLLException
- If CLL fails to return the list of organizationsjava.util.Collection<PostalAddress> getPostalAddress() throws CLLException
Collection
of PostalAddress
es for the userCLLException
- If CLL fails to return the user's postal addressesboolean canModify(CentraSiteRegistryObject centraSiteRegistryObject) throws CLLException
CentraSiteRegistryObject
.centraSiteRegistryObject
- CentraSite object to be verifiedCLLException
- If CLL fails to verify the user's permission settingsboolean canDelete(CentraSiteObject centraSiteObject) throws CLLException
centraSiteObject
- CentraSiteObject
to verifyCLLException
- If CLL fails to verify the user's permission settingsboolean isCentraSiteAdministrator() throws com.softwareag.security.jaas.principals.SagGeneralSecurityException, javax.xml.registry.JAXRException
com.softwareag.security.jaas.principals.SagGeneralSecurityException
- If a security related error occursjavax.xml.registry.JAXRException
- If a JAXR related error occursboolean canCreateAsset(Organization organization) throws CLLException
organization
- Organization
in which the user should have permission.CLLException
- If CLL fails to verify the user's permission settingsboolean canCreatePolicy(Organization organization) throws CLLException
organization
- Organization
in which the user should have permission.CLLException
- If CLL fails to verify the user's permission settingsboolean isGuest() throws CLLException
CLLException
- If CLL fails to check if the user is a guestUserPreferences getUserPreferences() throws CLLException
UserPreferences
of this user.UserPreferences
instance which describes this user's preferencesCLLException
- if CLL fails to get the UserPreferences
void setAvatar(java.io.InputStream inputStreamOfImage) throws CLLException
inputStreamOfImage
- Profile picture as InputStream
CLLException
- if CLL fails to upload the profile picturejava.lang.String getAvatar() throws CLLException
String
CLLException
- If CLL fails to return the profile picture's URLCentraSiteRepositoryFolder getDefaultRepositoryFolder() throws CLLException
CLLException
- If an error is encountered while fetching the default repository folderboolean hasUnreadInboxItems()
boolean hasFullPermission(CentraSiteRegistryObject cso) throws CLLException
cso
- The CentraSiteRegistryObject
on which the user should have permissionCLLException
- If CLL fails to check for full permissionsboolean canManageOrganizations() throws CLLException
CLLException
- If CLL fails to perform the checkboolean canManageOrganizations(Organization organization) throws CLLException
organization
- The Organization
for which the check must be performed.true
if the user the Manage Organizations permission in the given organization, false
otherwise.CLLException
- If an error occurs while performing the check.java.util.Properties getExternalProperties() throws CLLException
Properties
for the userCLLException
- If an error occurs while fetching the external properties for the user.boolean isHidden() throws CLLException
CLLException
- If an error is encountered while trying to perform this checkvoid addRoles(java.util.Collection<Role> roles) throws CLLException
roles
- The Collection
of Role
s to assign to this userCLLException
- If CLL fails to add the given collection of rolesvoid removeRoles(java.util.Collection<Role> roles) throws CLLException
roles
- The Collection
of Role
s which have to be removed for the userCLLException
- If an error is thrown while trying to remove the set of roles for the userjava.util.Collection<Group> getGroupsOfUser() throws CLLException
Collection
of Group
sCLLException
- When an error is encountered while trying to retrieve the groups of a userjava.util.Collection<Role> getRolesOfUser() throws CLLException
Collection
of Role
s assigned to/inherited by the userCLLException
- When an error is encountered while trying to retrieve the roles of a userjava.util.Collection<Role> getVisibleRoles() throws CLLException
Collection
of Role
visible to this userCLLException
- If CLL fails to fetch the roles.boolean hasRole(java.lang.String roleId) throws CLLException
roleId
- The role id which the user should haveCLLException
- If CLL fails to check if the user has the given role.boolean hasRole(java.lang.String roleId, Organization organization) throws CLLException
roleId
- The role that the user is supposed to have.organization
- The Organization
in which the user should have the role.CLLException
- If CLL fails to perform the checkboolean hasRoleInAnyOrganization(java.lang.String roleId) throws CLLException
roleId
- The Default Organization role ID to checktrue
if the user has the role in any organization and false
otherwise.CLLException
- If an error occurs while performing the check.boolean canUseAdministrationUI() throws CLLException
CLLException
- If CLL fails to perform the checkboolean canManageTaxonomies() throws CLLException
CLLException
- If CLL fails to perform the checkboolean canManageAssetTypes() throws CLLException
CLLException
- If CLL fails to perform the checkboolean canManageReportTemplates() throws CLLException
CLLException
- If CLL fails to perform the checkvoid synchronizeLDAPUser() throws java.lang.Exception
java.lang.Exception
boolean isLDAPUser() throws com.softwareag.security.jaas.principals.SagGeneralSecurityException, CLLException
javax.xml.registry.JAXRException
com.softwareag.security.jaas.principals.SagGeneralSecurityException
CLLException
boolean canManageLCM(Organization organization) throws CLLException
organization
- CLLException
boolean canManagePolicy(Organization organization) throws CLLException
organization
- CLLException
boolean canManageSystemWideLCM()
boolean canManageSystemWideDesignTimePolices() throws CLLException
CLLException