ch.qos.logback.access.spi

Class AccessEvent

java.lang.Object

ch.qos.logback.access.spi.AccessEvent

All Implemented Interfaces:

IAccessEvent, DeferredProcessingAware, java.io.Serializable

public class AccessEvent
extends java.lang.Object
implements java.io.Serializable, IAccessEvent

The Access module's internal representation of logging events. When the logging component instance is called in the container to log then a AccessEvent instance is created. This instance is passed around to the different logback components.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.util.Map<java.lang.String,java.lang.Object>	attributeMap
(package private) long	contentLength
(package private) long	elapsedTime
private static java.lang.String	EMPTY
private javax.servlet.http.HttpServletRequest	httpRequest
private javax.servlet.http.HttpServletResponse	httpResponse
(package private) int	localPort
(package private) java.lang.String	method
(package private) java.lang.String	protocol
(package private) java.lang.String	queryString
(package private) java.lang.String	remoteAddr
(package private) java.lang.String	remoteHost
(package private) java.lang.String	remoteUser
(package private) java.lang.String	requestContent
(package private) java.util.Map<java.lang.String,java.lang.String>	requestHeaderMap
(package private) java.util.Map<java.lang.String,java.lang.String[]>	requestParameterMap
(package private) java.lang.String	requestURI
(package private) java.lang.String	requestURL
(package private) java.lang.String	responseContent
(package private) java.util.Map<java.lang.String,java.lang.String>	responseHeaderMap
private static long	serialVersionUID
(package private) ServerAdapter	serverAdapter
(package private) java.lang.String	serverName
(package private) java.lang.String	sessionID
(package private) int	statusCode
(package private) java.lang.String	threadName
private long	timeStamp The number of milliseconds elapsed from 1/1/1970 until logging event was created.

Fields inherited from interface ch.qos.logback.access.spi.IAccessEvent

NA, SENTINEL

Constructor Summary

Constructors

Constructor and Description
AccessEvent(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, ServerAdapter adapter)

Method Summary

Modifier and Type	Method and Description
void	buildRequestHeaderMap()
void	buildRequestParameterMap()
(package private) void	buildResponseHeaderMap()
private long	calculateElapsedTime()
private void	copyAttributeMap()
java.lang.String	getAttribute(java.lang.String key)
long	getContentLength()
java.lang.String	getCookie(java.lang.String key)
long	getElapsedSeconds() The number of seconds elapsed between receiving the request and logging it.
long	getElapsedTime() The time elapsed between receiving the request and logging it in milliseconds.
int	getLocalPort()
java.lang.String	getMethod()
java.lang.String	getProtocol()
java.lang.String	getQueryString()
java.lang.String	getRemoteAddr()
java.lang.String	getRemoteHost()
java.lang.String	getRemoteUser()
javax.servlet.http.HttpServletRequest	getRequest() Returns the underlying HttpServletRequest.
java.lang.String	getRequestContent()
java.lang.String	getRequestHeader(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getRequestHeaderMap()
java.util.Enumeration<java.lang.String>	getRequestHeaderNames()
java.lang.String[]	getRequestParameter(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String[]>	getRequestParameterMap()
java.lang.String	getRequestURI()
java.lang.String	getRequestURL() The first line of the request.
javax.servlet.http.HttpServletResponse	getResponse() Returns the underlying HttpServletResponse.
java.lang.String	getResponseContent()
java.lang.String	getResponseHeader(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getResponseHeaderMap()
java.util.List<java.lang.String>	getResponseHeaderNameList()
ServerAdapter	getServerAdapter()
java.lang.String	getServerName()
java.lang.String	getSessionID()
int	getStatusCode()
java.lang.String	getThreadName()
long	getTimeStamp() The number of milliseconds elapsed from 1/1/1970 until logging event was created.
void	prepareForDeferredProcessing()
void	setThreadName(java.lang.String threadName)
void	setTimeStamp(long timeStamp)
private boolean	shouldCopyAttribute(java.lang.String name, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

EMPTY

private static final java.lang.String EMPTY

See Also:

Constant Field Values

httpRequest

private final transient javax.servlet.http.HttpServletRequest httpRequest

httpResponse

private final transient javax.servlet.http.HttpServletResponse httpResponse

queryString

java.lang.String queryString

requestURI

java.lang.String requestURI

requestURL

java.lang.String requestURL

remoteHost

java.lang.String remoteHost

remoteUser

java.lang.String remoteUser

remoteAddr

java.lang.String remoteAddr

threadName

java.lang.String threadName

protocol

java.lang.String protocol

method

java.lang.String method

serverName

java.lang.String serverName

requestContent

java.lang.String requestContent

responseContent

java.lang.String responseContent

sessionID

java.lang.String sessionID

elapsedTime

long elapsedTime

requestHeaderMap

java.util.Map<java.lang.String,java.lang.String> requestHeaderMap

requestParameterMap

java.util.Map<java.lang.String,java.lang.String[]> requestParameterMap

responseHeaderMap

java.util.Map<java.lang.String,java.lang.String> responseHeaderMap

attributeMap

java.util.Map<java.lang.String,java.lang.Object> attributeMap

contentLength

long contentLength

statusCode

int statusCode

localPort

int localPort

serverAdapter

transient ServerAdapter serverAdapter

timeStamp

private long timeStamp

The number of milliseconds elapsed from 1/1/1970 until logging event was created.

Constructor Detail

AccessEvent

public AccessEvent(javax.servlet.http.HttpServletRequest httpRequest,
                   javax.servlet.http.HttpServletResponse httpResponse,
                   ServerAdapter adapter)

Method Detail

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

Returns the underlying HttpServletRequest. After serialization the returned value will be null.

Specified by:

getRequest in interface IAccessEvent

Returns:

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

Returns the underlying HttpServletResponse. After serialization the returned value will be null.

Specified by:

getResponse in interface IAccessEvent

Returns:

getTimeStamp

public long getTimeStamp()

Description copied from interface: IAccessEvent

The number of milliseconds elapsed from 1/1/1970 until logging event was created.

Specified by:

getTimeStamp in interface IAccessEvent

setTimeStamp

public void setTimeStamp(long timeStamp)

setThreadName

public void setThreadName(java.lang.String threadName)

Specified by:

setThreadName in interface IAccessEvent

Parameters:

threadName - The threadName to set.

getThreadName

public java.lang.String getThreadName()

Specified by:

getThreadName in interface IAccessEvent

getRequestURI

public java.lang.String getRequestURI()

Specified by:

getRequestURI in interface IAccessEvent

getQueryString

public java.lang.String getQueryString()

Specified by:

getQueryString in interface IAccessEvent

getRequestURL

public java.lang.String getRequestURL()

The first line of the request.

Specified by:

getRequestURL in interface IAccessEvent

getRemoteHost

public java.lang.String getRemoteHost()

Specified by:

getRemoteHost in interface IAccessEvent

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in interface IAccessEvent

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface IAccessEvent

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface IAccessEvent

getSessionID

public java.lang.String getSessionID()

Specified by:

getSessionID in interface IAccessEvent

getServerName

public java.lang.String getServerName()

Specified by:

getServerName in interface IAccessEvent

getRemoteAddr

public java.lang.String getRemoteAddr()

Specified by:

getRemoteAddr in interface IAccessEvent

getRequestHeader

public java.lang.String getRequestHeader(java.lang.String key)

Specified by:

getRequestHeader in interface IAccessEvent

getRequestHeaderNames

public java.util.Enumeration<java.lang.String> getRequestHeaderNames()

Specified by:

getRequestHeaderNames in interface IAccessEvent

getRequestHeaderMap

public java.util.Map<java.lang.String,java.lang.String> getRequestHeaderMap()

Specified by:

getRequestHeaderMap in interface IAccessEvent

buildRequestHeaderMap

public void buildRequestHeaderMap()

buildRequestParameterMap

public void buildRequestParameterMap()

getRequestParameterMap

public java.util.Map<java.lang.String,java.lang.String[]> getRequestParameterMap()

Specified by:

getRequestParameterMap in interface IAccessEvent

getAttribute

public java.lang.String getAttribute(java.lang.String key)

Specified by:

getAttribute in interface IAccessEvent

copyAttributeMap

private void copyAttributeMap()

shouldCopyAttribute

private boolean shouldCopyAttribute(java.lang.String name,
                                    java.lang.Object value)

getRequestParameter

public java.lang.String[] getRequestParameter(java.lang.String key)

Specified by:

getRequestParameter in interface IAccessEvent

getCookie

public java.lang.String getCookie(java.lang.String key)

Specified by:

getCookie in interface IAccessEvent

getContentLength

public long getContentLength()

Specified by:

getContentLength in interface IAccessEvent

getStatusCode

public int getStatusCode()

Specified by:

getStatusCode in interface IAccessEvent

getElapsedSeconds

public long getElapsedSeconds()

Description copied from interface: IAccessEvent

The number of seconds elapsed between receiving the request and logging it.

Specified by:

getElapsedSeconds in interface IAccessEvent

getElapsedTime

public long getElapsedTime()

Description copied from interface: IAccessEvent

The time elapsed between receiving the request and logging it in milliseconds.

Specified by:

getElapsedTime in interface IAccessEvent

calculateElapsedTime

private long calculateElapsedTime()

getRequestContent

public java.lang.String getRequestContent()

Specified by:

getRequestContent in interface IAccessEvent

getResponseContent

public java.lang.String getResponseContent()

Specified by:

getResponseContent in interface IAccessEvent

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface IAccessEvent

getServerAdapter

public ServerAdapter getServerAdapter()

Specified by:

getServerAdapter in interface IAccessEvent

getResponseHeader

public java.lang.String getResponseHeader(java.lang.String key)

Specified by:

getResponseHeader in interface IAccessEvent

buildResponseHeaderMap

void buildResponseHeaderMap()

getResponseHeaderMap

public java.util.Map<java.lang.String,java.lang.String> getResponseHeaderMap()

Specified by:

getResponseHeaderMap in interface IAccessEvent

getResponseHeaderNameList

public java.util.List<java.lang.String> getResponseHeaderNameList()

Specified by:

getResponseHeaderNameList in interface IAccessEvent

prepareForDeferredProcessing

public void prepareForDeferredProcessing()

Specified by:

prepareForDeferredProcessing in interface DeferredProcessingAware