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

@Beta
public abstract class BaseWebHandler
extends Object
implements WebHandler

Field Summary

Fields inherited from interface com.enonic.xp.web.handler.WebHandler

MAX_ORDER, MIN_ORDER

Constructor Summary

Constructors

Constructor and Description
BaseWebHandler()
BaseWebHandler(EnumSet<HttpMethod> methodsAllowed)
BaseWebHandler(int order)
BaseWebHandler(int order, EnumSet<HttpMethod> methodsAllowed)

Method Summary

Modifier and Type	Method and Description
protected void	addTraceInfo(Trace trace, WebResponse webResponse)
protected WebException	badRequest(String message, Object... args)
protected abstract boolean	canHandle(WebRequest webRequest)
protected abstract WebResponse	doHandle(WebRequest webRequest, WebResponse webResponse, WebHandlerChain webHandlerChain)
protected Long	getBodyLength(Object body)
int	getOrder()
protected Long	getSize(WebResponse webResponse)
WebResponse	handle(WebRequest webRequest, WebResponse webResponse, WebHandlerChain webHandlerChain)
protected WebException	methodNotAllowed(String message, Object... args)
protected WebException	notFound(String message, Object... args)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseWebHandler

public BaseWebHandler()

BaseWebHandler

public BaseWebHandler(int order)

BaseWebHandler

public BaseWebHandler(EnumSet<HttpMethod> methodsAllowed)

BaseWebHandler

public BaseWebHandler(int order,
                      EnumSet<HttpMethod> methodsAllowed)

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface WebHandler

handle

public WebResponse handle(WebRequest webRequest,
                          WebResponse webResponse,
                          WebHandlerChain webHandlerChain)
                   throws Exception

Specified by:

handle in interface WebHandler

Throws:

Exception

canHandle

protected abstract boolean canHandle(WebRequest webRequest)

doHandle

protected abstract WebResponse doHandle(WebRequest webRequest,
                                        WebResponse webResponse,
                                        WebHandlerChain webHandlerChain)
                                 throws Exception

Throws:

Exception

badRequest

protected final WebException badRequest(String message,
                                        Object... args)

notFound

protected final WebException notFound(String message,
                                      Object... args)

methodNotAllowed

protected final WebException methodNotAllowed(String message,
                                              Object... args)

getSize

protected Long getSize(WebResponse webResponse)

getBodyLength

protected Long getBodyLength(Object body)
                      throws IOException

Throws:

IOException

addTraceInfo

protected void addTraceInfo(Trace trace,
                            WebResponse webResponse)