com.iplanet.sso
Interface SSOToken

public interface SSOToken

The SSOToken class represents a "single sign on"(SSO) token. It contains SSO token-related information such as authentication method used for authentication, authentication level of the authentication method, host name of the client that sent the request (browser). It also contains session-related information such as maximum session time, maximum session idle time and session idle time.

Method Summary

void	addSSOTokenListener(SSOTokenListener listener) Adds an SSO token listener for the token change events.
java.lang.String	encodeURL(java.lang.String url) Returns the encoded URL , rewritten to include the session id.
int	getAuthLevel() Returns the authentication level of the authentication method used for authentication.
java.lang.String	getAuthType() Returns the authentication method used for authentication.
java.lang.String	getHostName() Returns the host name of the client (browser) that sent the request.
long	getIdleTime() Returns the session idle time in seconds.
java.net.InetAddress	getIPAddress() Returns the IP Address of the client (browser) that sent the request.
long	getMaxIdleTime() Returns the maximum session idle time in minutes.
long	getMaxSessionTime() Returns the maximum session time in minutes.
java.security.Principal	getPrincipal() Returns the principal name of the SSOToken.
java.lang.String	getProperty(java.lang.String name) Gets the property stored in this token.
long	getTimeLeft() Returns the time left on the session based on max session time
SSOTokenID	getTokenID() Returns SSOTokenID object
void	setProperty(java.lang.String name, java.lang.String value) Sets a property for this token.

Method Detail

getPrincipal

public java.security.Principal getPrincipal()
                                     throws SSOException

Returns the principal name of the SSOToken.

Parameters:

None -

Returns:

The principal name

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the principal

getAuthType

public java.lang.String getAuthType()
                             throws SSOException

Returns the authentication method used for authentication.

Parameters:

None -

Returns:

The authentication method

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the authentication method

getAuthLevel

public int getAuthLevel()
                 throws SSOException

Returns the authentication level of the authentication method used for authentication.

Parameters:

None -

Returns:

The authentication level

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the authentication level

getIPAddress

public java.net.InetAddress getIPAddress()
                                  throws SSOException

Returns the IP Address of the client (browser) that sent the request.

Parameters:

None -

Returns:

The IP Address of the client

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the IP Address of the client

getHostName

public java.lang.String getHostName()
                             throws SSOException

Returns the host name of the client (browser) that sent the request.

Parameters:

None -

Returns:

The host name of the client

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the host name of the client

getTimeLeft

public long getTimeLeft()
                 throws SSOException

Returns the time left on the session based on max session time

Parameters:

None -

Returns:

The time left on the session

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the maximum session time

getMaxSessionTime

public long getMaxSessionTime()
                       throws SSOException

Returns the maximum session time in minutes.

Parameters:

None -

Returns:

The maximum session time

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the maximum session time

getIdleTime

public long getIdleTime()
                 throws SSOException

Returns the session idle time in seconds.

Parameters:

None -

Returns:

The session idle time

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the session idle time

getMaxIdleTime

public long getMaxIdleTime()
                    throws SSOException

Returns the maximum session idle time in minutes.

Parameters:

None -

Returns:

The maximum session idle time

Throws:

An - SSOException is thrown if the SSOToken is not valid or if there are errors in getting the maximum idle time

getTokenID

public SSOTokenID getTokenID()

Returns SSOTokenID object

Parameters:

None -

Returns:

SSOTokenID

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws SSOException

Sets a property for this token.

Parameters:

name - The property name

value - The property value

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in setting the property name and value

getProperty

public java.lang.String getProperty(java.lang.String name)
                             throws SSOException

Gets the property stored in this token.

Parameters:

name - The property name

Returns:

The property value in string format

Throws:

an - SSOException if the SSOToken is not valid or if there are errors in getting the property value

addSSOTokenListener

public void addSSOTokenListener(SSOTokenListener listener)
                         throws SSOException

Adds an SSO token listener for the token change events.

Parameters:

listener - A reference to an SSOTokenListener object.

Returns:

None

Throws:

an - SSOException if the token is not valid or if there are errors in setting the SSO token listener

encodeURL

public java.lang.String encodeURL(java.lang.String url)
                           throws SSOException

Returns the encoded URL , rewritten to include the session id.

Parameters:

url - , the URL to be encoded

Returns:

the encoded URL if cookies are not supported or the url if cookies are supported. Note: We should not use this method for encoding the image URLs