Skip navigation links

com.essbase.eas.client.intf
Interface Login

All Known Implementing Classes:

LoginImpl

public interface Login

This interface defines the "standard" information about a login "session" that can be stored by the console. This interface should be used in the following manner:

An application should have a class that implements this interface. When the application starts it will create a single instance of the class, and register that instance with the com.hyperion.olapconsole.manager.LoginManager class.

Any other objects/components that need access to login information call the LoginManager and request the instance of the object that implements the Login interface.

Currently, the "standard" information tracked by an implementor of the Login interface is the user name and password. Any additional information will be stored in the supplemental properties structure.

Notes:

07/21/2000, hcox: We need to determine whether we should throw exceptions when attempting to store duplicate supplemental properties.

Version:

1.00, 07/21/2000

Author:

Hank Cox

See Also:

com.hyperion.olapconsole.manager.LoginManager

Method Summary

java.lang.String	getPassword() retrieves the password for this login session.
java.lang.Object	getProperty(java.lang.String key) retrieves a supplemental property for this login session.
java.lang.String	getServer() retrieves the server for this login session.
java.lang.String	getUserName() retrieves the user name for this login session.
void	releaseLoginInformation() clears all stored properties.
void	setPassword(java.lang.String value) sets the password for this login session.
void	setProperty(java.lang.String key, java.lang.Object value) sets a supplemental property for this login session.
void	setServer(java.lang.String value) sets the server for this login session.
void	setUserName(java.lang.String value) sets the user name for this login session.

Method Detail

getUserName

java.lang.String getUserName()

retrieves the user name for this login session.

Returns:

a String object representing the user name. If a name has never been set, the return value can be an empty string.

setUserName

void setUserName(java.lang.String value)

sets the user name for this login session.

Parameters:

value - - a String object containing the user name for this session.

getPassword

java.lang.String getPassword()

retrieves the password for this login session.

Returns:

a String object representing the password.

setPassword

void setPassword(java.lang.String value)

sets the password for this login session.

Parameters:

value - - a String object containing the password for this session.

getServer

java.lang.String getServer()

retrieves the server for this login session.

Returns:

a String object representing the server.

setServer

void setServer(java.lang.String value)

sets the server for this login session.

Parameters:

value - - a String object containing the server for this session.

getProperty

java.lang.Object getProperty(java.lang.String key)

retrieves a supplemental property for this login session.

Parameters:

tag - - a String object representing the label for the property that is desired.

Returns:

the object desired. If no object has been saved in this login session with the requested tag, then the return value will be null.

setProperty

void setProperty(java.lang.String key,
                 java.lang.Object value)

sets a supplemental property for this login session.

Parameters:

tag - - a String object representing the tag for the property.

value - - the object to be stored under the tag.

releaseLoginInformation

void releaseLoginInformation()

clears all stored properties.

Skip navigation links