sirius.web.dispatch

Class HelpDispatcher

java.lang.Object

sirius.web.dispatch.HelpDispatcher

All Implemented Interfaces:

sirius.kernel.di.std.Priorized, WebDispatcher

public class HelpDispatcher
extends Object
implements WebDispatcher

Takes care of all /help URIs and sub-uris.

Field Summary

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
HelpDispatcher()

Method Summary

Modifier and Type	Method and Description
boolean	dispatch(WebContext ctx) Invoked in order to handle the given request.
int	getPriority() Returns the priority to determine the position in the dispatcher list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface sirius.web.http.WebDispatcher

dispatch, preparePreDispatch

Constructor Detail

HelpDispatcher

public HelpDispatcher()

Method Detail

getPriority

public int getPriority()

Description copied from interface: WebDispatcher

Returns the priority to determine the position in the dispatcher list.

Dispatchers are sorted ascending (lower is better). The default priority is PriorityCollector.DEFAULT_PRIORITY, the max. value is 998 as everything above will be handled by the DefaultDispatcher.

Specified by:

getPriority in interface sirius.kernel.di.std.Priorized

Specified by:

getPriority in interface WebDispatcher

Returns:

the priority of the dispatcher

dispatch

public boolean dispatch(WebContext ctx)
                 throws Exception

Description copied from interface: WebDispatcher

Invoked in order to handle the given request.

If the dispatcher doesn't feel responsible for handling the request, it simply returns false. Otherwise if the request is being handled, true must be returned

Note that no blocking operation must be performed in this method. For any complex interaction, a new thread should be forked using Tasks.executor(String). Note that even Response.outputStream(io.netty.handler.codec.http.HttpResponseStatus, String) might block sooner or later to limit heap memory usage - so fork a thread for any serious work besides checking responsibilities for handling requests.

Specified by:

dispatch in interface WebDispatcher

Parameters:

ctx - the request to handle

Returns:

true if the request was handled by this dispatcher, false otherwise.

Throws:

Exception - in case of an error when parsing or dispatching the request