com.ibm.itim.apps
Class UserAuthInfo

java.lang.Object
  |
  +--com.ibm.itim.apps.UserAuthInfo

All Implemented Interfaces:

java.io.Serializable

public class UserAuthInfo

extends java.lang.Object

implements java.io.Serializable

Contains a user's authentication information, including user id and credentials. This object should be stored by servlets on the user's Http session and passed between servlet and EJB's whenever they are called for the EJB's in the trusted domain to authenticate the user.

Version:

0

See Also:

Serialized Form

Field Summary

static java.lang.String	AUTH_PROPERTIES Constant for authentication properties
static java.lang.String	PROVIDER
static java.lang.String	REQUIRED_CREDENTIALS
static java.lang.String	USER_AUTH_INFO_KEY Constant representing key in HttpSession

Constructor Summary

UserAuthInfo()
Creates new UserAuthnfo.

UserAuthInfo(Credentials credentials)
Creates new UserAuthInfo.

UserAuthInfo(DistinguishedName dn)
To be removed - added to allow for a phased integration of the web-tier with the new API and of the API with the manager beans.

UserAuthInfo(java.lang.String userID)
Creates new UserAuthInfo.

UserAuthInfo(java.lang.String userID, java.lang.Object pwd, java.lang.String userDN)
Creates new UserAuthInfo.

UserAuthInfo(java.lang.String userID, java.lang.Object pwd, java.lang.String userDN, java.lang.String orgDN, java.lang.String buDN, java.lang.String personDN, int systemRoleCategory)
Creates new UserAuthInfo.

UserAuthInfo(java.lang.String userID, java.lang.String pwdClear)
Creates new UserAuthInfo.

UserAuthInfo(java.lang.String userID, java.lang.String tenantID, java.lang.Object pwd, java.lang.String userDN, java.lang.String tenantDN, java.lang.String orgDN, java.lang.String buDN, java.lang.String personDN, int systemRoleCategory)

Method Summary

java.lang.String	getBuDN() Gets the DN of the user's business unit dn.
Credentials	getCredentials() Returns the user's login credentials
java.lang.String	getOrgDN() Gets the DN of the user's organization.
java.lang.String	getPersonDN() Gets the DN of the user's person dn.
byte[]	getPwdHashed() Gets a hashed version of the password
int	getSystemRoleCategory() Gets the system role category of the user.
java.lang.String	getTenantDN() Gets the DN of the user's tenant.
java.lang.String	getTenantID() Gets the Tenant ID of the user.
java.lang.String	getUserDN() Gets the dn of the user
java.lang.String	getUserID() Gets the ID of the user
void	setPwdHashed(byte[] pwdHashed) Gets a hashed version of the password
void	setTenantDN(java.lang.String tenantDN)
void	setTenantID(java.lang.String tenantID)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_AUTH_INFO_KEY

public static final java.lang.String USER_AUTH_INFO_KEY

Constant representing key in HttpSession

See Also:

Constant Field Values

AUTH_PROPERTIES

public static final java.lang.String AUTH_PROPERTIES

Constant for authentication properties

See Also:

Constant Field Values

REQUIRED_CREDENTIALS

public static final java.lang.String REQUIRED_CREDENTIALS

See Also:

Constant Field Values

PROVIDER

public static final java.lang.String PROVIDER

See Also:

Constant Field Values

Constructor Detail

UserAuthInfo

public UserAuthInfo()
             throws com.ibm.itim.apps.exception.AppProcessingException

Creates new UserAuthnfo. This is needed as the object is to be written to the DB by Adhoc reporting.

UserAuthInfo

public UserAuthInfo(java.lang.String userID)
             throws com.ibm.itim.apps.exception.AppProcessingException

Creates new UserAuthInfo. Hashes the password for transport, storage, and later retrieval.

Parameters:

userID - The ID of the user accessing enrole

UserAuthInfo

public UserAuthInfo(Credentials credentials)
             throws com.ibm.itim.apps.exception.AppProcessingException

Creates new UserAuthInfo. Hashes the password for transport, storage, and later retrieval.

Parameters:

credentials - The Credentials of the user accessing enrole

UserAuthInfo

public UserAuthInfo(java.lang.String userID,
                    java.lang.String pwdClear)
             throws com.ibm.itim.apps.exception.AppProcessingException

Creates new UserAuthInfo. Hashes the password for transport, storage, and later retrieval.

Parameters:

userID - The ID of the user accessing enrole

pwdClear - The password in clear text.

UserAuthInfo

public UserAuthInfo(java.lang.String userID,
                    java.lang.Object pwd,
                    java.lang.String userDN)
             throws com.ibm.itim.apps.exception.AppProcessingException

Creates new UserAuthInfo. Hashes the password for transport, storage, and later retrieval.

Parameters:

userID - The ID of the user accessing enrole.

pwd - The digest of the password (hashed).

userDN - the dn of the user accessing enrole.

UserAuthInfo

public UserAuthInfo(java.lang.String userID,
                    java.lang.Object pwd,
                    java.lang.String userDN,
                    java.lang.String orgDN,
                    java.lang.String buDN,
                    java.lang.String personDN,
                    int systemRoleCategory)
             throws com.ibm.itim.apps.exception.AppProcessingException

Creates new UserAuthInfo. Creates key-value pair for Client Certificate

Parameters:

userID - User id (pass in null if not known and this will be found from the cert)

pwd - The digest of the password (hashed).

userDN - the dn of the user accessing enrole

UserAuthInfo

public UserAuthInfo(java.lang.String userID,
                    java.lang.String tenantID,
                    java.lang.Object pwd,
                    java.lang.String userDN,
                    java.lang.String tenantDN,
                    java.lang.String orgDN,
                    java.lang.String buDN,
                    java.lang.String personDN,
                    int systemRoleCategory)
             throws com.ibm.itim.apps.exception.AppProcessingException

UserAuthInfo

public UserAuthInfo(DistinguishedName dn)
             throws com.ibm.itim.apps.exception.AppProcessingException

To be removed - added to allow for a phased integration of the web-tier with the new API and of the API with the manager beans.

Method Detail

getCredentials

public Credentials getCredentials()

Returns the user's login credentials

Returns:

The hashed password

getUserID

public java.lang.String getUserID()

Gets the ID of the user

Returns:

The ID of the user

getPwdHashed

public byte[] getPwdHashed()

Gets a hashed version of the password

Returns:

hashed version of the password

setPwdHashed

public void setPwdHashed(byte[] pwdHashed)

Gets a hashed version of the password

Returns:

hashed version of the password

getUserDN

public java.lang.String getUserDN()

Gets the dn of the user

Returns:

The ID of the user

getTenantID

public java.lang.String getTenantID()

Gets the Tenant ID of the user.

Returns:

The ID of the user's tenant.

getTenantDN

public java.lang.String getTenantDN()

Gets the DN of the user's tenant.

Returns:

The DN of the user's tenant

getOrgDN

public java.lang.String getOrgDN()

Gets the DN of the user's organization.

Returns:

The DN of the user's organization

getBuDN

public java.lang.String getBuDN()

Gets the DN of the user's business unit dn.

Returns:

The DN of the user's business unit dn

getPersonDN

public java.lang.String getPersonDN()

Gets the DN of the user's person dn.

Returns:

The DN of the user's person dn

getSystemRoleCategory

public int getSystemRoleCategory()

Gets the system role category of the user.

Returns:

The system role category of the user

setTenantDN

public void setTenantDN(java.lang.String tenantDN)

setTenantID

public void setTenantID(java.lang.String tenantID)