org.javalite.activeweb

Class AppController

java.lang.Object

org.javalite.activeweb.HttpSupport

org.javalite.activeweb.AppController

Direct Known Subclasses:

AbstractLesscController, GWTAppController, SimpleController

public abstract class AppController
extends HttpSupport

Subclass this class to create application controllers. A controller is a main component of a web application. Its main purpose in life is to process web requests.

Author:

Igor Polevoy

Nested Class Summary

Nested classes/interfaces inherited from class org.javalite.activeweb.HttpSupport

HttpSupport.HttpBuilder, HttpSupport.RenderBuilder

Constructor Summary

Constructors

Constructor and Description
AppController()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	actionSupportsHttpMethod(String actionMethodName, HttpMethod httpMethod) Checks if the action supports an HTTP method, according to its configuration.
protected List<HttpMethod>	allowedActions(String actionMethodName)
protected void	assign(String name, Object value) Assigns value that will be passed into view.
protected String	getContentType() Returns hardcoded value "text/html".
protected String	getLayout() Returns a name for a default layout as provided in activeweb_defaults.properties file.
protected byte[]	getRequestBytes() Reads entire request data as byte array.
protected InputStream	getRequestInputStream()
protected InputStream	getRequestStream() Alias to getRequestInputStream().
protected String	getRequestString() Reads entire request data as String.
protected String	queryString() Returns query string of the request.
protected HttpSupport.RenderBuilder	render() Use this method in order to override a layout, status code, and content type.
protected HttpSupport.RenderBuilder	render(String template) Renders results with a template.
boolean	restful() Returns true if this controller is configured to be RESTful.
static <T extends AppController> boolean	restful(Class<T> controllerClass)
protected String	servletPath()
protected boolean	standardActionSupportsHttpMethod(String actionMethodName, HttpMethod httpMethod)
protected Map	values()
protected void	view(String name, Object value) Alias to assign(String, Object).

Methods inherited from class org.javalite.activeweb.HttpSupport

appContext, blank, context, cookie, cookies, cookieValue, encoding, exists, flash, flash, flash, flash, format, getEncoding, getFile, getId, getLocale, getMap, getMap, getRealPath, getRequestHost, getRequestPort, getRequestProtocol, getResponseHeaders, getRoute, header, header, header, headers, host, ipAddress, ipForwardedFor, isDelete, isGet, isHead, isPost, isPut, isXhr, locale, locale, logDebug, logError, logError, logError, logInfo, logWarning, logWarning, main, merge, method, multipartFormItems, multipartFormItems, outputStream, outputStream, outputStream, param, param, params, params, params, params1st, params1st, path, port, protocol, redirect, redirect, redirect, redirect, redirect, redirect, redirect, redirect, redirectToReferrer, redirectToReferrer, remoteAddress, remoteHost, render, requestHas, respond, sendCookie, sendCookie, sendFile, sendPermanentCookie, session, session, session, sessionBoolean, sessionDouble, sessionFloat, sessionHas, sessionInteger, sessionLong, sessionObject, sessionString, setContentLength, setEncoding, setLocale, setRequestEncoding, setResponseEncoding, streamOut, uploadedFiles, uploadedFiles, uploadedFiles, uri, url, userAgent, view, view, writer, writer, xhr

Methods inherited from class java.lang.Object

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

Constructor Detail

AppController

public AppController()

Method Detail

assign

protected void assign(String name,
          Object value)

Assigns value that will be passed into view.

Overrides:

assign in class HttpSupport

Parameters:

name - name of a value.

value - value.

view

protected void view(String name,
        Object value)

Alias to assign(String, Object).

Overrides:

view in class HttpSupport

Parameters:

name - name of object to be passed to view

value - object to be passed to view

values

protected Map values()

render

protected HttpSupport.RenderBuilder render(String template)

Renders results with a template. This method is called from within an action execution. This call must be the last call in the action. All subsequent calls to assign values, render or respond will generate IllegalStateException.

Parameters:

template - - template name, can be "list" - for a view whose name is different than the name of this action, or "/another_controller/any_view" - this is a reference to a view from another controller. The format of this parameter should be either a single word or two words separated by slash: '/'. If this is a single word, than it is assumed that template belongs to current controller, if there is a slash used as a separator, then the first word is assumed to be a name of another controller.

Returns:

instance of RenderBuilder, which is used to provide additional parameters.

render

protected HttpSupport.RenderBuilder render()

Use this method in order to override a layout, status code, and content type.

Returns:

instance of RenderBuilder, which is used to provide additional parameters.

servletPath

protected String servletPath()

queryString

protected String queryString()

Description copied from class: HttpSupport

Returns query string of the request.

Overrides:

queryString in class HttpSupport

Returns:

query string of the request.

getRequestInputStream

protected InputStream getRequestInputStream()
                                     throws IOException

Throws:

IOException

getRequestStream

protected InputStream getRequestStream()
                                throws IOException

Alias to getRequestInputStream().

Returns:

input stream to read data sent by client.

Throws:

IOException

getRequestString

protected String getRequestString()
                           throws IOException

Reads entire request data as String. Do not use for large data sets to avoid memory issues, instead use getRequestInputStream().

Returns:

data sent by client as string.

Throws:

IOException

getRequestBytes

protected byte[] getRequestBytes()
                          throws IOException

Reads entire request data as byte array. Do not use for large data sets to avoid memory issues.

Returns:

data sent by client as string.

Throws:

IOException

getLayout

protected String getLayout()

Returns a name for a default layout as provided in activeweb_defaults.properties file. Override this method in a sub-class. Value expected is a fully qualified name of a layout template. Example: "/custom/custom_layout"

Returns:

name of a layout for this controller and descendants if they do not override this method.

getContentType

protected String getContentType()

Returns hardcoded value "text/html". Override this method to set default content type to a different value across all actions in controller and its subclasses. This is a convenient method for building REST webservices. You can set this value once to "text/json", "text/xml" or whatever else you need.

Returns:

hardcoded value "text/html"

actionSupportsHttpMethod

public boolean actionSupportsHttpMethod(String actionMethodName,
                               HttpMethod httpMethod)

Checks if the action supports an HTTP method, according to its configuration.

Parameters:

actionMethodName - name of action method.

httpMethod - http method

Returns:

true if supports, false if does not.

standardActionSupportsHttpMethod

protected boolean standardActionSupportsHttpMethod(String actionMethodName,
                                       HttpMethod httpMethod)

allowedActions

protected List<HttpMethod> allowedActions(String actionMethodName)

restful

public boolean restful()

Returns true if this controller is configured to be RESTful.

Returns:

true if this controller is restful, false if not.

restful

public static <T extends AppController> boolean restful(Class<T> controllerClass)