|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface CSSDirectoryManagementAPIIF
This is an EPM mode only Interface. All implementation of this interface will throw
CSSMethodNotSupportedException in Fusion/JPS mode
This interface provides for interaction to create, retrieve, update and delete users, groups, and roles in the Hyperion Hub (Shared Services) directory.
"Hyperion Shared Services Directory" is the repository of native users, groups, and roles. Its function is similar to the corporate directories with one important distinguishing feature - the IT Admin is not the individual that interacts with it. The Hyperion Application Admin is responsbile for utilizing it.
This API is thread safe - threads can access it concurrently without introducing any deadlock or any other abnormal behavior.
If, during the course of the invocation of a method, the user identified by the CSSPrincipalIF parameter is deleted,
then a CSSInvalidPrincipalException is nested in a CSSException and
thrown.
If a user is deactivated, then it will not be available for retrieval unless explicitly requested. The CSSNativeUserIF for a deactivated entity is never exposed. Therefore, no updates are permissible on a deactivated entity. It has to be activated before any further updates can be processed.
| Method Summary | |
|---|---|
void |
activateNativeUsers(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] userIdentities)
Activates native users. |
void |
addDelegatedList(java.util.Map context,
CSSPrincipalIF principal,
CSSDelegatedListIF delegatedList)
Adds the specified delegated list to the native directory. |
void |
addNativeGroup(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeGroupIF group)
Adds a group to the native directory. |
void |
addNativeRole(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeRoleIF role)
Adds an aggregated role to the native directory. |
void |
addNativeUser(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeUserIF user)
Adds a user to the native directory. |
void |
deactivateNativeUsers(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] userIdentities)
De-activates native users. |
void |
deleteDelegatedList(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String name)
Deleted the specified delegated list in the native directory. |
void |
deleteNativeGroups(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] groupIdentities)
Deletes native groups and removes all associated relationships with provisioning, parent groups, and the containing users and groups. |
void |
deleteNativeRoles(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] roleIdentities)
Deletes roles. |
void |
deleteNativeUsers(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] userIdentities)
Deletes native users and removes all associated relationships with groups and provisioning. |
CSSDelegatedListIF[] |
getDelegatedList(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String name)
Returns an array of delegated lists that matches the specified name. |
CSSNativeGroupIF |
getNativeGroupByIdentity(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String identity)
Gets the group instance for updates given the identity in the argument. |
CSSNativeGroupIF |
getNativeGroupInstance(java.util.Map context,
CSSPrincipalIF principal)
Creates and returns a CSSNativeGroupIF with the identity filled in for creation. |
CSSNativeRoleIF |
getNativeRoleByIdentity(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String identity)
Gets the role instance for updates given the identity in the argument. |
CSSNativeRoleIF |
getNativeRoleInstance(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String productType)
Returns an instance of a CSSNativeRoleIF for the purposes of creation of a role. |
CSSNativeUserIF |
getNativeUserByIdentity(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String identity)
Gets the user instance for updates given the identity in the argument. |
CSSNativeUserIF |
getNativeUserInstance(java.util.Map context,
CSSPrincipalIF principal)
Creates and returns a CSSNativeUserIF with the identity filled in for creation. |
void |
setPassword(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String identity,
java.lang.String password)
Changes the password for a native user. |
void |
setPassword(java.util.Map context,
java.lang.String userName,
java.lang.String oldPassword,
java.lang.String newPassword)
Changes the password for a native user. |
void |
updateDelegatedList(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String oldName,
CSSDelegatedListIF delegatedList)
Updates the specified delegated list in the native directory. |
void |
updateNativeGroup(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeGroupIF group)
Updates the native group. |
void |
updateNativeRole(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeRoleIF role)
Updates the native role. |
void |
updateNativeUser(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeUserIF user)
Updates the native user. |
| Method Detail |
|---|
void addNativeUser(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeUserIF user)
throws CSSEntityAlreadyExistsException,
CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Adds a user to the native directory. If the principal does not have access to the groups that this user is to be
associated with or if the principal does not have the required role to perform this operation then a
CSSAuthorizationExceptionis thrown.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.user - The data object to be persisted for this user.
CSSEntityAlreadyExistsException - If any of the users with the login name specified exists.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void updateNativeUser(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeUserIF user)
throws CSSInvalidUserException,
CSSAuthorizationException,
CSSNoProviderException,
CSSEntityAlreadyExistsException,
CSSCommunicationException,
CSSException
Updates the native user. The update might involve committing modified user properties, which could include group membership.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.user - The data object to be persisted for this user.
CSSInvalidUserException - If the user with the identity does not exist anymore.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSEntityAlreadyExistsException - If another user with the same name already exists.
CSSException - - Any other abnormality.
CSSException
CSSCommunicationException
void addNativeGroup(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeGroupIF group)
throws CSSEntityAlreadyExistsException,
CSSCircularDependencyException,
CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Adds a group to the native directory.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.group - The data object to be persisted for this group.
CSSEntityAlreadyExistsException - If any of the groupr with the group name specified exists.
CSSCircularDependencyException - If a circular dependency is being introduced.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void updateNativeGroup(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeGroupIF group)
throws CSSInvalidGroupException,
CSSCircularDependencyException,
CSSAuthorizationException,
CSSNoProviderException,
CSSEntityAlreadyExistsException,
CSSCommunicationException,
CSSException
Updates the native group.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.group - the data object to be persisted for this group.
CSSInvalidGroupException - If the group with the specified identity does not exist.
CSSCircularDependencyException - If a circular dependency is being introduced.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSEntityAlreadyExistsException - If another group with the same name already exists.
CSSException - Any other abnormality.
CSSCommunicationException
void addNativeRole(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeRoleIF role)
throws CSSEntityAlreadyExistsException,
CSSCircularDependencyException,
CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Adds an aggregated role to the native directory.
This method makes the necessary authorization checks. For instance, in the case of an aggregate role, it is checked that the principal has at least "MODIFY" access on the base roles.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.role - The data object to be persisted for this role.
CSSEntityAlreadyExistsException - If any of the roles with the role name specified exists for this product type or another role exists
for the identity generated for this preconfigured role.
CSSCircularDependencyException - If a circular dependency is being introduced.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void addDelegatedList(java.util.Map context,
CSSPrincipalIF principal,
CSSDelegatedListIF delegatedList)
throws CSSEntityAlreadyExistsException,
CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Adds the specified delegated list to the native directory.
This operation can be performed by a principal who has a HUB ADMINISTRATOR (
CSSAPIIF.ROLE_ADMINISTRATOR_IDENTITY) role or who is a Delegated Administrator.
Delegated Lists can be forcefully added for delegated admin mode off. by specifying (
CSSAPIIF.IE_DELEGATED_MODE) in the context
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.delegatedList - The data object to be persisted for this delegated list.
CSSEntityAlreadyExistsException - If any of the delegatedList has the same name as the specified one.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void updateDelegatedList(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String oldName,
CSSDelegatedListIF delegatedList)
throws CSSEntityAlreadyExistsException,
CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Updates the specified delegated list in the native directory.
This operation can be performed by a principal who has a HUB ADMINISTRATOR (
CSSAPIIF.ROLE_ADMINISTRATOR_IDENTITY) role. It can also be performed by a principal who is a Delegated
Administrator, but only for the list(s) for which he is a manager.
Delegated Lists can be forcefully updated for delegated admin mode off. by specifying (
CSSAPIIF.IE_DELEGATED_MODE) in the context
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.delegatedList - The data object to be persisted for this delegated list.oldName - The current name of the list being updated.
CSSEntityAlreadyExistsException - If any of the delegatedList has the same name as the specified one.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void deleteDelegatedList(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String name)
throws CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Deleted the specified delegated list in the native directory.
This operation can be performed by a principal who has a HUB ADMINISTRATOR (
CSSAPIIF.ROLE_ADMINISTRATOR_IDENTITY) role. It can also be performed by a principal who is a Delegated
Administrator, but only for the list(s) for which he is a manager.
Delegated Lists can be forcefully deleted for delegated admin mode off. by specifying (
CSSAPIIF.IE_DELEGATED_MODE) in the context
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.name - Name of the delegated list to delete.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void updateNativeRole(java.util.Map context,
CSSPrincipalIF principal,
CSSNativeRoleIF role)
throws CSSInvalidRoleException,
CSSCircularDependencyException,
CSSAuthorizationException,
CSSNoProviderException,
CSSEntityAlreadyExistsException,
CSSCommunicationException,
CSSException
Updates the native role. Please note that a preconfigured role cannot be made available for updates.
This method makes the necessary authorization checks. For instance, in the case of an aggregate role, it is checked that the principal has at least "MODIFY" access on the base roles.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.role - the data object to be persisted for this role.
CSSInvalidRoleException - If the role with the specified identity does not exist.
CSSCircularDependencyException - If a circular dependency is being introduced.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSEntityAlreadyExistsException - If another role with the same name already exists.
CSSException - Any other abnormality.
CSSCommunicationException
CSSNativeUserIF getNativeUserByIdentity(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String identity)
throws CSSInvalidUserException,
CSSInvalidIdentityException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Gets the user instance for updates given the identity in the argument. An authorization check is made to confirm that the operation is allowed for this principal. Please note that getting an instance for a CSSNativeUserIF implies that an update needs to be performed.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.identity - The identity for the user.
CSSPermissionIF.MODIFY on the user specified by the identity.
CSSInvalidUserException - If the user with the specified identity does not exist.
CSSInvalidIdentityException - If the identity format is not valid.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
CSSNativeGroupIF getNativeGroupByIdentity(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String identity)
throws CSSInvalidGroupException,
CSSInvalidIdentityException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Gets the group instance for updates given the identity in the argument. An authorization check is made to confirm that the operation is allowed for this principal. Please note that getting an instance for a CSSNativeGroupIF implies that an update needs to be performed.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.identity - The identity for the group.
CSSPermissionIF.MODIFYon the group specified by the identity.
CSSInvalidGroupException - If the group with the specified identity does not exist.
CSSInvalidIdentityException - If the identity format is not valid.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
CSSNativeRoleIF getNativeRoleByIdentity(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String identity)
throws CSSInvalidRoleException,
CSSInvalidIdentityException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Gets the role instance for updates given the identity in the argument. An authorization check is made to confirm that the operation is allowed for this principal. Please note that getting an instance for a CSSNativeRoleIF implies that an update needs to be performed.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.identity - The identity for the role.
CSSPermissionIF.MODIFYon the role specified by the identity. Please note
that null would be returned if the role is a preconfigured role.
CSSInvalidRoleException - If the role with the specified identity does not exist.
CSSInvalidIdentityException - - If the identity format is not valid.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
CSSNativeUserIF getNativeUserInstance(java.util.Map context,
CSSPrincipalIF principal)
throws CSSNoProviderException,
CSSCommunicationException,
CSSException
Creates and returns a CSSNativeUserIF with the identity filled in for creation. This will check that the principal has the appropriate role for creation of a user.
This method call leads to a CSS Identity being contructed and returned.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.
CSSNoProviderException - If there is no native provider configured.
CSSException - - Any other abnormality.
CSSCommunicationException
CSSNativeGroupIF getNativeGroupInstance(java.util.Map context,
CSSPrincipalIF principal)
throws CSSNoProviderException,
CSSCommunicationException,
CSSException
Creates and returns a CSSNativeGroupIF with the identity filled in for creation. This will check that the principal has the appropriate role for creation of a group.
This method call leads to a CSS Identity being contructed and returned.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
CSSNativeRoleIF getNativeRoleInstance(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String productType)
throws CSSNoProviderException,
CSSEntityAlreadyExistsException,
CSSCommunicationException,
CSSException
Returns an instance of a CSSNativeRoleIF for the purposes of creation of a role. The ProductType argument is utilized for the specification of the CSS identity. Please note that the CSS identity for the role would include the objectId that is made available to this method (if it is a preconfigured role) or is generated by the CSS system (if it is not a preconfigured role).
This method call leads to a CSS Identity being contructed and returned.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
If the objectId is passed in then the role is considered to be a preconfigured role.
context - Map structure holding key-value information about locale.principal - The identity of the caller.productType - The type of the product for which the role is being created. For instance: HFM-3_0.
CSSAPIIF.ROLE_PROVISIONING_MANAGER_IDENTITY.
CSSNoProviderException - If there is no native provider configured.
CSSEntityAlreadyExistsException - If any of the roles exist with the same identity that is generated when the objectId is passed in. If
an objectId is passed in then that is a preconfigured role.
CSSException - Any other abnormality.
CSSCommunicationException
void setPassword(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String identity,
java.lang.String password)
throws CSSAuthorizationException,
CSSCommunicationException,
CSSNoProviderException,
CSSPasswordPolicyException,
CSSException
Changes the password for a native user. setPassword() can be used to assign a new password for the
first time or change an existing password.
The scenarios are:
identity
parameter where the principal has CSSPermissionIF.FULL_CONTROLpermission on it. principal argument is an account with authority (as specified above) over the user
account specificed by the identity argument. The new password to apply should be provided in the
password argument.principal argument refers to an account that is the same user account as specified by the
identity argument. The password to apply should be provided in the password argument. principal, and then
invoke this method with the new password.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.identity - Target identity to which password should be applied.password - Password to apply, in plain text.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSPasswordPolicyException - Thrown if password policy applicable, enabled and if any password policy error.
CSSIllegalArgumentException - Thrown if the context is null, the identity is null or empty, or the password arguement is null or
empty. The message assigned indicates the condition.
CSSException - Any other abnormality.
CSSCommunicationException
void setPassword(java.util.Map context,
java.lang.String userName,
java.lang.String oldPassword,
java.lang.String newPassword)
throws CSSCommunicationException,
CSSNoProviderException,
CSSPasswordPolicyException,
CSSException
Changes the password for a native user. setPassword() can be used to assign a new password for the
first time or change an existing password.
userName argument refers to an user account that password to be changed. The user in order to
change his or her password must provide the oldPassword argument. The new password to apply should
be provided in the newPassword argument.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.userName - Target userName to which password should be applied.oldPassword - old password in plain text.newPassword - new password to apply, in plain text.
CSSCommunicationException - Thrown if not able to communicate with Native Provider.
CSSNoProviderException - If there is no native provider configured.
CSSPasswordPolicyException - Thrown if password policy applicable, enabled and if any password policy error.
CSSIllegalArgumentException - Thrown if the context is null, the identity is null or empty, or the old password arguement is null
or empty, or the new password arguement is null or empty. The message assigned indicates the
condition.
CSSException - Any other abnormality.
void deleteNativeUsers(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] userIdentities)
throws CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Deletes native users and removes all associated relationships with groups and provisioning.
The principal must have the required privileges to successfully delete the users specified. If the principal has
insufficient privileges, a CSSAuthorizationException is thrown and no deletes are carried out.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller (principal authority requesting the change).userIdentities - Array of identities of users who are to be deleted.
CSSAuthorizationException - if the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void deleteNativeGroups(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] groupIdentities)
throws CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Deletes native groups and removes all associated relationships with provisioning, parent groups, and the containing users and groups.
The principal must have the required privileges to successfully delete the groups specified. If the principal has
insufficient privileges, a CSSAuthorizationException is thrown and no deletes are carried out.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.groupIdentities - Array of identities of groups who are to be deleted.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void deleteNativeRoles(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] roleIdentities)
throws CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Deletes roles.
The preconfigured roles cannot be deleted. They are registered and deregistered. Deletion of an aggregate role does not lead to deletion of its consituents. However, deletion of all the constituents of an aggregate role would lead to its deletion. The principal must have the required privileges to successfully delete the roles specified. If the principal has insufficient privileges, aCSSAuthorizationException is thrown and no deletes are be
carried out. Additionally, a CSSAuthorizationException is thrown in the case wherein a principal attempts
to delete a preconfigured role.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller.roleIdentities - Array of identities of roles who are to be deleted.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void activateNativeUsers(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] userIdentities)
throws CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
Activates native users.
This call activates native users and re-establishes all relationships with container groups and provisioning.
The principal must have the required privileges to successfully activate the users specified. If the principal
has insufficient privileges, a CSSAuthorizationException is thrown and no activations are carried out.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller (principal authority requesting the change).userIdentities - Array of identities of users who are to be activated.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
void deactivateNativeUsers(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String[] userIdentities)
throws CSSAuthorizationException,
CSSNoProviderException,
CSSCommunicationException,
CSSException
De-activates native users.
The principal must have the required privileges to successfully de-activate the users specified. If the principal
has insufficient privileges, a CSSAuthorizationException is thrown and no de-activation is carried out.
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller (principal authority requesting the change).userIdentities - Array of identities of users to be de-activated.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSNoProviderException - If there is no native provider configured.
CSSException - Any other abnormality.
CSSCommunicationException
CSSDelegatedListIF[] getDelegatedList(java.util.Map context,
CSSPrincipalIF principal,
java.lang.String name)
throws CSSAuthorizationException,
CSSException
This operation can be performed by a principal who has a HUB ADMINISTRATOR (
CSSAPIIF.ROLE_ADMINISTRATOR_IDENTITY) role. It can also be performed by a principal who is a Delegated
Administrator, but it will return only the lists for which he is a manager.
Delegated Lists can be forcefully fetched for delegated admin mode off. by specifying (
CSSAPIIF.IE_DELEGATED_MODE) in the context
The context can specify the following:
These properties are discussed in the field description for CSSAPIIF. Please note that if the
locale is not specified, the default locale set for the system is used.
context - Map structure holding key-value information about locale.principal - The identity of the caller (principal authority requesting the change).name - Name of the delegated list to search for.
CSSAuthorizationException - If the principal is not authorized to perform this operation.
CSSException - Any other abnormality.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||