sirius.web.controller

Class ControllerDispatcher

java.lang.Object

sirius.web.controller.ControllerDispatcher

All Implemented Interfaces:

sirius.kernel.di.std.Priorized, WebDispatcher

public class ControllerDispatcher
extends Object
implements WebDispatcher

Dispatches incoming requests to the appropriate Controller.

Field Summary

Fields

Modifier and Type	Field and Description
protected static sirius.kernel.health.Log	LOG

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

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ControllerDispatcher()

Method Summary

Modifier and Type	Method and Description
boolean	dispatch(WebContext ctx) Invoked in order to handle the given request.
int	getPriority() The priority of this controller is PriorityCollector.DEFAULT_PRIORITY + 10 as it is quite complex to check each request against each route.
List<Route>	getRoutes() Returns a list of all routes known to the dispatcher.
sirius.kernel.commons.Callback<WebContext>	preparePreDispatch(WebContext ctx) Invoked as soon as the complete request but not its contents are available.

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

Field Detail

LOG

protected static final sirius.kernel.health.Log LOG

Constructor Detail

ControllerDispatcher

public ControllerDispatcher()

Method Detail

getPriority

public int getPriority()

The priority of this controller is PriorityCollector.DEFAULT_PRIORITY + 10 as it is quite complex to check each request against each route.

Specified by:

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

Specified by:

getPriority in interface WebDispatcher

Returns:

the priority of this dispatcher

preparePreDispatch

public sirius.kernel.commons.Callback<WebContext> preparePreDispatch(WebContext ctx)

Description copied from interface: WebDispatcher

Invoked as soon as the complete request but not its contents are available.

In contrast to WebDispatcher.dispatch(WebContext) this method is invoked before the complete data is accumulated. This permits the handler to install an ContentHandler using WebContext.setContentHandler(ContentHandler) in order to directly process the uploaded data. A request for which true was replied will not be dispatched again once it is complete.

Note thatthis method will be invoked within the event loop of the web-server, therefore absolutely no blocking operations must be performed. However, the returned Callback is executed in its own thread and free of any constraints.

Specified by:

preparePreDispatch in interface WebDispatcher

Parameters:

ctx - the request to handle

Returns:

the handler which will install the ContentHandler and eventually process the request or null to indicate that no pre-dispatching is possible.

See Also:

preparePreDispatch(WebContext)

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

getRoutes

public List<Route> getRoutes()

Returns a list of all routes known to the dispatcher.

Returns:

a list of all routes known to the dispatcher