Package com.deere.isg.worktracker.spring

Class SpringWork

java.lang.Object

com.deere.isg.worktracker.Work

com.deere.isg.worktracker.servlet.HttpWork

com.deere.isg.worktracker.spring.SpringWork

public class SpringWork
extends HttpWork

An implementation of HttpWork. Spring Projects should use this class as their base work (i.e. providing an implementation for updateUserInformation(HttpServletRequest)) since this provides features that are specific to Spring.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENDPOINT

Fields inherited from class com.deere.isg.worktracker.servlet.HttpWork

ACCEPT, ACCEPT_HEADER, PATH, REMOTE_ADDRESS, REMOTE_USER, SESSION_ID, STATUS_CODE

Fields inherited from class com.deere.isg.worktracker.Work

ELAPSED_MS, REQUEST_ID, REQUEST_URL, THREAD_NAME, TIME_INTERVAL, ZOMBIE

Constructor Summary

Constructors

Constructor	Description
SpringWork(javax.servlet.ServletRequest request)

Method Summary

Modifier and Type	Method	Description
protected String	buildValueRegex(String value)
String	getEndpoint()
String	getHttpMethod()
String	getRequestURLPattern()
protected String	postCleanUri(String requestUri)
protected String	preCleanUri(javax.servlet.http.HttpServletRequest request)
protected void	setHttpMethod(String httpMethod)
protected void	setRequestURLPattern(javax.servlet.http.HttpServletRequest request, KeyCleanser cleanser)
protected javax.servlet.http.HttpServletRequest	setupSpringVsFilterOrderingWorkaround(javax.servlet.http.HttpServletRequest request, KeyCleanser keyCleanser)
void	updateUserInformation(javax.servlet.http.HttpServletRequest request)	If you plan to have user authentication in your web application, you should extend SpringWork and override updateUserInformation(HttpServletRequest) to add the user information to the MDC.

Methods inherited from class com.deere.isg.worktracker.servlet.HttpWork

getAcceptHeader, getRemoteAddress, getRemoteUser, getService, getSessionId, setAcceptHeader, setRemoteAddress, setRemoteUser, setService, setSessionId

Methods inherited from class com.deere.isg.worktracker.Work

addToMDC, checkLimit, getElapsedMillis, getEndInfo, getLimits, getMaxTime, getMetadata, getRequestId, getStartInfo, getStartTime, getThreadInfo, getThreadName, isZombie, kill, removeLimit, setMaxTime, validateKey

Methods inherited from class java.lang.Object

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

Field Detail

ENDPOINT

public static final String ENDPOINT

See Also:

Constant Field Values

Constructor Detail

SpringWork

public SpringWork(javax.servlet.ServletRequest request)

Method Detail

updateUserInformation

public void updateUserInformation(javax.servlet.http.HttpServletRequest request)

If you plan to have user authentication in your web application, you should extend SpringWork and override updateUserInformation(HttpServletRequest) to add the user information to the MDC. Make sure to use HttpWork.setRemoteUser(String) to update HttpWork.REMOTE_USER for FloodSensor to be effective against `too many same user requests`.

WARNING: Please do not provide any password!

Parameters:

request - Can be useful if using JWT or header authentication

getRequestURLPattern

public String getRequestURLPattern()

setRequestURLPattern

protected void setRequestURLPattern(javax.servlet.http.HttpServletRequest request,
                                    KeyCleanser cleanser)

getEndpoint

public String getEndpoint()

getHttpMethod

public String getHttpMethod()

setHttpMethod

protected void setHttpMethod(String httpMethod)

buildValueRegex

protected String buildValueRegex(String value)

postCleanUri

protected String postCleanUri(String requestUri)

preCleanUri

protected String preCleanUri(javax.servlet.http.HttpServletRequest request)

setupSpringVsFilterOrderingWorkaround

protected javax.servlet.http.HttpServletRequest setupSpringVsFilterOrderingWorkaround(javax.servlet.http.HttpServletRequest request,
                                                                                      KeyCleanser keyCleanser)