org.codehaus.groovy.grails.commons

Class StandaloneGrailsApplication

java.lang.Object

groovy.lang.GroovyObjectSupport

org.codehaus.groovy.grails.commons.StandaloneGrailsApplication

All Implemented Interfaces:

groovy.lang.GroovyObject, GrailsApplication, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.context.ApplicationContextAware

public class StandaloneGrailsApplication
extends groovy.lang.GroovyObjectSupport

GrailsApplication implementation to be used in standalone applications

Since:

2.4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected grails.util.Metadata	applicationMeta
protected java.lang.ClassLoader	classLoader
protected groovy.util.ConfigObject	config
protected java.util.Map	flatConfig
protected org.springframework.context.ApplicationContext	mainContext
protected org.springframework.context.ApplicationContext	parentContext

Fields inherited from interface org.codehaus.groovy.grails.commons.GrailsApplication

APPLICATION_ID, CLASS_EDITOR_BEAN, CLASS_LOADER_BEAN, CONFIG_CLASS, CUSTOM_EDITORS_BEAN, DATA_SOURCE_BEAN, DATA_SOURCE_CLASS, DIALECT_DETECTOR_BEAN, ENV_APPLICATION, ENV_DEVELOPMENT, ENV_PRODUCTION, ENV_TEST, ENVIRONMENT, ENVIRONMENT_DEFAULT, EXCEPTION_HANDLER_BEAN, GLOBAL_PLUGINS_DIR, HIBERNATE_PROPERTIES_BEAN, MESSAGE_SOURCE_BEAN, MULTIPART_RESOLVER_BEAN, OPEN_SESSION_IN_VIEW_INTERCEPTOR_BEAN, PLUGINS_DIR, PROJECT_CLASSES_DIR, PROJECT_META_FILE, PROJECT_RESOURCES_DIR, PROJECT_TEST_CLASSES_DIR, PROJECT_WORK_DIR, SESSION_FACTORY_BEAN, TRANSACTION_MANAGER_BEAN, WORK_DIR

Constructor Summary

Constructors

Constructor and Description
StandaloneGrailsApplication()

Method Summary

Modifier and Type	Method and Description
void	addArtefact(java.lang.Class artefact) Adds the given artefact, attempting to determine type from
GrailsClass	addArtefact(java.lang.String artefactType, java.lang.Class artefactClass) Registers a new artefact
GrailsClass	addArtefact(java.lang.String artefactType, GrailsClass artefactGrailsClass) Registers a new artefact
void	addOverridableArtefact(java.lang.Class artefact) Adds an artefact that can be overriden by user defined classes
void	configChanged() Fired to inform the application when the Config.groovy file changes.
java.lang.Class[]	getAllArtefacts() Retrieves all java.lang.Class instances considered Artefacts loaded by the Grails class loader
java.lang.Class[]	getAllClasses() Retrieves all java.lang.Class instances loaded by the Grails class loader
GrailsClass	getArtefact(java.lang.String artefactType, java.lang.String name) Gets the GrailsClass associated with the named artefact class
GrailsClass	getArtefactByLogicalPropertyName(java.lang.String type, java.lang.String logicalName) Retrieves an artefact by its logical property name.
GrailsClass	getArtefactForFeature(java.lang.String artefactType, java.lang.Object featureID) Get an artefact GrailsClass by a "feature" which depending on the artefact may be a URI or tag name for example
ArtefactHandler	getArtefactHandler(java.lang.String type) Returns the ArtefactHandler for the given type
ArtefactHandler[]	getArtefactHandlers() Obtain a list of all the artefact handlers
ArtefactInfo	getArtefactInfo(java.lang.String artefactType) Obtain all the class information about the artefactType specified
GrailsClass[]	getArtefacts(java.lang.String artefactType) Get an array of all the GrailsClass instances relating to artefacts of the specified type.
ArtefactHandler	getArtefactType(java.lang.Class theClass) Returns the ArtefactHandler for the given class or null
java.lang.Class	getClassForName(java.lang.String className) Retrieves a class for the given name within the GrailsApplication or returns null
java.lang.ClassLoader	getClassLoader() Returns the class loader instance for the Grails application.
groovy.util.ConfigObject	getConfig() Returns the ConfigObject instance.
java.util.Map<java.lang.String,java.lang.Object>	getFlatConfig() Returns the flatten ConfigObject for use from Java classes.
org.springframework.context.ApplicationContext	getMainContext() Returns the Spring context for this application.
grails.util.Metadata	getMetadata() Get access to the project's metadata, specified in application.properties
org.springframework.context.ApplicationContext	getParentContext() Returns the Spring application context that contains this application instance.
org.springframework.core.io.Resource	getResourceForClass(java.lang.Class theClazz) Retrieves a Resource instance for the given Grails class or null it doesn't exist.
boolean	hasArtefactHandler(java.lang.String type) Test whether an artefact handler exists for a given type
void	initialise() Initialise this GrailsApplication.
boolean	isArtefact(java.lang.Class theClazz) Call this to find out if the class you have is an artefact loaded by grails.
boolean	isArtefactOfType(java.lang.String artefactType, java.lang.Class theClazz) Check if the specified artefact Class has been loaded by Grails already AND is of the type expected
boolean	isArtefactOfType(java.lang.String artefactType, java.lang.String className) Check if the artefact Class with the name specified is of the type expected
boolean	isInitialised() Returns whether this GrailsApplication has been initialised or not.
boolean	isWarDeployed() Returns true if this application has been deployed as a WAR file
void	rebuild() Rebuilds this Application throwing away the class loader and re-constructing it from the loaded resources again.
void	refresh() This method will refresh the entire application
void	refreshConstraints() Rebuilds the constraint definitions.
void	registerArtefactHandler(ArtefactHandler handler) Register a new artefact handler
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setBeanClassLoader(java.lang.ClassLoader classLoader)
void	setConfig(groovy.util.ConfigObject config)
void	setMainContext(org.springframework.context.ApplicationContext context) Sets the main Spring context for this application.
void	updateFlatConfig()

Methods inherited from class groovy.lang.GroovyObjectSupport

getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

classLoader

protected java.lang.ClassLoader classLoader

config

protected groovy.util.ConfigObject config

flatConfig

protected java.util.Map flatConfig

parentContext

protected org.springframework.context.ApplicationContext parentContext

mainContext

protected org.springframework.context.ApplicationContext mainContext

applicationMeta

protected grails.util.Metadata applicationMeta

Constructor Detail

StandaloneGrailsApplication

public StandaloneGrailsApplication()

Method Detail

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getAllClasses

public java.lang.Class[] getAllClasses()

Description copied from interface: GrailsApplication

Retrieves all java.lang.Class instances loaded by the Grails class loader

Returns:

An array of classes

getAllArtefacts

public java.lang.Class[] getAllArtefacts()

Description copied from interface: GrailsApplication

Retrieves all java.lang.Class instances considered Artefacts loaded by the Grails class loader

Returns:

An array of classes

refreshConstraints

public void refreshConstraints()

Description copied from interface: GrailsApplication

Rebuilds the constraint definitions. TODO move this out? Why ORM dependencies in here?

refresh

public void refresh()

Description copied from interface: GrailsApplication

This method will refresh the entire application

rebuild

public void rebuild()

Description copied from interface: GrailsApplication

Rebuilds this Application throwing away the class loader and re-constructing it from the loaded resources again. Can only be called in development mode and an error will be thrown if called in a different enivronment

getResourceForClass

public org.springframework.core.io.Resource getResourceForClass(java.lang.Class theClazz)

Description copied from interface: GrailsApplication

Retrieves a Resource instance for the given Grails class or null it doesn't exist.

Parameters:

theClazz - The Grails class

Returns:

A Resource or null

isArtefact

public boolean isArtefact(java.lang.Class theClazz)

Description copied from interface: GrailsApplication

Call this to find out if the class you have is an artefact loaded by grails.

Parameters:

theClazz - A class to test

Returns:

true if and only if the class was loaded from grails-app/

isArtefactOfType

public boolean isArtefactOfType(java.lang.String artefactType,
                                java.lang.Class theClazz)

Description copied from interface: GrailsApplication

Check if the specified artefact Class has been loaded by Grails already AND is of the type expected

Parameters:

artefactType - A string identifying the artefact type to check for

theClazz - The class to check

Returns:

true if Grails considers the class to be managed as an artefact of the type specified.

isArtefactOfType

public boolean isArtefactOfType(java.lang.String artefactType,
                                java.lang.String className)

Description copied from interface: GrailsApplication

Check if the artefact Class with the name specified is of the type expected

Parameters:

artefactType - A string identifying the artefact type to check for

className - The name of a class to check

Returns:

true if Grails considers the class to be managed as an artefact of the type specified.

getArtefact

public GrailsClass getArtefact(java.lang.String artefactType,
                               java.lang.String name)

Description copied from interface: GrailsApplication

Gets the GrailsClass associated with the named artefact class

i.e. to get the GrailsClass for controller called "BookController" you pass the name "BookController"

Parameters:

artefactType - The type of artefact to retrieve, i.e. "Controller"

name - The name of an artefact such as "BookController"

Returns:

The associated GrailsClass or null

getArtefactType

public ArtefactHandler getArtefactType(java.lang.Class theClass)

Description copied from interface: GrailsApplication

Returns the ArtefactHandler for the given class or null

Parameters:

theClass - The class

Returns:

The ArtefactHandler

getArtefactInfo

public ArtefactInfo getArtefactInfo(java.lang.String artefactType)

Description copied from interface: GrailsApplication

Obtain all the class information about the artefactType specified

Parameters:

artefactType - An artefact type identifier i.e. "Domain"

Returns:

The artefact info or null if the artefactType is not recognized

getArtefacts

public GrailsClass[] getArtefacts(java.lang.String artefactType)

Description copied from interface: GrailsApplication

Get an array of all the GrailsClass instances relating to artefacts of the specified type.

Parameters:

artefactType - The type of artefact to retrieve, i.e. "Controller"

Returns:

An array of GrailsClasses which may empty by not null

getArtefactForFeature

public GrailsClass getArtefactForFeature(java.lang.String artefactType,
                                         java.lang.Object featureID)

Description copied from interface: GrailsApplication

Get an artefact GrailsClass by a "feature" which depending on the artefact may be a URI or tag name for example

Parameters:

artefactType - The type ID of the artefact, i.e. "TagLib"

featureID - The "feature" ID, say a URL or tag name

Returns:

The grails class or null if none is found

addArtefact

public GrailsClass addArtefact(java.lang.String artefactType,
                               java.lang.Class artefactClass)

Description copied from interface: GrailsApplication

Registers a new artefact

Parameters:

artefactType - The type ID of the artefact, i.e. "TagLib"

artefactClass - The class of the artefact. A new GrailsClass will be created automatically and added to internal structures, using the appropriate ArtefactHandler

Returns:

The new grails class for the artefact class

addArtefact

public GrailsClass addArtefact(java.lang.String artefactType,
                               GrailsClass artefactGrailsClass)

Description copied from interface: GrailsApplication

Registers a new artefact

Parameters:

artefactType - The type ID of the artefact, i.e. "TagLib"

artefactGrailsClass - The GrailsClass of the artefact.

Returns:

The supplied grails class for the artefact class

registerArtefactHandler

public void registerArtefactHandler(ArtefactHandler handler)

Description copied from interface: GrailsApplication

Register a new artefact handler

Parameters:

handler - The new handler to add

hasArtefactHandler

public boolean hasArtefactHandler(java.lang.String type)

Description copied from interface: GrailsApplication

Test whether an artefact handler exists for a given type

Parameters:

type - The type of the handler

Returns:

true if it does

getArtefactHandlers

public ArtefactHandler[] getArtefactHandlers()

Description copied from interface: GrailsApplication

Obtain a list of all the artefact handlers

Returns:

The list, possible empty but not null, of all currently registered handlers

initialise

public void initialise()

Description copied from interface: GrailsApplication

Initialise this GrailsApplication.

isInitialised

public boolean isInitialised()

Description copied from interface: GrailsApplication

Returns whether this GrailsApplication has been initialised or not.

Returns:

true if it has been initialised

getArtefactByLogicalPropertyName

public GrailsClass getArtefactByLogicalPropertyName(java.lang.String type,
                                                    java.lang.String logicalName)

Description copied from interface: GrailsApplication

Retrieves an artefact by its logical property name. For example the logical property name of BookController would be book.

Parameters:

type - The artefact type

logicalName - The logical name

Returns:

The GrailsClass or null if it doesn't exist

addArtefact

public void addArtefact(java.lang.Class artefact)

Description copied from interface: GrailsApplication

Adds the given artefact, attempting to determine type from

Parameters:

artefact - The artefact to add

addOverridableArtefact

public void addOverridableArtefact(java.lang.Class artefact)

Description copied from interface: GrailsApplication

Adds an artefact that can be overriden by user defined classes

Parameters:

artefact - An overridable artefact

getArtefactHandler

public ArtefactHandler getArtefactHandler(java.lang.String type)

Description copied from interface: GrailsApplication

Returns the ArtefactHandler for the given type

Parameters:

type - The artefact handler type

Returns:

The artefact handler

getMetadata

public grails.util.Metadata getMetadata()

Description copied from interface: GrailsApplication

Get access to the project's metadata, specified in application.properties

This provides access to information like required grails version, application name, version etc but NOT general application settings.

Specified by:

getMetadata in interface GrailsApplication

Returns:

A read-only Map of data about the application, not environment specific

isWarDeployed

public boolean isWarDeployed()

Description copied from interface: GrailsApplication

Returns true if this application has been deployed as a WAR file

Specified by:

isWarDeployed in interface GrailsApplication

Returns:

true if the application is WAR deployed

getConfig

public groovy.util.ConfigObject getConfig()

Description copied from interface: GrailsApplication

Returns the ConfigObject instance.

Specified by:

getConfig in interface GrailsApplication

Returns:

The ConfigObject instance

setConfig

public void setConfig(groovy.util.ConfigObject config)

updateFlatConfig

public void updateFlatConfig()

getFlatConfig

public java.util.Map<java.lang.String,java.lang.Object> getFlatConfig()

Description copied from interface: GrailsApplication

Returns the flatten ConfigObject for use from Java classes.

Specified by:

getFlatConfig in interface GrailsApplication

Returns:

The flattened config

configChanged

public void configChanged()

Description copied from interface: GrailsApplication

Fired to inform the application when the Config.groovy file changes.

Specified by:

configChanged in interface GrailsApplication

setBeanClassLoader

public void setBeanClassLoader(java.lang.ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface org.springframework.beans.factory.BeanClassLoaderAware

getClassLoader

public java.lang.ClassLoader getClassLoader()

Description copied from interface: GrailsApplication

Returns the class loader instance for the Grails application.

Specified by:

getClassLoader in interface GrailsApplication

Returns:

The ClassLoader instance

getClassForName

public java.lang.Class getClassForName(java.lang.String className)

Description copied from interface: GrailsApplication

Retrieves a class for the given name within the GrailsApplication or returns null

Specified by:

getClassForName in interface GrailsApplication

Parameters:

className - The name of the class

Returns:

The class or null

getMainContext

public org.springframework.context.ApplicationContext getMainContext()

Description copied from interface: GrailsApplication

Returns the Spring context for this application. Note that this will return null until the application is fully initialised. This context contains all the application artifacts, plugin beans, the works.

Specified by:

getMainContext in interface GrailsApplication

setMainContext

public void setMainContext(org.springframework.context.ApplicationContext context)

Description copied from interface: GrailsApplication

Sets the main Spring context for this application.

Specified by:

setMainContext in interface GrailsApplication

getParentContext

public org.springframework.context.ApplicationContext getParentContext()

Description copied from interface: GrailsApplication

Returns the Spring application context that contains this application instance. It is the parent of the context returned by GrailsApplication.getMainContext().

Specified by:

getParentContext in interface GrailsApplication