Package 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 aAccessEventinstance is created. This instance is passed around to the different logback components.- Author:
- Ceki Gülcü, Sébastien Pennec
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from interface ch.qos.logback.access.spi.IAccessEvent
NA, SENTINEL
-
-
Constructor Summary
Constructors Constructor Description AccessEvent(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse, ServerAdapter adapter)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidbuildRequestHeaderMap()voidbuildRequestParameterMap()java.lang.StringgetAttribute(java.lang.String key)longgetContentLength()java.lang.StringgetCookie(java.lang.String key)longgetElapsedSeconds()The number of seconds elapsed between receiving the request and logging it.longgetElapsedTime()The time elapsed between receiving the request and logging it in milliseconds.intgetLocalPort()java.lang.StringgetMethod()java.lang.StringgetProtocol()java.lang.StringgetQueryString()java.lang.StringgetRemoteAddr()java.lang.StringgetRemoteHost()java.lang.StringgetRemoteUser()javax.servlet.http.HttpServletRequestgetRequest()Returns the underlying HttpServletRequest.java.lang.StringgetRequestContent()java.lang.StringgetRequestHeader(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.StringgetRequestURI()java.lang.StringgetRequestURL()The first line of the request.javax.servlet.http.HttpServletResponsegetResponse()Returns the underlying HttpServletResponse.java.lang.StringgetResponseContent()java.lang.StringgetResponseHeader(java.lang.String key)java.util.Map<java.lang.String,java.lang.String>getResponseHeaderMap()java.util.List<java.lang.String>getResponseHeaderNameList()ServerAdaptergetServerAdapter()java.lang.StringgetServerName()java.lang.StringgetSessionID()intgetStatusCode()java.lang.StringgetThreadName()longgetTimeStamp()The number of milliseconds elapsed from 1/1/1970 until logging event was created.voidprepareForDeferredProcessing()voidsetThreadName(java.lang.String threadName)voidsetTimeStamp(long timeStamp)
-
-
-
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:
getRequestin interfaceIAccessEvent- Returns:
-
getResponse
public javax.servlet.http.HttpServletResponse getResponse()
Returns the underlying HttpServletResponse. After serialization the returned value will be null.- Specified by:
getResponsein interfaceIAccessEvent- Returns:
-
getTimeStamp
public long getTimeStamp()
Description copied from interface:IAccessEventThe number of milliseconds elapsed from 1/1/1970 until logging event was created.- Specified by:
getTimeStampin interfaceIAccessEvent
-
setTimeStamp
public void setTimeStamp(long timeStamp)
-
setThreadName
public void setThreadName(java.lang.String threadName)
- Specified by:
setThreadNamein interfaceIAccessEvent- Parameters:
threadName- The threadName to set.
-
getThreadName
public java.lang.String getThreadName()
- Specified by:
getThreadNamein interfaceIAccessEvent
-
getRequestURI
public java.lang.String getRequestURI()
- Specified by:
getRequestURIin interfaceIAccessEvent
-
getQueryString
public java.lang.String getQueryString()
- Specified by:
getQueryStringin interfaceIAccessEvent
-
getRequestURL
public java.lang.String getRequestURL()
The first line of the request.- Specified by:
getRequestURLin interfaceIAccessEvent
-
getRemoteHost
public java.lang.String getRemoteHost()
- Specified by:
getRemoteHostin interfaceIAccessEvent
-
getRemoteUser
public java.lang.String getRemoteUser()
- Specified by:
getRemoteUserin interfaceIAccessEvent
-
getProtocol
public java.lang.String getProtocol()
- Specified by:
getProtocolin interfaceIAccessEvent
-
getMethod
public java.lang.String getMethod()
- Specified by:
getMethodin interfaceIAccessEvent
-
getSessionID
public java.lang.String getSessionID()
- Specified by:
getSessionIDin interfaceIAccessEvent
-
getServerName
public java.lang.String getServerName()
- Specified by:
getServerNamein interfaceIAccessEvent
-
getRemoteAddr
public java.lang.String getRemoteAddr()
- Specified by:
getRemoteAddrin interfaceIAccessEvent
-
getRequestHeader
public java.lang.String getRequestHeader(java.lang.String key)
- Specified by:
getRequestHeaderin interfaceIAccessEvent
-
getRequestHeaderNames
public java.util.Enumeration<java.lang.String> getRequestHeaderNames()
- Specified by:
getRequestHeaderNamesin interfaceIAccessEvent
-
getRequestHeaderMap
public java.util.Map<java.lang.String,java.lang.String> getRequestHeaderMap()
- Specified by:
getRequestHeaderMapin interfaceIAccessEvent
-
buildRequestHeaderMap
public void buildRequestHeaderMap()
-
buildRequestParameterMap
public void buildRequestParameterMap()
-
getRequestParameterMap
public java.util.Map<java.lang.String,java.lang.String[]> getRequestParameterMap()
- Specified by:
getRequestParameterMapin interfaceIAccessEvent
-
getAttribute
public java.lang.String getAttribute(java.lang.String key)
- Specified by:
getAttributein interfaceIAccessEvent
-
getRequestParameter
public java.lang.String[] getRequestParameter(java.lang.String key)
- Specified by:
getRequestParameterin interfaceIAccessEvent
-
getCookie
public java.lang.String getCookie(java.lang.String key)
- Specified by:
getCookiein interfaceIAccessEvent
-
getContentLength
public long getContentLength()
- Specified by:
getContentLengthin interfaceIAccessEvent
-
getStatusCode
public int getStatusCode()
- Specified by:
getStatusCodein interfaceIAccessEvent
-
getElapsedSeconds
public long getElapsedSeconds()
Description copied from interface:IAccessEventThe number of seconds elapsed between receiving the request and logging it.- Specified by:
getElapsedSecondsin interfaceIAccessEvent
-
getElapsedTime
public long getElapsedTime()
Description copied from interface:IAccessEventThe time elapsed between receiving the request and logging it in milliseconds.- Specified by:
getElapsedTimein interfaceIAccessEvent
-
getRequestContent
public java.lang.String getRequestContent()
- Specified by:
getRequestContentin interfaceIAccessEvent
-
getResponseContent
public java.lang.String getResponseContent()
- Specified by:
getResponseContentin interfaceIAccessEvent
-
getLocalPort
public int getLocalPort()
- Specified by:
getLocalPortin interfaceIAccessEvent
-
getServerAdapter
public ServerAdapter getServerAdapter()
- Specified by:
getServerAdapterin interfaceIAccessEvent
-
getResponseHeader
public java.lang.String getResponseHeader(java.lang.String key)
- Specified by:
getResponseHeaderin interfaceIAccessEvent
-
getResponseHeaderMap
public java.util.Map<java.lang.String,java.lang.String> getResponseHeaderMap()
- Specified by:
getResponseHeaderMapin interfaceIAccessEvent
-
getResponseHeaderNameList
public java.util.List<java.lang.String> getResponseHeaderNameList()
- Specified by:
getResponseHeaderNameListin interfaceIAccessEvent
-
prepareForDeferredProcessing
public void prepareForDeferredProcessing()
- Specified by:
prepareForDeferredProcessingin interfaceDeferredProcessingAware
-
-