com.plumtree.portaluiinfrastructure.sso
Class SSOLoginInfo

java.lang.Object
  com.plumtree.portaluiinfrastructure.sso.SSOLoginInfo

public class SSOLoginInfo
extends java.lang.Object

Simple class which contains a username and password.

Author:

Mike Jahr

Constructor Summary

SSOLoginInfo(java.lang.String sPrefixAndName)
Constructs a SSOLoginInfo with the given username and an empty password.

SSOLoginInfo(java.lang.String sPrefixAndName, java.lang.String sPassword)
Constructs a SSOLoginInfo with the given information.

SSOLoginInfo(java.lang.String sPrefix, java.lang.String sName, java.lang.String sPassword)
Constructs a SSOLoginInfo with the given information.

Method Summary

java.lang.String	GetPassword() Returns the user's password.
java.lang.String	GetPrefixAndName() Returns the prefix and name of this user in the form "prefix\\username".
void	SetPassword(java.lang.String sPassword) Sets the password;
void	SetPrefixAndName(java.lang.String sName) Sets the username in the form "prefix\\username".

Methods inherited from class java.lang.Object

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

Constructor Detail

SSOLoginInfo

public SSOLoginInfo(java.lang.String sPrefix,
                    java.lang.String sName,
                    java.lang.String sPassword)

Constructs a SSOLoginInfo with the given information. The given prefix and username are conca If no password is available, null should be passed, or the simplest constructor can be used.

Parameters:

sPrefix - the user prefix

sName - the username without the prefix

sPassword - the password of the user

SSOLoginInfo

public SSOLoginInfo(java.lang.String sPrefixAndName,
                    java.lang.String sPassword)

Constructs a SSOLoginInfo with the given information. If the prefix of the user is unavailable, sPrefixAndName should contain only the username without a "\\"; in this case the default prefix from x_config.xml will be added. If no password is available, null should be passed, or the simplest constructor can be used.

Parameters:

sPrefixAndName - the username in the form "prefix\\username"

sPassword - the password of the user

SSOLoginInfo

public SSOLoginInfo(java.lang.String sPrefixAndName)

Constructs a SSOLoginInfo with the given username and an empty password. Identical to SSOLoginInfo(sPrefixAndName, null).

Parameters:

sPrefixAndName - the username in the form "prefix\\username"

Method Detail

GetPassword

public java.lang.String GetPassword()

Returns the user's password. Only necessary if it is to be passed to portlets in basic auth headers.

Returns:

the password

GetPrefixAndName

public java.lang.String GetPrefixAndName()

Returns the prefix and name of this user in the form "prefix\\username".

Returns:

the qualified username

SetPassword

public void SetPassword(java.lang.String sPassword)

Sets the password;

Parameters:

sPassword - the user's password

SetPrefixAndName

public void SetPrefixAndName(java.lang.String sName)

Sets the username in the form "prefix\\username". If the prefix of the user is unavailable, sPrefixAndName should contain only the username without a "\\"; in this case the default prefix from x_config.xml will be added.

Parameters:

sName - the username in the form "prefix\\username"