org.springframework.security.web.authentication
Class WebAuthenticationDetails

java.lang.Object
  extended by org.springframework.security.web.authentication.WebAuthenticationDetails
All Implemented Interfaces:
java.io.Serializable, SessionIdentifierAware
Direct Known Subclasses:
PreAuthenticatedGrantedAuthoritiesWebAuthenticationDetails

public class WebAuthenticationDetails
extends java.lang.Object
implements SessionIdentifierAware, java.io.Serializable

A holder of selected HTTP details related to a web authentication request.

See Also:
Serialized Form

Constructor Summary
WebAuthenticationDetails(javax.servlet.http.HttpServletRequest request)
          Records the remote address and will also set the session Id if a session already exists (it won't create one).
 
Method Summary
protected  void doPopulateAdditionalInformation(javax.servlet.http.HttpServletRequest request)
          Provided so that subclasses can populate additional information.
 boolean equals(java.lang.Object obj)
           
 java.lang.String getRemoteAddress()
          Indicates the TCP/IP address the authentication request was received from.
 java.lang.String getSessionId()
          Indicates the HttpSession id the authentication request was received from.
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WebAuthenticationDetails

public WebAuthenticationDetails(javax.servlet.http.HttpServletRequest request)
Records the remote address and will also set the session Id if a session already exists (it won't create one).

Parameters:
request - that the authentication request was received from
Method Detail

doPopulateAdditionalInformation

protected void doPopulateAdditionalInformation(javax.servlet.http.HttpServletRequest request)
Provided so that subclasses can populate additional information.

Parameters:
request - that the authentication request was received from

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

getRemoteAddress

public java.lang.String getRemoteAddress()
Indicates the TCP/IP address the authentication request was received from.

Returns:
the address

getSessionId

public java.lang.String getSessionId()
Indicates the HttpSession id the authentication request was received from.

Specified by:
getSessionId in interface SessionIdentifierAware
Returns:
the session ID

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object