com.hyperion.css.common
Interface CSSPrincipalIF

All Superinterfaces:

java.io.Serializable

public interface CSSPrincipalIF
extends java.io.Serializable

The Principal is used to specify the entity that is interacting with the CSS System. The entity represents a user and it is an argument to the Provisioning and associated methods in the API. The functionality provided in this interface is for CSS use only. The calling program should not invoke any methods here. The behavior of these methods is not guaranteed for calling applications.

Since:

v3.0

Author:

gkhanna

Method Summary

java.util.Set<java.lang.String>	getHUBRoles() For Internal Use only.
java.lang.String	getIdentifier() Returns the identifier of the user
java.lang.String	getIdentity() Returns the identity of the user or group.
java.lang.String	getName() Gets the user name.
java.lang.String	getPrimaryGroupID() This will return PrimaryGroupID for Active Directory user, which can be used to determine the PrimaryGroup for this user.
java.util.Map	getPrincipalInfo() Gets the user information specific to the provider.

Method Detail

getIdentity

java.lang.String getIdentity()

Returns the identity of the user or group.

Returns:

the identity of the user

getIdentifier

java.lang.String getIdentifier()

Returns the identifier of the user

getName

java.lang.String getName()

Gets the user name.

Returns:

the login name of the user

getPrincipalInfo

java.util.Map getPrincipalInfo()

Gets the user information specific to the provider.

The following information can be retrieved from this map:

1. This map should also contain the key CSSAPIIF.PROVIDER_NAMEand the value should be the name of the provider where the user entry resides as specified in the configuration.
2. This map also contains the key CSSAPIIF.TOKEN and the value is the token for this principal.

Returns:

Map

getHUBRoles

java.util.Set<java.lang.String> getHUBRoles()

For Internal Use only.

getPrimaryGroupID

java.lang.String getPrimaryGroupID()

This will return PrimaryGroupID for Active Directory user, which can be used to determine the PrimaryGroup for this user.

Returns: