sirius.web.controller

Class BasicController

java.lang.Object

sirius.web.controller.BasicController

All Implemented Interfaces:

Controller

Direct Known Subclasses:

ManagedTasksController, ScopeDefaultConfigController, SystemController, TranslationController

public class BasicController
extends Object
implements Controller

Basic implementation of Controller providing convenience methods and default routing.

The annotation DefaultRoute can be added to an existing Routed. In case any other route throws an error, the default route is invoked and will display the error. This can be used to automatically jump back to a list view in case an edit view throws an error. Using this behavior is more transparent for the user than just jumping to a random error page.

Field Summary

Fields

Modifier and Type	Field and Description
protected Consumer<WebContext>	defaultRoute

Constructor Summary

Constructors

Constructor and Description
BasicController() Creates a new instance of the controller and tries to determine the DefaultRoute which is used in case another route throws an error.

Method Summary

Modifier and Type	Method and Description
protected void	assertNotNull(Object obj) Asserts that the given object is non-null.
protected void	assertPermission(String permission) Asserts that the current user has the given permission.
void	fail(WebContext ctx, sirius.kernel.health.HandledException error) Aborts the request with an error.
protected UserInfo	getUser() Obtains the currently active user.
protected boolean	hasPermission(String permission) Determines if the current user has the given permission.
void	onError(WebContext ctx, sirius.kernel.health.HandledException error) In case processing a request via a method fails (throws an exception), this method will be called.
void	showDeletedMessage() Displays a genric "Object was deleted" message.
void	showSavedMessage() Displays a generic "Changes have been saved" message.

Methods inherited from class java.lang.Object

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

Field Detail

defaultRoute

protected Consumer<WebContext> defaultRoute

Constructor Detail

BasicController

public BasicController()

Creates a new instance of the controller and tries to determine the DefaultRoute which is used in case another route throws an error.

Method Detail

getUser

protected UserInfo getUser()

Obtains the currently active user.

Returns:

the currently active user

hasPermission

protected boolean hasPermission(String permission)

Determines if the current user has the given permission.

Note that a routed method may also wear Permission or LoginRequired to signal the required permissions of a user.

Parameters:

permission - the permission being required

Returns:

true if the current user has the permission, false otherwise

assertPermission

protected void assertPermission(String permission)

Asserts that the current user has the given permission.

If the permission is not present, an appropriate error is thrown.

Parameters:

permission - the permission being required

assertNotNull

protected void assertNotNull(Object obj)

Asserts that the given object is non-null.

Throws an appropriate error if the object is null.

Parameters:

obj - the object to be checked

showSavedMessage

public void showSavedMessage()

Displays a generic "Changes have been saved" message.

showDeletedMessage

public void showDeletedMessage()

Displays a genric "Object was deleted" message.

fail

public void fail(WebContext ctx,
                 sirius.kernel.health.HandledException error)

Aborts the request with an error.

This is used if no default route is present or if the default route itself fails.

Most of the time this method should not be called directly, rather a HandledException should be thrown.

Parameters:

ctx - the current request

error - the error which occured

onError

public void onError(WebContext ctx,
                    sirius.kernel.health.HandledException error)

Description copied from interface: Controller

In case processing a request via a method fails (throws an exception), this method will be called.

This provides a convenient way to render a "fallback" page like a list view, if a specialized details view or something thereof fails.

Specified by:

onError in interface Controller

Parameters:

ctx - the context containing the request

error - the error which occurred