org.codehaus.groovy.grails.commons

Interface GrailsControllerClass

All Superinterfaces:

GrailsApplicationAware, GrailsClass, InjectableGrailsClass

All Known Implementing Classes:

DefaultGrailsControllerClass

public interface GrailsControllerClass
extends InjectableGrailsClass

Represents a controller class in Grails.

Author:

Steven Devijver

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION The general name to use when referring to action artefacts.
static java.lang.String	AFTER_INTERCEPTOR The name of the after interceptor property.
static java.lang.String	BEFORE_INTERCEPTOR The name of the before interceptor property.
static java.lang.String	CONTROLLER The general name to use when referring to controller artefacts.
static java.lang.String	INDEX_ACTION The name of the index action.
static java.lang.String	VIEW The general name to use when referring to action view.

Method Summary

Modifier and Type	Method and Description
Closure	getAfterInterceptor(GroovyObject controller) Retrieves the after interceptor for the specified controller instance.
Closure	getBeforeInterceptor(GroovyObject controller) Retrieves the before interceptor for the specified controller instance.
java.util.Set	getCommandObjectActions() Deprecated. This method is deprecated and will be removed in a future version of Grails
java.util.Set	getCommandObjectClasses() Deprecated. This method is deprecated and will be removed in a future version of Grails
java.lang.String	getDefaultAction() Returns the default action for this Controller.
java.util.Map	getFlows() Returns a map of the flows for this controller.
java.lang.String	getMethodActionName(java.lang.String uri) Returns a closure property name for a specific URI or null if the URI does not map to a closure.
java.lang.String[]	getURIs() Gets the list of all possible URI's available in this controller.
java.lang.String	getViewByName(java.lang.String closureName) Retrieves the view name for the specified closure name.
java.lang.String	getViewByURI(java.lang.String uri) Retrieves the view name for the specified URI.
void	initialize() Initialize the controller class
boolean	isFlowAction(java.lang.String actionName) Returns true if the given action name is a flow action.
boolean	isHttpMethodAllowedForAction(GroovyObject controller, java.lang.String httpMethod, java.lang.String actionName) Checks to see if an action is accessible via a particular http method.
boolean	isInterceptedAfter(GroovyObject controller, java.lang.String action) Checks whether the specified action is intercepted after for the specified controller instance.
boolean	isInterceptedBefore(GroovyObject controller, java.lang.String action) Checks whether the specified action is intercepted for the specified controller instance.
boolean	mapsToURI(java.lang.String uri) Tests if a controller maps to a given URI.
void	registerMapping(java.lang.String actionName) Registers a new mapping onto this controller for the given actionName.
void	setDefaultActionName(java.lang.String defaultActionName) Sets the name of the default action.

Methods inherited from interface org.codehaus.groovy.grails.commons.InjectableGrailsClass

byName, byType, getAvailable

Methods inherited from interface org.codehaus.groovy.grails.commons.GrailsClass

getClazz, getFullName, getGrailsApplication, getLogicalPropertyName, getMetaClass, getName, getNaturalName, getPackageName, getPropertyName, getPropertyValue, getPropertyValue, getReference, getReferenceInstance, getShortName, hasProperty, isAbstract, newInstance

Methods inherited from interface org.codehaus.groovy.grails.plugins.support.aware.GrailsApplicationAware

setGrailsApplication

Field Detail

INDEX_ACTION

static final java.lang.String INDEX_ACTION

The name of the index action.

See Also:

Constant Field Values

BEFORE_INTERCEPTOR

static final java.lang.String BEFORE_INTERCEPTOR

The name of the before interceptor property.

See Also:

Constant Field Values

AFTER_INTERCEPTOR

static final java.lang.String AFTER_INTERCEPTOR

The name of the after interceptor property.

See Also:

Constant Field Values

CONTROLLER

static final java.lang.String CONTROLLER

The general name to use when referring to controller artefacts.

See Also:

Constant Field Values

ACTION

static final java.lang.String ACTION

The general name to use when referring to action artefacts.

See Also:

Constant Field Values

VIEW

static final java.lang.String VIEW

The general name to use when referring to action view.

See Also:

Constant Field Values

Method Detail

isHttpMethodAllowedForAction

boolean isHttpMethodAllowedForAction(GroovyObject controller,
                                     java.lang.String httpMethod,
                                     java.lang.String actionName)

Checks to see if an action is accessible via a particular http method.

Parameters:

controller - The instance of the controller

httpMethod - The http request method

actionName - The action to check

Returns:

true if the action is accessible via the specified http method

isInterceptedBefore

boolean isInterceptedBefore(GroovyObject controller,
                            java.lang.String action)

Checks whether the specified action is intercepted for the specified controller instance.

Parameters:

controller - The instance of the controller

action - The action to check

Returns:

True if it is intercepted

isInterceptedAfter

boolean isInterceptedAfter(GroovyObject controller,
                           java.lang.String action)

Checks whether the specified action is intercepted after for the specified controller instance.

Parameters:

controller - The controller instance

action - The action to check

Returns:

True if it is intercepted

getBeforeInterceptor

Closure getBeforeInterceptor(GroovyObject controller)

Retrieves the before interceptor for the specified controller instance.

Parameters:

controller - The controller instance

Returns:

The before interceptor as a Closure or null if non exists

getAfterInterceptor

Closure getAfterInterceptor(GroovyObject controller)

Retrieves the after interceptor for the specified controller instance.

Parameters:

controller - The controller instance

Returns:

The after interceptor as a Closure or null if non exists

getURIs

java.lang.String[] getURIs()

Gets the list of all possible URI's available in this controller.

Returns:

list of all possible URI's

mapsToURI

boolean mapsToURI(java.lang.String uri)

Tests if a controller maps to a given URI.

Returns:

true if controller maps to URI

getViewByURI

java.lang.String getViewByURI(java.lang.String uri)

Retrieves the view name for the specified URI.

Parameters:

uri - the name of URI

Returns:

the view name of null if not found

getViewByName

java.lang.String getViewByName(java.lang.String closureName)

Retrieves the view name for the specified closure name.

Parameters:

closureName - The name of the closure

Returns:

The view for the specified closure action

getMethodActionName

java.lang.String getMethodActionName(java.lang.String uri)

Returns a closure property name for a specific URI or null if the URI does not map to a closure.

Parameters:

uri - the URI of the request

Returns:

the closure property name mapped to the URI or null is no closure was found

getCommandObjectActions

@Deprecated
java.util.Set getCommandObjectActions()

Deprecated. This method is deprecated and will be removed in a future version of Grails

Returns:

A Set of names of actions with command objects presented in this controller

getCommandObjectClasses

@Deprecated
java.util.Set getCommandObjectClasses()

Deprecated. This method is deprecated and will be removed in a future version of Grails

Returns:

command object classes used by this controller

getFlows

java.util.Map getFlows()

Returns a map of the flows for this controller. A flow is an action that ends with the convention "Flow". The keys in the map are the flow ids which are the text before the "Flow" suffix. For example a flow called "bookFlow" would have a key of "book"

The values within the Map are Groovy closures (@see groovy.lang.Closure) which represent the flow definition

Returns:

A Map of flows for this controller

isFlowAction

boolean isFlowAction(java.lang.String actionName)

Returns true if the given action name is a flow action.

Parameters:

actionName - The name of the action

Returns:

True if it is a flow action

getDefaultAction

java.lang.String getDefaultAction()

Returns the default action for this Controller.

Returns:

The default action

registerMapping

void registerMapping(java.lang.String actionName)

Registers a new mapping onto this controller for the given actionName.

Parameters:

actionName - The actionName

setDefaultActionName

void setDefaultActionName(java.lang.String defaultActionName)

Sets the name of the default action.

Parameters:

defaultActionName - The default action name

initialize

void initialize()

Initialize the controller class