org.jboss.security.idm
Class LoginContext

java.lang.Object
  extended by org.jboss.security.idm.LoginContext
All Implemented Interfaces:
java.io.Serializable

public final class LoginContext
extends java.lang.Object
implements java.io.Serializable

LoginContext encapsulates environment information to be passed to Single Sign On notifications.

Examples of such notifications are notifications that the LoginProvider receives to process an automatic login being performed by the SSO Engine in response to processing a valid assertion from a partner site in the Federation

Author:
Sohil Shah - sohil.shah@jboss.com - Nov 15, 2006
See Also:
Serialized Form

Field Summary
static java.lang.String HTTP_REQUEST
          name of the attribute for storing http request object
static java.lang.String HTTP_RESPONSE
          name of the attribute for storing http response object
static java.lang.String SSO_USER
          name of the attribute for storing the SSOUser object representing the user being authenticated by the SSO Engine
 
Constructor Summary
LoginContext()
          Initializer
 
Method Summary
 java.lang.Object getAttribute(java.lang.String name)
          Returns value corresponding to the specified attribute name
 java.lang.String[] getAttributeNames()
          Returns an array of Strings consisting of all keys/names stored in the context
 void setAttribute(java.lang.String name, java.lang.Object value)
          Sets a specified value corresponding to the specified name in the context
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

HTTP_REQUEST

public static final java.lang.String HTTP_REQUEST
name of the attribute for storing http request object

See Also:
Constant Field Values

HTTP_RESPONSE

public static final java.lang.String HTTP_RESPONSE
name of the attribute for storing http response object

See Also:
Constant Field Values

SSO_USER

public static final java.lang.String SSO_USER
name of the attribute for storing the SSOUser object representing the user being authenticated by the SSO Engine

See Also:
Constant Field Values
Constructor Detail

LoginContext

public LoginContext()
Initializer

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
Returns value corresponding to the specified attribute name

Parameters:
name -
Returns:

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)
Sets a specified value corresponding to the specified name in the context

Parameters:
name -
value -

getAttributeNames

public java.lang.String[] getAttributeNames()
Returns an array of Strings consisting of all keys/names stored in the context

Returns: