org.codehaus.groovy.grails.commons

Class ControllerArtefactHandler

java.lang.Object

org.codehaus.groovy.grails.commons.ArtefactHandlerAdapter

org.codehaus.groovy.grails.commons.ControllerArtefactHandler

All Implemented Interfaces:

ArtefactHandler, GrailsApplicationAware, org.springframework.beans.factory.Aware

public class ControllerArtefactHandler
extends ArtefactHandlerAdapter
implements GrailsApplicationAware

Lookup controllers for uris.

This class is responsible for looking up controller classes for uris.

Lookups are cached in non-development mode, and the cache size can be controlled using the grails.urlmapping.cache.maxsize config property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ControllerArtefactHandler.ControllerCacheKey

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_NAME
static java.lang.String	TYPE

Fields inherited from class org.codehaus.groovy.grails.commons.ArtefactHandlerAdapter

log

Constructor Summary

Constructors

Constructor and Description
ControllerArtefactHandler()

Method Summary

Modifier and Type	Method and Description
GrailsClass	getArtefactForFeature(java.lang.Object featureId) Called to retrieve an artefact relating to some other key for example a URI or tag name
java.lang.String	getPluginName() Obtains the plugin name that deals with this artefact.
void	initialize(ArtefactInfo artefacts) Sets up the relationships between the domain classes, this has to be done after the intial creation to avoid looping.
protected boolean	namespaceMatches(GrailsControllerClass c, java.lang.String namespace)
protected boolean	pluginMatches(GrailsClass c, java.lang.String pluginName, GrailsPluginManager grailsPluginManager)
void	setGrailsApplication(GrailsApplication grailsApplication) This method is called by the ApplicationContext that loads the Grails application.

Methods inherited from class org.codehaus.groovy.grails.commons.ArtefactHandlerAdapter

getType, isArtefact, isArtefactClass, isArtefactGrailsClass, newArtefactClass

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

PLUGIN_NAME

public static final java.lang.String PLUGIN_NAME

See Also:

Constant Field Values

Constructor Detail

ControllerArtefactHandler

public ControllerArtefactHandler()

Method Detail

initialize

public void initialize(ArtefactInfo artefacts)

Description copied from class: ArtefactHandlerAdapter

Sets up the relationships between the domain classes, this has to be done after the intial creation to avoid looping.

Specified by:

initialize in interface ArtefactHandler

Overrides:

initialize in class ArtefactHandlerAdapter

Parameters:

artefacts - The collection of artefact classes for this handler

getPluginName

public java.lang.String getPluginName()

Description copied from interface: ArtefactHandler

Obtains the plugin name that deals with this artefact.

Specified by:

getPluginName in interface ArtefactHandler

Overrides:

getPluginName in class ArtefactHandlerAdapter

Returns:

The plugin name or null if there isn't one

getArtefactForFeature

public GrailsClass getArtefactForFeature(java.lang.Object featureId)

Description copied from interface: ArtefactHandler

Called to retrieve an artefact relating to some other key for example a URI or tag name

Handlers are responsible for caching the appropriate information using the data passed to them in calls to initialize()

Specified by:

getArtefactForFeature in interface ArtefactHandler

Overrides:

getArtefactForFeature in class ArtefactHandlerAdapter

Parameters:

featureId - Any object that acts as a key

Returns:

A matching artefact GrailsClass or null if there is no match for this feature ID

namespaceMatches

protected boolean namespaceMatches(GrailsControllerClass c,
                                   java.lang.String namespace)

Parameters:

c - the class to inspect

namespace - a controller namespace

Returns:

true if c is in namespace

pluginMatches

protected boolean pluginMatches(GrailsClass c,
                                java.lang.String pluginName,
                                GrailsPluginManager grailsPluginManager)

Parameters:

c - the class to inspect

pluginName - the name of a plugin

grailsPluginManager - the plugin manager

Returns:

true if c is provided by a plugin with the name pluginName or if pluginName is null, otherwise false

setGrailsApplication

public void setGrailsApplication(GrailsApplication grailsApplication)

Description copied from interface: GrailsApplicationAware

This method is called by the ApplicationContext that loads the Grails application. The GrailsApplication instance that represents the loaded Grails application is injected.

Specified by:

setGrailsApplication in interface GrailsApplicationAware

Parameters:

grailsApplication - the GrailsApplication object that represents this Grails application