oracle.ifs.common

Class CredentialManagerUser

java.lang.Object

oracle.ifs.common.CredentialManagerUser

All Implemented Interfaces:

Serializable

public class CredentialManagerUser
extends Object
implements Serializable

A CredentialManagerUser encapsulates the information that describes a user that exists in the user's CredentialManager.

The data encapsulated by a CredentialManagerUser must be serializable.

Version:

1.0

Author:

Dave Long

See Also:

Serialized Form

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISTINGUISHEDNAME_ATTRIBUTE The name of the attribute which references the Credential manager distinguished name for which this user is associated.
static String	EMAILADDRESS_ATTRIBUTE The name of the attribute which references the email address for which this user is associated.
static String	ENABLED_ATTRIBUTE The name of the attribute which references the indication as to whether this user is enabled, meaning that the user can authenticate with the Credential manager.
static String	FIRSTNAME_ATTRIBUTE The name of the attribute which references the First (given) name for which this user is associated.
static String	LANGUAGE_ATTRIBUTE The name of the attribute which references the preferred language for which this user is associated.
static String	LASTNAME_ATTRIBUTE The name of the attribute which references the Last name (surname) for which this user is associated.
protected Hashtable	m_Attributes Table of the attributes known for this user.
protected LibrarySessionInterface	m_Session Session context.
static String	NAME_ATTRIBUTE The name of the attribute which references the Credential manager Name for which this user is associated.
static String	REALM_ATTRIBUTE The name of the attribute which references the Credential manager realm for which this user is associated.
static String	TIMEZONE_ATTRIBUTE The name of the attribute which references the preferred timezone for which this user is associated.

Constructor Summary

Constructors

Constructor and Description
CredentialManagerUser(LibrarySessionInterface session) Construct a CredentialManagerUser

Method Summary

Modifier and Type	Method and Description
AttributeValue	getAttribute(String attrKey) Return an AttributeValue object that holds the value of the requested attribute.
AttributeValue[]	getAttributes() Return array of all Attribute values that were set for this new instance.
protected Boolean	getBooleanAttribute(String attrKey) Return boolean value of an attribute value set with setAttribute.
String	getDistinguishedName() Returns the Credential manager distinguished name for which this user is associated.
String	getEmailAddress() Returns the email address for which this user is associated.
String	getFirstName() Returns the First (given) name for which this user is associated.
String	getLanguage() Returns the preferred language for which this user is associated.
String	getLastName() Returns the Last name (surname) for which this user is associated.
String	getName() Returns the Credential manager Name for which this user is associated.
String	getRealm() Returns the Credential manager realm for which this user is associated.
LibrarySessionInterface	getSession() Get the session used in constructing this instance.
protected String	getStringAttribute(String attrKey) Return String value of an attribute value set with setAttribute.
String	getTimezone() Returns the preferred timezone for which this user is associated.
boolean	isEnabled() Returns the indication as to whether this user is enabled, meaning that the user can authenticate with the Credential manager.
void	removeAttribute(String attrKey) Removes an attribute setting for the new instance.
void	setAttribute(AttributeValue value) Set an attribute for the new instance.
void	setAttribute(String attrKey, AttributeValue value) Set an attribute for the new instance.
void	setAttributes(AttributeValue[] values) Set a number of attributes for the new instance.
void	setDistinguishedName(String value) Sets the Credential manager distinguished name for which this user is associated.
void	setEmailAddress(String value) Sets the email address for which this user is associated.
void	setEnabled(boolean value) Sets the indication as to whether this user is enabled, meaning that the user can authenticate with the Credential manager.
void	setFirstName(String value) Sets the First (given) name for which this user is associated.
void	setLanguage(String value) Sets the preferred language for which this user is associated.
void	setLastName(String value) Sets the Last name (surname) for which this user is associated.
void	setName(String value) Sets the Credential manager Name for which this user is associated.
void	setRealm(String value) Sets the Credential manager realm for which this user is associated.
void	setSession(LibrarySessionInterface session) Set or reset the session used in constructing this instance.
void	setTimezone(String value) Sets the preferred timezone for which this user is associated.

Methods inherited from class java.lang.Object

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

Field Detail

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the attribute which references the Credential manager Name for which this user is associated.

See Also:

Constant Field Values

(Published)

DISTINGUISHEDNAME_ATTRIBUTE

public static final String DISTINGUISHEDNAME_ATTRIBUTE

The name of the attribute which references the Credential manager distinguished name for which this user is associated.

See Also:

Constant Field Values

(Published)

REALM_ATTRIBUTE

public static final String REALM_ATTRIBUTE

The name of the attribute which references the Credential manager realm for which this user is associated.

See Also:

Constant Field Values

(Published)

FIRSTNAME_ATTRIBUTE

public static final String FIRSTNAME_ATTRIBUTE

The name of the attribute which references the First (given) name for which this user is associated.

See Also:

Constant Field Values

(Published)

LASTNAME_ATTRIBUTE

public static final String LASTNAME_ATTRIBUTE

The name of the attribute which references the Last name (surname) for which this user is associated.

See Also:

Constant Field Values

(Published)

EMAILADDRESS_ATTRIBUTE

public static final String EMAILADDRESS_ATTRIBUTE

The name of the attribute which references the email address for which this user is associated.

See Also:

Constant Field Values

(Published)

LANGUAGE_ATTRIBUTE

public static final String LANGUAGE_ATTRIBUTE

The name of the attribute which references the preferred language for which this user is associated.

See Also:

Constant Field Values

(Published)

TIMEZONE_ATTRIBUTE

public static final String TIMEZONE_ATTRIBUTE

The name of the attribute which references the preferred timezone for which this user is associated.

See Also:

Constant Field Values

(Published)

ENABLED_ATTRIBUTE

public static final String ENABLED_ATTRIBUTE

The name of the attribute which references the indication as to whether this user is enabled, meaning that the user can authenticate with the Credential manager.

See Also:

Constant Field Values

(Published)

m_Attributes

protected Hashtable m_Attributes

Table of the attributes known for this user.

(Unpublished)

m_Session

protected transient LibrarySessionInterface m_Session

Session context.

(Unpublished)

Constructor Detail

CredentialManagerUser

public CredentialManagerUser(LibrarySessionInterface session)
                      throws IfsException

Construct a CredentialManagerUser

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

(Published)

Method Detail

getName

public String getName()
               throws IfsException

Returns the Credential manager Name for which this user is associated.

Returns:

the Name for this user.

Throws:

IfsException - other: if the operation fails.

getDistinguishedName

public String getDistinguishedName()
                            throws IfsException

Returns the Credential manager distinguished name for which this user is associated.

Returns:

the distinguished name for this user.

Throws:

IfsException - other: if the operation fails.

getRealm

public String getRealm()
                throws IfsException

Returns the Credential manager realm for which this user is associated.

Returns:

the realm for this user.

Throws:

IfsException - other: if the operation fails.

getFirstName

public String getFirstName()
                    throws IfsException

Returns the First (given) name for which this user is associated.

Returns:

the first name for this user.

Throws:

IfsException - other: if the operation fails.

getLastName

public String getLastName()
                   throws IfsException

Returns the Last name (surname) for which this user is associated.

Returns:

the last name for this user.

Throws:

IfsException - other: if the operation fails.

getEmailAddress

public String getEmailAddress()
                       throws IfsException

Returns the email address for which this user is associated.

Returns:

the email address for this user.

Throws:

IfsException - other: if the operation fails.

getLanguage

public String getLanguage()
                   throws IfsException

Returns the preferred language for which this user is associated.

Returns:

the preferred language for this user.

Throws:

IfsException - other: if the operation fails.

getTimezone

public String getTimezone()
                   throws IfsException

Returns the preferred timezone for which this user is associated.

Returns:

the preferred timezone for this user.

Throws:

IfsException - other: if the operation fails.

isEnabled

public boolean isEnabled()
                  throws IfsException

Returns the indication as to whether this user is enabled, meaning that the user can authenticate with the Credential manager.

Returns:

indication of this user being enabled

Throws:

IfsException - other: if the operation fails.

setName

public void setName(String value)
             throws IfsException

Sets the Credential manager Name for which this user is associated.

Parameters:

value - the Name for this user.

Throws:

IfsException - other: if the operation fails.

setDistinguishedName

public void setDistinguishedName(String value)
                          throws IfsException

Sets the Credential manager distinguished name for which this user is associated.

Parameters:

value - the distinguished name for this user.

Throws:

IfsException - other: if the operation fails.

setRealm

public void setRealm(String value)
              throws IfsException

Sets the Credential manager realm for which this user is associated.

Parameters:

value - the realm for this user.

Throws:

IfsException - other: if the operation fails.

setFirstName

public void setFirstName(String value)
                  throws IfsException

Sets the First (given) name for which this user is associated.

Parameters:

value - the first name for this user.

Throws:

IfsException - other: if the operation fails.

setLastName

public void setLastName(String value)
                 throws IfsException

Sets the Last name (surname) for which this user is associated.

Parameters:

value - the last name for this user.

Throws:

IfsException - other: if the operation fails.

setEmailAddress

public void setEmailAddress(String value)
                     throws IfsException

Sets the email address for which this user is associated.

Parameters:

value - the email address for this user.

Throws:

IfsException - other: if the operation fails.

setLanguage

public void setLanguage(String value)
                 throws IfsException

Sets the preferred language for which this user is associated.

Parameters:

value - the preferred language for this user.

Throws:

IfsException - other: if the operation fails.

setTimezone

public void setTimezone(String value)
                 throws IfsException

Sets the preferred timezone for which this user is associated.

Parameters:

value - the preferred timezone for this user.

Throws:

IfsException - other: if the operation fails.

setEnabled

public void setEnabled(boolean value)
                throws IfsException

Sets the indication as to whether this user is enabled, meaning that the user can authenticate with the Credential manager.

Parameters:

value - indication of this user being enabled

Throws:

IfsException - other: if the operation fails.

getSession

public LibrarySessionInterface getSession()

Get the session used in constructing this instance.

Returns:

the session associated with this instance

Throws:

IfsException - if operation fails.

(Published)

setSession

public void setSession(LibrarySessionInterface session)
                throws IfsException

Set or reset the session used in constructing this instance. This is only used in two circumstances:

• This instance was originally constructed with a null session, and now a session context is known
• The session context used at construction time needs to be switched to a different session context, typically to switch the context from a server-side to a bean-side context, or vice versa.

Parameters:

session - the new session context

Throws:

IfsException - if operation fails.

(Published)

setAttribute

public void setAttribute(String attrKey,
                         AttributeValue value)
                  throws IfsException

Set an attribute for the new instance.

Each invocation of this method results in another attribute setting being added to an internal map.

Parameters:

attrKey - the attribute key

value - the attribute value.

Throws:

IfsException - if operation fails.

(Published)

setAttribute

public void setAttribute(AttributeValue value)
                  throws IfsException

Set an attribute for the new instance. Each invocation of this method results in another attribute setting being added to an internal map.

Parameters:

value - the attribute value.

Throws:

IfsException - 10415: if name not specified in the value

IfsException - other: if the operation fails

(Unpublished)

setAttributes

public void setAttributes(AttributeValue[] values)
                   throws IfsException

Set a number of attributes for the new instance. The names of the attributes must be contained in each attribute value.

Parameters:

values - the attribute values.

Throws:

IfsException - if operation fails.

(Published)

getAttribute

public AttributeValue getAttribute(String attrKey)
                            throws IfsException

Return an AttributeValue object that holds the value of the requested attribute.

Parameters:

attrKey - the name of the AttributeValue to be returned

Returns:

the corresponding AttributeValue

Throws:

IfsException - if operation fails.

(Published)

getAttributes

public AttributeValue[] getAttributes()
                               throws IfsException

Return array of all Attribute values that were set for this new instance. The name of the attribute is set in the returned AttributeValues. The returned AttributeValue names are locked.

Returns:

AttributeValue array of the currently set attributes

Throws:

IfsException - if operation fails.

(Published)

getStringAttribute

protected String getStringAttribute(String attrKey)

Return String value of an attribute value set with setAttribute. Return null if the specified attribute name was not specified.

Parameters:

attrKey - the name of the Attribute

Returns:

the corresponding String value

(Unpublished)

getBooleanAttribute

protected Boolean getBooleanAttribute(String attrKey)

Return boolean value of an attribute value set with setAttribute. Return false if the specified attribute name was not specified or is not convertible to a boolean.

Parameters:

attrKey - the name of the Attribute

Returns:

the corresponding boolean value

(Unpublished)

removeAttribute

public void removeAttribute(String attrKey)
                     throws IfsException

Removes an attribute setting for the new instance.

Parameters:

attrKey - The name of the Attribute to be removed.

Throws:

IfsException - if operation fails.

(Published)