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 aAccessEvent
instance is created. This instance is passed around to the different logback components.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field 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
private static java.lang.String[]
NA_STRING_ARRAY
(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 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 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)
-
-
-
Field Detail
-
NA_STRING_ARRAY
private static final java.lang.String[] NA_STRING_ARRAY
-
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 interfaceIAccessEvent
- Returns:
-
getResponse
public javax.servlet.http.HttpServletResponse getResponse()
Returns the underlying HttpServletResponse. After serialization the returned value will be null.- Specified by:
getResponse
in interfaceIAccessEvent
- 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 interfaceIAccessEvent
-
setTimeStamp
public void setTimeStamp(long timeStamp)
-
setThreadName
public void setThreadName(java.lang.String threadName)
- Specified by:
setThreadName
in interfaceIAccessEvent
- Parameters:
threadName
- The threadName to set.
-
getThreadName
public java.lang.String getThreadName()
- Specified by:
getThreadName
in interfaceIAccessEvent
-
getRequestURI
public java.lang.String getRequestURI()
- Specified by:
getRequestURI
in interfaceIAccessEvent
-
getQueryString
public java.lang.String getQueryString()
- Specified by:
getQueryString
in interfaceIAccessEvent
-
getRequestURL
public java.lang.String getRequestURL()
The first line of the request.- Specified by:
getRequestURL
in interfaceIAccessEvent
-
getRemoteHost
public java.lang.String getRemoteHost()
- Specified by:
getRemoteHost
in interfaceIAccessEvent
-
getRemoteUser
public java.lang.String getRemoteUser()
- Specified by:
getRemoteUser
in interfaceIAccessEvent
-
getProtocol
public java.lang.String getProtocol()
- Specified by:
getProtocol
in interfaceIAccessEvent
-
getMethod
public java.lang.String getMethod()
- Specified by:
getMethod
in interfaceIAccessEvent
-
getSessionID
public java.lang.String getSessionID()
- Specified by:
getSessionID
in interfaceIAccessEvent
-
getServerName
public java.lang.String getServerName()
- Specified by:
getServerName
in interfaceIAccessEvent
-
getRemoteAddr
public java.lang.String getRemoteAddr()
- Specified by:
getRemoteAddr
in interfaceIAccessEvent
-
getRequestHeader
public java.lang.String getRequestHeader(java.lang.String key)
- Specified by:
getRequestHeader
in interfaceIAccessEvent
-
getRequestHeaderNames
public java.util.Enumeration<java.lang.String> getRequestHeaderNames()
- Specified by:
getRequestHeaderNames
in interfaceIAccessEvent
-
getRequestHeaderMap
public java.util.Map<java.lang.String,java.lang.String> getRequestHeaderMap()
- Specified by:
getRequestHeaderMap
in interfaceIAccessEvent
-
buildRequestHeaderMap
public void buildRequestHeaderMap()
-
buildRequestParameterMap
public void buildRequestParameterMap()
-
getRequestParameterMap
public java.util.Map<java.lang.String,java.lang.String[]> getRequestParameterMap()
- Specified by:
getRequestParameterMap
in interfaceIAccessEvent
-
getAttribute
public java.lang.String getAttribute(java.lang.String key)
- Specified by:
getAttribute
in interfaceIAccessEvent
-
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 interfaceIAccessEvent
-
getCookie
public java.lang.String getCookie(java.lang.String key)
- Specified by:
getCookie
in interfaceIAccessEvent
-
getContentLength
public long getContentLength()
- Specified by:
getContentLength
in interfaceIAccessEvent
-
getStatusCode
public int getStatusCode()
- Specified by:
getStatusCode
in interfaceIAccessEvent
-
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 interfaceIAccessEvent
-
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 interfaceIAccessEvent
-
calculateElapsedTime
private long calculateElapsedTime()
-
getRequestContent
public java.lang.String getRequestContent()
- Specified by:
getRequestContent
in interfaceIAccessEvent
-
getResponseContent
public java.lang.String getResponseContent()
- Specified by:
getResponseContent
in interfaceIAccessEvent
-
getLocalPort
public int getLocalPort()
- Specified by:
getLocalPort
in interfaceIAccessEvent
-
getServerAdapter
public ServerAdapter getServerAdapter()
- Specified by:
getServerAdapter
in interfaceIAccessEvent
-
getResponseHeader
public java.lang.String getResponseHeader(java.lang.String key)
- Specified by:
getResponseHeader
in interfaceIAccessEvent
-
buildResponseHeaderMap
void buildResponseHeaderMap()
-
getResponseHeaderMap
public java.util.Map<java.lang.String,java.lang.String> getResponseHeaderMap()
- Specified by:
getResponseHeaderMap
in interfaceIAccessEvent
-
getResponseHeaderNameList
public java.util.List<java.lang.String> getResponseHeaderNameList()
- Specified by:
getResponseHeaderNameList
in interfaceIAccessEvent
-
prepareForDeferredProcessing
public void prepareForDeferredProcessing()
- Specified by:
prepareForDeferredProcessing
in interfaceDeferredProcessingAware
-
-