public class LogUtil
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADMIN_ACCESS_LAST_MODIFIED_LOG_ID |
static java.lang.String |
ADMIN_ACCESS_LOG_ID |
static java.lang.String |
DOCS_ACCESS_LOG_ID |
static java.lang.String |
GATEWAY_ACCESS_LAST_MODIFIED_LOG_ID |
static java.lang.String |
GATEWAY_ACCESS_LOG_ID |
static java.lang.String |
HYRAX_ACCESS_LOG_ID |
static java.lang.String |
HYRAX_LAST_MODIFIED_ACCESS_LOG_ID |
static java.lang.String |
PDP_SERVICE_ACCESS_LOG_ID |
static java.lang.String |
PDP_SERVICE_LAST_MODIFIED_LOG_ID |
static java.lang.String |
S3_SERVICE_ACCESS_LOG_ID |
static java.lang.String |
S3_SERVICE_LAST_MODIFIED_LOG_ID |
static java.lang.String |
SITEMAP_ACCESS_LOG_ID |
static java.lang.String |
WCS_ACCESS_LOG_ID |
static java.lang.String |
WCS_LAST_MODIFIED_ACCESS_LOG_ID |
Modifier and Type | Method and Description |
---|---|
static void |
initLogging(javax.servlet.http.HttpServlet servlet)
Initialize logging for the web application context in which the given
servlet is running.
|
static void |
initLogging(java.lang.String path)
Initialize logging for the web application context in which the given
servlet is running.
|
static void |
logServerAccessEnd(int httpStatus,
int size,
java.lang.String logName)
Write log entry to named log.
|
static void |
logServerAccessEnd(int httpStatus,
java.lang.String logName)
Write log entry to named log.
|
static void |
logServerAccessStart(javax.servlet.http.HttpServletRequest req,
java.lang.String logName,
java.lang.String reqSource,
java.lang.String reqID)
Gather information from the given HttpServletRequest for inclusion in both
regular logging messages and THREDDS access log messages.
|
static void |
logServerShutdown(java.lang.String source)
Gather current thread information for inclusion in regular logging
messages.
|
static void |
logServerStartup(java.lang.String source)
Gather current thread information for inclusion in regular logging
messages.
|
static java.lang.String |
scrubEntry(java.lang.String s)
https://affinity-it-security.com/how-to-prevent-log-injection/
|
static void |
setResponseSize(long size)
Used in various places in the server to add the response size to the log.
|
public static final java.lang.String HYRAX_ACCESS_LOG_ID
public static final java.lang.String HYRAX_LAST_MODIFIED_ACCESS_LOG_ID
public static final java.lang.String DOCS_ACCESS_LOG_ID
public static final java.lang.String SITEMAP_ACCESS_LOG_ID
public static final java.lang.String PDP_SERVICE_ACCESS_LOG_ID
public static final java.lang.String PDP_SERVICE_LAST_MODIFIED_LOG_ID
public static final java.lang.String GATEWAY_ACCESS_LOG_ID
public static final java.lang.String GATEWAY_ACCESS_LAST_MODIFIED_LOG_ID
public static final java.lang.String ADMIN_ACCESS_LOG_ID
public static final java.lang.String ADMIN_ACCESS_LAST_MODIFIED_LOG_ID
public static final java.lang.String S3_SERVICE_ACCESS_LOG_ID
public static final java.lang.String S3_SERVICE_LAST_MODIFIED_LOG_ID
public static final java.lang.String WCS_ACCESS_LOG_ID
public static final java.lang.String WCS_LAST_MODIFIED_ACCESS_LOG_ID
public static void initLogging(javax.servlet.http.HttpServlet servlet)
servlet
- - the servlet.public static void initLogging(java.lang.String path)
path
- - the path to the log4j.xml filepublic static void logServerStartup(java.lang.String source)
source
- The source id of who started the logging. Typically an init()
method.public static void logServerShutdown(java.lang.String source)
source
- The source id of who started the logging. Typically an init()
method.public static void logServerAccessStart(javax.servlet.http.HttpServletRequest req, java.lang.String logName, java.lang.String reqSource, java.lang.String reqID)
req
- the current HttpServletRequest.logName
- Name of Logger to write stuff.public static void setResponseSize(long size)
size
- The size, in bytes, of the response. Values less than 0 will be ignored.public static void logServerAccessEnd(int httpStatus, java.lang.String logName)
httpStatus
- - the result code for this request.logName
- the name of the Logger to which to write stuff.public static void logServerAccessEnd(int httpStatus, int size, java.lang.String logName)
httpStatus
- The HTTP status code for this request.size
- The size of the response.logName
- the name of the Logger to which to write stuff.public static java.lang.String scrubEntry(java.lang.String s)
s
- String to prep for log.