jodd.madvoc.component

Class MadvocController

java.lang.Object

jodd.madvoc.component.MadvocController

All Implemented Interfaces:

MadvocComponentLifecycle.Ready

Direct Known Subclasses:

PetiteMadvocController

public class MadvocController
extends java.lang.Object
implements MadvocComponentLifecycle.Ready

Madvoc controller invokes actions for action path and renders action results. It also builds action objects and result paths. It handles initialization of interceptors and results.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionPathRewriter	actionPathRewriter
protected ActionsManager	actionsManager
protected boolean	applyCharacterEncoding
protected AsyncActionExecutor	asyncActionExecutor
protected MadvocEncoding	madvocEncoding
protected boolean	preventCaching
protected ResultsManager	resultsManager
protected ServletContextProvider	servletContextProvider
protected java.lang.String	welcomeFile

Constructor Summary

Constructors

Constructor and Description
MadvocController()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	createAction(java.lang.Class actionClass) Creates new action object from ActionRuntime using default constructor.
protected ActionRequest	createActionRequest(java.lang.String actionPath, java.lang.String[] actionPathChunks, ActionRuntime actionRuntime, java.lang.Object action, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Creates new action request.
javax.servlet.ServletContext	getApplicationContext() Returns application context set during the initialization.
java.lang.String	getWelcomeFile()
java.lang.String	invoke(java.lang.String actionPath, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) Invokes action registered to provided action path, Provides action chaining, by invoking the next action request.
boolean	isApplyCharacterEncoding()
boolean	isPreventCaching()
void	ready()
void	render(ActionRequest actionRequest, java.lang.Object resultObject) Invokes a result after the action invocation.
void	setApplyCharacterEncoding(boolean applyCharacterEncoding) Defines is character encoding has to be set by Madvoc into the request and response.
void	setPreventCaching(boolean preventCaching) Specifies if Madvoc should add response params to prevent browser caching.
void	setWelcomeFile(java.lang.String welcomeFile) Sets the welcome file as defined by servlet container.

Methods inherited from class java.lang.Object

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

Field Detail

madvocEncoding

@PetiteInject
protected MadvocEncoding madvocEncoding

actionsManager

@PetiteInject
protected ActionsManager actionsManager

actionPathRewriter

@PetiteInject
protected ActionPathRewriter actionPathRewriter

resultsManager

@PetiteInject
protected ResultsManager resultsManager

servletContextProvider

@PetiteInject
protected ServletContextProvider servletContextProvider

asyncActionExecutor

@PetiteInject
protected AsyncActionExecutor asyncActionExecutor

applyCharacterEncoding

protected boolean applyCharacterEncoding

preventCaching

protected boolean preventCaching

welcomeFile

protected java.lang.String welcomeFile

Constructor Detail

MadvocController

public MadvocController()

Method Detail

ready

public void ready()

Specified by:

ready in interface MadvocComponentLifecycle.Ready

getApplicationContext

public javax.servlet.ServletContext getApplicationContext()

Returns application context set during the initialization.

invoke

public java.lang.String invoke(java.lang.String actionPath,
                               javax.servlet.http.HttpServletRequest servletRequest,
                               javax.servlet.http.HttpServletResponse servletResponse)
                        throws java.lang.Exception

Invokes action registered to provided action path, Provides action chaining, by invoking the next action request. Returns null if action path is consumed and has been invoked by this controller; otherwise the action path string is returned (it might be different than original one, provided in arguments). On first invoke, initializes the action runtime before further proceeding.

Throws:

java.lang.Exception

render

public void render(ActionRequest actionRequest,
                   java.lang.Object resultObject)
            throws java.lang.Exception

Invokes a result after the action invocation.

Results may be objects that specify which action result will be used to render the result.

Result value may consist of two parts: type and value. Result type is optional and, if exists, it is separated by semi-colon from the value. If type is not specified then the default result type if still not defined. Result type defines which ActionResult should be used for rendering the value.

Result value is first checked against aliased values. Then, it is resolved and then passed to the founded ActionResult.

Throws:

java.lang.Exception

See Also:

ActionResult.render(jodd.madvoc.ActionRequest, Object)

createAction

protected java.lang.Object createAction(java.lang.Class actionClass)

Creates new action object from ActionRuntime using default constructor.

createActionRequest

protected ActionRequest createActionRequest(java.lang.String actionPath,
                                            java.lang.String[] actionPathChunks,
                                            ActionRuntime actionRuntime,
                                            java.lang.Object action,
                                            javax.servlet.http.HttpServletRequest servletRequest,
                                            javax.servlet.http.HttpServletResponse servletResponse)

Creates new action request.

Parameters:

actionPath - action path

actionRuntime - action runtime

action - action object

servletRequest - http request

servletResponse - http response

Returns:

action request

isApplyCharacterEncoding

public boolean isApplyCharacterEncoding()

setApplyCharacterEncoding

public void setApplyCharacterEncoding(boolean applyCharacterEncoding)

Defines is character encoding has to be set by Madvoc into the request and response.

isPreventCaching

public boolean isPreventCaching()

setPreventCaching

public void setPreventCaching(boolean preventCaching)

Specifies if Madvoc should add response params to prevent browser caching.

getWelcomeFile

public java.lang.String getWelcomeFile()

setWelcomeFile

public void setWelcomeFile(java.lang.String welcomeFile)

Sets the welcome file as defined by servlet container.