com.hyperion.css.common
Interface CSSNativeUserIF

All Superinterfaces:

com.hyperion.css.cache.CacheNodeIF, CSSUserIF, java.io.Serializable

public interface CSSNativeUserIF
extends CSSUserIF

This interface provides the functionality for creating and managing users in the Hyperion Shared Services User Directory. An instance has the identity of the caller as well as the locale information available to it.

Please note that the settings would take effect once the associated API in the CSSUserProvisioningAPIIF is invoked. Provisioning functionality is not provided here since that is common across providers.

Since:

CSS v3.0 Feb 24, 2005

Author:

gkhanna

See Also:

CSSUserIF

Field Summary

Fields inherited from interface com.hyperion.css.common.CSSUserIF

LOGIN_NAME

Method Summary

void	assignAccess(java.lang.String identity, CSSPermissionIF permission) Provides access control on this user instance.
java.lang.String	getPassword() Gets the password.
java.lang.String[]	getSetGroupList() For Internal Use Only
void	removeGroupsList(CSSPrincipalIF principal, java.lang.String[] groups) Removes the user from parent groups.
void	setDescription(java.lang.String name)
void	setEmailAddress(java.lang.String email)
void	setFirstName(java.lang.String name)
void	setGroupsList(java.lang.String[] groups, boolean add) Sets the groups that this user belongs to.
void	setLastName(java.lang.String name)
void	setLoginName(java.lang.String name) Sets the login name.
void	setPassword(java.lang.String password)
void	setUserInfo(java.util.Map info)

Methods inherited from interface com.hyperion.css.common.CSSUserIF

getAllRolesList, getAssertionToken, getCssSession, getDescription, getDisplayName, getEmailAddress, getFirstName, getGroupsList, getGroupsList, getGroupsList, getGroupsTree, getIdentity, getJPSRolesList, getJpsSubject, getLastName, getLoginName, getPrimaryGroupID, getPrincipal, getProvisionedApplications, getRolesList, getToken, getUserGuid, getUserInfo, isActive, setCssSession, setDisplayName, setJpsSubject, setToken, setUserGuid, setUserInfo

Methods inherited from interface com.hyperion.css.cache.CacheNodeIF

clear, getIdentifier, getMembers, getName, getParentGroups, getPrimaryGroupToken, getProviderName, isGroup

Method Detail

setLoginName

void setLoginName(java.lang.String name)

Sets the login name.

Parameters:

name -

setEmailAddress

void setEmailAddress(java.lang.String email)

setFirstName

void setFirstName(java.lang.String name)

setLastName

void setLastName(java.lang.String name)

setDescription

void setDescription(java.lang.String name)

setPassword

void setPassword(java.lang.String password)

setGroupsList

void setGroupsList(java.lang.String[] groups,
                   boolean add)
                   throws CSSCommunicationException,
                          CSSException

Sets the groups that this user belongs to. The default action is to add the groups specified to the existing group membership for this user. Please note that there would be no duplicate group membership persisted even if it is passed in the groups argument. Please also note that the updates only take effect once the appropriate method on the CSSDirectoryManagementAPIIF class is invoked. For instance: CSSDirectoryManagementAPIIF.updateNativeUser(Map, CSSPrincipalIF, CSSNativeUserIF)

Parameters:

groups - If empty array, then this removes all group memberships, irrespective of the 'add' flag.

add - If true then the groups are added to the existing groups. Otherwise, the existing groups are replaced.

Throws:

CSSCommunicationException

CSSException

getPassword

java.lang.String getPassword()

Gets the password. Returns an empty String if there is no password included in the user

Returns:

String

getSetGroupList

java.lang.String[] getSetGroupList()

For Internal Use Only

setUserInfo

void setUserInfo(java.util.Map info)

assignAccess

void assignAccess(java.lang.String identity,
                  CSSPermissionIF permission)

Provides access control on this user instance. CSS permissions are hierarchical, therefore only one permission instance can specify the rights.

The ACL specification is not complete. This method signature is subject to change.

Parameters:

identity -

permission -

removeGroupsList

void removeGroupsList(CSSPrincipalIF principal,
                      java.lang.String[] groups)
                      throws CSSIllegalArgumentException,
                             CSSInvalidIdentityException,
                             CSSInvalidGroupException,
                             CSSOperationNotSupportedException,
                             CSSException

Removes the user from parent groups.

This removes the user from parent group identities. The user to be removed is the one on which call is invoked. Parent group identities are passed as argument. The method removes the users which are directly associated with the parent groups. If null value or empty string array is passed, the method returns nothing and stops further operations. External identities should not be passed. If so then it logs warning and continues with rest of the identities. Throws CSSOperationNotSupportedException if WORLD group identity is passed.

Parameters:

principal - - the logged in user principal.

groups - - the array of parent group identities from which this user is to be removed.

Throws:

- - CSSIllegalArgumentException if principal is null CSSInvalidIdentityException for invalid identity string. CSSInvalidGroupException if identity doesn't exist. CSSOperationNotSupportedException - If world group Identity is passed. CSSException - catches if there is any abnormality and ignores.

CSSIllegalArgumentException

CSSInvalidIdentityException

CSSInvalidGroupException

CSSOperationNotSupportedException

CSSException