sirius.web.controller

Interface Interceptor

All Superinterfaces:

sirius.kernel.di.std.Priorized

public interface Interceptor
extends sirius.kernel.di.std.Priorized

Can be used to intercept calls to controllers (Controller)

Field Summary

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

DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
boolean	before(WebContext ctx, boolean jsonCall, Controller controller, Method method) Invoked before the call to the given method would be performed.
boolean	beforePermissionError(String permission, WebContext ctx, boolean jsonCall, Controller controller, Method method) Invoked before the request is aborted due to a missing permission.
default int	getPriority()
boolean	shouldExecuteRoute(WebContext ctx, boolean jsonCall, Controller controller) Determines if a matched routing should be executed.

Method Detail

before

boolean before(WebContext ctx,
               boolean jsonCall,
               Controller controller,
               Method method)
        throws Exception

Invoked before the call to the given method would be performed.

Parameters:

ctx - provides access to the current web context

jsonCall - determines if this is a JSON call or a regular wb request (probably serving html).

controller - the controller which is active

method - the method which will be called

Returns:

true if the call is handled by the interceptor, false if the method should be invoked

Throws:

Exception - in case of an error. Throw a HandledException to signal, that all logging and handling has already been performed. Any other exception will be logged and reported as system error.

beforePermissionError

boolean beforePermissionError(String permission,
                              WebContext ctx,
                              boolean jsonCall,
                              Controller controller,
                              Method method)
                       throws Exception

Invoked before the request is aborted due to a missing permission.

Parameters:

permission - the permission which wasn't granted to the user and therefore caused the error

ctx - provides access to the current web context

jsonCall - determines if this is a JSON call or a regular wb request (probably serving html).

controller - the controller which is active

method - the method which would have been called

Returns:

true if the call is handled by the interceptor, false if a generic error should be created

Throws:

Exception - in case of an error. Throw a HandledException to signal, that all logging and handling has already been performed. Any other exception will be logged and reported as system error.

getPriority

default int getPriority()

Specified by:

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

shouldExecuteRoute

boolean shouldExecuteRoute(WebContext ctx,
                           boolean jsonCall,
                           Controller controller)

Determines if a matched routing should be executed.

By default this should most probably return true to invoke the Controller. However, false can be returned to skip this routing.

Parameters:

ctx - the current request

jsonCall - determines if this is a JSON call (true) or a plain request

controller - the controller which contains the matching route

Returns:

true if the route should be executed, false otherwise