me.geso.avans

Class ControllerBase

java.lang.Object

me.geso.avans.ControllerBase

All Implemented Interfaces:

AutoCloseable, Controller, ErrorPageRenderer, HTMLFilterProvider, JacksonJsonParamReader, JacksonJsonView, JSONErrorPageRenderer, JSONParamReader, JSONRendererProvider, TextRendererProvider, ValidatorProvider

public abstract class ControllerBase
extends Object
implements Controller, JacksonJsonView, HTMLFilterProvider, JSONErrorPageRenderer, ValidatorProvider, TextRendererProvider, JacksonJsonParamReader

You should create this object per HTTP request.

Author:

tokuhirom

Constructor Summary

Constructors

Constructor and Description
ControllerBase()

Method Summary

Modifier and Type	Method and Description
void	close()
Object	computePluginStashValueIfAbsent(Class<?> pluginClass, String key, java.util.function.Supplier<?> supplier) Get plugin stash value.
me.geso.webscrew.response.WebResponse	errorForbidden() Create new "403 Forbidden" response in JSON.
me.geso.webscrew.response.WebResponse	errorForbidden(String message)
me.geso.webscrew.response.WebResponse	errorMethodNotAllowed() Create new "405 Method Not Allowed" response in JSON.
protected me.geso.webscrew.response.WebResponse	errorMissingMandatoryParameters(List<String> missingParameters)
me.geso.webscrew.response.WebResponse	errorNotFound() Create new "404 Not Found" response in JSON.
String	filterHTML(String html)
URL	getCurrentURL() [EXPERIMENTAL] Get the URL for current HTTP request.
Map<String,String>	getPathParams()
Optional<Object>	getPluginStashValue(Class<?> pluginClass, String key) Get plugin stash value.
javax.servlet.http.HttpServletRequest	getServletRequest()
me.geso.webscrew.response.WebResponse	handleException(Throwable e)
void	init(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Map<String,String> captured)
void	invoke(Method method, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, Map<String,String> captured)
me.geso.webscrew.response.RedirectResponse	redirect(String location) Create new redirect response.
me.geso.webscrew.response.RedirectResponse	redirect(String location, Map<String,String> parameters) Create new redirect response.
me.geso.webscrew.response.WebResponse	renderText(String text) Create new text/plain response.
void	setPluginStashValue(Class<?> pluginClass, String key, Object value) Set value for stash space for the plugins.
URI	uriFor(String path) [EXPERIMENTAL] Short hand for this.uriFor(path, Collections.emptyMap()).
URI	uriFor(String path, Map<String,String> parameters) [EXPERIMENTAL] Constructs an absolute URI object based on the application root, the provided path, and the additional arguments and query parameters provided.
URI	uriWith(Map<String,String> parameters) [EXPERIMENTAL] Returns a rewritten URI object for the current request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.geso.avans.jackson.JacksonJsonView

createObjectMapper, renderJSON, renderJSON

Methods inherited from interface me.geso.avans.JSONErrorPageRenderer

renderError

Methods inherited from interface me.geso.avans.ValidatorProvider

validateParameters

Methods inherited from interface me.geso.avans.jackson.JacksonJsonParamReader

readJsonParam

Constructor Detail

ControllerBase

public ControllerBase()

Method Detail

init

public void init(javax.servlet.http.HttpServletRequest servletRequest,
                 javax.servlet.http.HttpServletResponse servletResponse,
                 Map<String,String> captured)

Specified by:

init in interface Controller

getServletRequest

public javax.servlet.http.HttpServletRequest getServletRequest()

Specified by:

getServletRequest in interface Controller

redirect

public me.geso.webscrew.response.RedirectResponse redirect(@NonNull
                                                           String location)

Create new redirect response. You can use relative url here.

Parameters:

location -

Returns:

redirect

public me.geso.webscrew.response.RedirectResponse redirect(@NonNull
                                                           String location,
                                                           @NonNull
                                                           Map<String,String> parameters)
                                                    throws URISyntaxException

Create new redirect response. You can use relative url here.

Parameters:

location -

Returns:

Throws:

URISyntaxException

errorMethodNotAllowed

public me.geso.webscrew.response.WebResponse errorMethodNotAllowed()

Create new "405 Method Not Allowed" response in JSON.

Returns:

errorForbidden

public me.geso.webscrew.response.WebResponse errorForbidden()

Create new "403 Forbidden" response in JSON.

Returns:

errorForbidden

public me.geso.webscrew.response.WebResponse errorForbidden(String message)

errorNotFound

public me.geso.webscrew.response.WebResponse errorNotFound()

Create new "404 Not Found" response in JSON.

Returns:

renderText

public me.geso.webscrew.response.WebResponse renderText(String text)

Create new text/plain response.

Specified by:

renderText in interface TextRendererProvider

Parameters:

text -

Returns:

filterHTML

public String filterHTML(String html)

Specified by:

filterHTML in interface HTMLFilterProvider

invoke

public void invoke(Method method,
                   javax.servlet.http.HttpServletRequest servletRequest,
                   javax.servlet.http.HttpServletResponse servletResponse,
                   Map<String,String> captured)

Specified by:

invoke in interface Controller

handleException

public me.geso.webscrew.response.WebResponse handleException(Throwable e)

errorMissingMandatoryParameters

protected me.geso.webscrew.response.WebResponse errorMissingMandatoryParameters(List<String> missingParameters)

close

public void close()

Specified by:

close in interface AutoCloseable

getPluginStashValue

public Optional<Object> getPluginStashValue(Class<?> pluginClass,
                                            String key)

Description copied from interface: Controller

Get plugin stash value.

Specified by:

getPluginStashValue in interface Controller

setPluginStashValue

public void setPluginStashValue(Class<?> pluginClass,
                                String key,
                                Object value)

Description copied from interface: Controller

Set value for stash space for the plugins. You can store the plugin specific data into here.

Specified by:

setPluginStashValue in interface Controller

computePluginStashValueIfAbsent

public Object computePluginStashValueIfAbsent(Class<?> pluginClass,
                                              String key,
                                              java.util.function.Supplier<?> supplier)

Description copied from interface: Controller

Get plugin stash value. Compute if absent with callback.

Specified by:

computePluginStashValueIfAbsent in interface Controller

getPathParams

public Map<String,String> getPathParams()

Specified by:

getPathParams in interface Controller

getCurrentURL

public URL getCurrentURL()
                  throws MalformedURLException

[EXPERIMENTAL] Get the URL for current HTTP request. Return value includes query string.

Returns:

Reconstructed URL

Throws:

MalformedURLException

uriFor

public URI uriFor(String path,
                  Map<String,String> parameters)
           throws URISyntaxException,
                  MalformedURLException

[EXPERIMENTAL] Constructs an absolute URI object based on the application root, the provided path, and the additional arguments and query parameters provided. This method cares context path. You can use relative path from context root. For example, if your context path is http://example.com/xxx/, uriFor("/x") returns http://example.com/xxx/x

Parameters:

path - Path from the current URL. You can use root relative URL from context root.

parameters - Query parameters.

Returns:

Constructed URI.

Throws:

URISyntaxException

MalformedURLException

uriFor

public URI uriFor(String path)
           throws URISyntaxException,
                  MalformedURLException

[EXPERIMENTAL] Short hand for this.uriFor(path, Collections.emptyMap()).

Parameters:

path - Path for destination.

Returns:

Constructed URL

Throws:

URISyntaxException

MalformedURLException

uriWith

public URI uriWith(Map<String,String> parameters)
            throws URISyntaxException,
                   MalformedURLException

[EXPERIMENTAL] Returns a rewritten URI object for the current request. Key/value pairs passed in will override existing parameters. You can remove an existing parameter by passing in an undef value. Unmodified pairs will be preserved.

Parameters:

parameters -

Returns:

Constructed URI.

Throws:

URISyntaxException

MalformedURLException