Package com.enonic.xp.web.handler
Class BaseWebHandler
- java.lang.Object
-
- com.enonic.xp.web.handler.BaseWebHandler
-
- All Implemented Interfaces:
WebHandler
- Direct Known Subclasses:
BasePortalHandler
,EndpointHandler
,OncePerRequestHandler
@PublicApi public abstract class BaseWebHandler extends java.lang.Object implements WebHandler
-
-
Field Summary
-
Fields inherited from interface com.enonic.xp.web.handler.WebHandler
MAX_ORDER, MIN_ORDER
-
-
Constructor Summary
Constructors Constructor Description BaseWebHandler()
BaseWebHandler(int order)
BaseWebHandler(int order, java.util.EnumSet<HttpMethod> methodsAllowed)
BaseWebHandler(java.util.EnumSet<HttpMethod> methodsAllowed)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
addTraceInfo(Trace trace, WebResponse webResponse)
protected WebException
badRequest(java.lang.String message, java.lang.Object... args)
protected abstract boolean
canHandle(WebRequest webRequest)
protected abstract WebResponse
doHandle(WebRequest webRequest, WebResponse webResponse, WebHandlerChain webHandlerChain)
protected java.lang.Long
getBodyLength(java.lang.Object body)
int
getOrder()
protected java.lang.Long
getSize(WebResponse webResponse)
WebResponse
handle(WebRequest webRequest, WebResponse webResponse, WebHandlerChain webHandlerChain)
protected WebException
methodNotAllowed(java.lang.String message, java.lang.Object... args)
protected WebException
notFound(java.lang.String message, java.lang.Object... args)
-
-
-
Constructor Detail
-
BaseWebHandler
public BaseWebHandler()
-
BaseWebHandler
public BaseWebHandler(int order)
-
BaseWebHandler
public BaseWebHandler(java.util.EnumSet<HttpMethod> methodsAllowed)
-
BaseWebHandler
public BaseWebHandler(int order, java.util.EnumSet<HttpMethod> methodsAllowed)
-
-
Method Detail
-
getOrder
public int getOrder()
- Specified by:
getOrder
in interfaceWebHandler
-
handle
public WebResponse handle(WebRequest webRequest, WebResponse webResponse, WebHandlerChain webHandlerChain) throws java.lang.Exception
- Specified by:
handle
in interfaceWebHandler
- Throws:
java.lang.Exception
-
canHandle
protected abstract boolean canHandle(WebRequest webRequest)
-
doHandle
protected abstract WebResponse doHandle(WebRequest webRequest, WebResponse webResponse, WebHandlerChain webHandlerChain) throws java.lang.Exception
- Throws:
java.lang.Exception
-
badRequest
protected final WebException badRequest(java.lang.String message, java.lang.Object... args)
-
notFound
protected final WebException notFound(java.lang.String message, java.lang.Object... args)
-
methodNotAllowed
protected final WebException methodNotAllowed(java.lang.String message, java.lang.Object... args)
-
getSize
protected java.lang.Long getSize(WebResponse webResponse)
-
getBodyLength
protected java.lang.Long getBodyLength(java.lang.Object body) throws java.io.IOException
- Throws:
java.io.IOException
-
addTraceInfo
protected void addTraceInfo(Trace trace, WebResponse webResponse)
-
-