org.jets3t.servlets.gatekeeper

Class ClientInformation

java.lang.Object

org.jets3t.servlets.gatekeeper.ClientInformation

public class ClientInformation
extends java.lang.Object

Stores information about the HTTP client that submitted a request to the Gatekeeper.

The information available about a client will depend on the server and client configuration, such as whether the client is identified with an existing HttpSession or Principal. It must be assumed that much of the information stored in this class will have a null value in many cases.

All information in this class is sourced from equivalent methods in HttpServletRequest.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.servlet.http.HttpServletRequest	httpServletRequest
private java.lang.String	remoteAddress
private java.lang.String	remoteHost
private int	remotePort
private java.lang.String	remoteUser
private javax.servlet.http.HttpSession	session
private java.lang.String	userAgent
private java.security.Principal	userPrincipal

Constructor Summary

Constructors

Constructor and Description
ClientInformation(java.lang.String remoteAddress, java.lang.String remoteHost, java.lang.String remoteUser, int remotePort, javax.servlet.http.HttpSession session, java.security.Principal userPrincipal, java.lang.String userAgent, javax.servlet.http.HttpServletRequest httpServletRequest)

Method Summary

Modifier and Type	Method and Description
javax.servlet.http.HttpServletRequest	getHttpServletRequest()
java.lang.String	getRemoteAddress()
java.lang.String	getRemoteHost()
int	getRemotePort()
java.lang.String	getRemoteUser()
javax.servlet.http.HttpSession	getSession()
java.lang.String	getUserAgent()
java.security.Principal	getUserPrincipal()

Methods inherited from class java.lang.Object

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

Field Detail

remoteAddress

private java.lang.String remoteAddress

remoteHost

private java.lang.String remoteHost

remoteUser

private java.lang.String remoteUser

remotePort

private int remotePort

session

private javax.servlet.http.HttpSession session

userPrincipal

private java.security.Principal userPrincipal

userAgent

private java.lang.String userAgent

httpServletRequest

private javax.servlet.http.HttpServletRequest httpServletRequest

Constructor Detail

ClientInformation

public ClientInformation(java.lang.String remoteAddress,
                         java.lang.String remoteHost,
                         java.lang.String remoteUser,
                         int remotePort,
                         javax.servlet.http.HttpSession session,
                         java.security.Principal userPrincipal,
                         java.lang.String userAgent,
                         javax.servlet.http.HttpServletRequest httpServletRequest)

Method Detail

getRemoteAddress

public java.lang.String getRemoteAddress()

getRemoteHost

public java.lang.String getRemoteHost()

getRemotePort

public int getRemotePort()

getRemoteUser

public java.lang.String getRemoteUser()

getSession

public javax.servlet.http.HttpSession getSession()

getUserPrincipal

public java.security.Principal getUserPrincipal()

getUserAgent

public java.lang.String getUserAgent()

getHttpServletRequest

public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Returns:

the original servlet request, in case the specific information captured in this class is not sufficient.