org.codehaus.groovy.grails.web.servlet

Class DefaultGrailsApplicationAttributes

java.lang.Object

org.codehaus.groovy.grails.web.servlet.DefaultGrailsApplicationAttributes

All Implemented Interfaces:

org.codehaus.groovy.grails.commons.ApplicationAttributes, GrailsApplicationAttributes

public class DefaultGrailsApplicationAttributes
extends java.lang.Object
implements GrailsApplicationAttributes

Holds knowledge about how to obtain certain attributes from either the ServletContext or the HttpServletRequest instance.

Since:

0.3

See Also:

GrailsWebRequest

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DEFAULT_NAMESPACE

Fields inherited from interface org.codehaus.groovy.grails.web.servlet.GrailsApplicationAttributes

ACTION_NAME_ATTRIBUTE, APP_URI_ATTRIBUTE, ASYNC_STARTED, CONTENT_FORMAT, CONTROLLER, CONTROLLER_NAME_ATTRIBUTE, CONTROLLER_NAMESPACE_ATTRIBUTE, ERRORS, FLASH_SCOPE, GRAILS_CONTROLLER_CLASS, GRAILS_CONTROLLER_CLASS_AVAILABLE, GSP_CODEC, GSP_TEMPLATE_ENGINE, GSP_TMP_WRITER, GSP_TO_RENDER, ID_PARAM, MODEL_AND_VIEW, OUT, PAGE_SCOPE, PARAMS_OBJECT, PATH_TO_VIEWS, PROPERTY_REGISTRY, REDIRECT_ISSUED, RENDERING_ERROR_ATTRIBUTE, REQUEST_FORMATS, REQUEST_REDIRECTED_ATTRIBUTE, RESPONSE_FORMAT, RESPONSE_FORMATS, RESPONSE_MIME_TYPE, RESPONSE_MIME_TYPES, TAG_CACHE, TEMPLATE_MODEL, WEB_REQUEST

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

APPLICATION_CONTEXT, PARENT_APPLICATION_CONTEXT, PLUGIN_MANAGER, REQUEST_SCOPE_ID

Constructor Summary

Constructors

Constructor and Description
DefaultGrailsApplicationAttributes(javax.servlet.ServletContext context)

Method Summary

Modifier and Type	Method and Description
org.springframework.context.ApplicationContext	getApplicationContext()
java.lang.String	getApplicationUri(javax.servlet.ServletRequest request) Deprecated. Use instead
groovy.lang.GroovyObject	getController(javax.servlet.ServletRequest request)
java.lang.String	getControllerActionUri(javax.servlet.ServletRequest request)
java.lang.String	getControllerUri(javax.servlet.ServletRequest request)
org.springframework.validation.Errors	getErrors(javax.servlet.ServletRequest request)
FlashScope	getFlashScope(javax.servlet.ServletRequest request) Retrieves the flash scope instance for the given requeste
org.codehaus.groovy.grails.commons.GrailsApplication	getGrailsApplication()
GroovyPagesUriService	getGroovyPagesUriService()
org.springframework.context.MessageSource	getMessageSource()
java.lang.String	getNoSuffixViewURI(groovy.lang.GroovyObject controller, java.lang.String viewName)
java.io.Writer	getOut(javax.servlet.http.HttpServletRequest request) Holds the current response write for the request
ResourceAwareTemplateEngine	getPagesTemplateEngine()
java.lang.String	getPluginContextPath(javax.servlet.http.HttpServletRequest request) Retrieves the plugin context path for the current request.
javax.servlet.ServletContext	getServletContext() Retrieves the servlet context instance
groovy.lang.GroovyObject	getTagLibraryForTag(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String tagName) Retrieves a Grails tag library from the request for the named tag in the default namespace GroovyPage.DEFAULT_NAMESPACE
groovy.lang.GroovyObject	getTagLibraryForTag(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String tagName, java.lang.String namespace) Retrieves a Grails tag library from the request for the named tag in a given namespace.
java.lang.String	getTemplateUri(java.lang.CharSequence templateName, javax.servlet.ServletRequest request)
java.lang.String	getTemplateURI(groovy.lang.GroovyObject controller, java.lang.String templateName)
java.lang.String	getViewUri(java.lang.String viewName, javax.servlet.http.HttpServletRequest request) Retrieves the uri of a named view
void	setOut(javax.servlet.http.HttpServletRequest request, java.io.Writer out2) Sets the current write for the request

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NAMESPACE

protected static final java.lang.String DEFAULT_NAMESPACE

See Also:

Constant Field Values

Constructor Detail

DefaultGrailsApplicationAttributes

public DefaultGrailsApplicationAttributes(javax.servlet.ServletContext context)

Method Detail

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface org.codehaus.groovy.grails.commons.ApplicationAttributes

getPluginContextPath

public java.lang.String getPluginContextPath(javax.servlet.http.HttpServletRequest request)

Description copied from interface: GrailsApplicationAttributes

Retrieves the plugin context path for the current request. The plugin context path is the path used by plugins to reference resources such as javascript, CSS and so forth It is established by evaluating the current controller, if the current controller is plugin provided then it will attempt to evaluate the path based on the plugin the controller came from

Specified by:

getPluginContextPath in interface GrailsApplicationAttributes

Returns:

The plugin context path

getController

public groovy.lang.GroovyObject getController(javax.servlet.ServletRequest request)

Specified by:

getController in interface GrailsApplicationAttributes

Returns:

The controller for the request

getControllerUri

public java.lang.String getControllerUri(javax.servlet.ServletRequest request)

Specified by:

getControllerUri in interface GrailsApplicationAttributes

Returns:

The uri of the controller within the request

getApplicationUri

@Deprecated
public java.lang.String getApplicationUri(javax.servlet.ServletRequest request)

Deprecated. Use instead

Specified by:

getApplicationUri in interface GrailsApplicationAttributes

Parameters:

request - The Servlet Reqest

Returns:

The Application URI

getServletContext

public javax.servlet.ServletContext getServletContext()

Description copied from interface: GrailsApplicationAttributes

Retrieves the servlet context instance

Specified by:

getServletContext in interface GrailsApplicationAttributes

Returns:

The servlet context instance

getFlashScope

public FlashScope getFlashScope(javax.servlet.ServletRequest request)

Description copied from interface: GrailsApplicationAttributes

Retrieves the flash scope instance for the given requeste

Specified by:

getFlashScope in interface GrailsApplicationAttributes

Returns:

The FlashScope instance

getTemplateUri

public java.lang.String getTemplateUri(java.lang.CharSequence templateName,
                                       javax.servlet.ServletRequest request)

Specified by:

getTemplateUri in interface GrailsApplicationAttributes

Returns:

The uri of a named template for the current controller

getViewUri

public java.lang.String getViewUri(java.lang.String viewName,
                                   javax.servlet.http.HttpServletRequest request)

Description copied from interface: GrailsApplicationAttributes

Retrieves the uri of a named view

Specified by:

getViewUri in interface GrailsApplicationAttributes

Parameters:

viewName - The name of the view

request - The request instance

Returns:

The name of the view

getControllerActionUri

public java.lang.String getControllerActionUri(javax.servlet.ServletRequest request)

Specified by:

getControllerActionUri in interface GrailsApplicationAttributes

Returns:

The uri of the action called within the controller

getErrors

public org.springframework.validation.Errors getErrors(javax.servlet.ServletRequest request)

Specified by:

getErrors in interface GrailsApplicationAttributes

Returns:

The errors instance contained within the request

getPagesTemplateEngine

public ResourceAwareTemplateEngine getPagesTemplateEngine()

Specified by:

getPagesTemplateEngine in interface GrailsApplicationAttributes

Returns:

Retrieves the shared GSP template engine

getGrailsApplication

public org.codehaus.groovy.grails.commons.GrailsApplication getGrailsApplication()

Specified by:

getGrailsApplication in interface org.codehaus.groovy.grails.commons.ApplicationAttributes

getTagLibraryForTag

public groovy.lang.GroovyObject getTagLibraryForTag(javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response,
                                                    java.lang.String tagName)

Description copied from interface: GrailsApplicationAttributes

Retrieves a Grails tag library from the request for the named tag in the default namespace GroovyPage.DEFAULT_NAMESPACE

Specified by:

getTagLibraryForTag in interface GrailsApplicationAttributes

Parameters:

request - the request instance

response - the response instancte

tagName - The name of the tag that contains the tag library

Returns:

An instance of the tag library or null if not found

getTagLibraryForTag

public groovy.lang.GroovyObject getTagLibraryForTag(javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response,
                                                    java.lang.String tagName,
                                                    java.lang.String namespace)

Description copied from interface: GrailsApplicationAttributes

Retrieves a Grails tag library from the request for the named tag in a given namespace.

Specified by:

getTagLibraryForTag in interface GrailsApplicationAttributes

Parameters:

request - the request instance

response - the response instancte

tagName - The name of the tag that contains the tag library

namespace - The namespace of the tag

Returns:

An instance of the tag library or null if not found

getOut

public java.io.Writer getOut(javax.servlet.http.HttpServletRequest request)

Description copied from interface: GrailsApplicationAttributes

Holds the current response write for the request

Specified by:

getOut in interface GrailsApplicationAttributes

Returns:

The held response writer

setOut

public void setOut(javax.servlet.http.HttpServletRequest request,
                   java.io.Writer out2)

Description copied from interface: GrailsApplicationAttributes

Sets the current write for the request

Specified by:

setOut in interface GrailsApplicationAttributes

Parameters:

request - The request

out2 - The writer

getNoSuffixViewURI

public java.lang.String getNoSuffixViewURI(groovy.lang.GroovyObject controller,
                                           java.lang.String viewName)

Specified by:

getNoSuffixViewURI in interface GrailsApplicationAttributes

getTemplateURI

public java.lang.String getTemplateURI(groovy.lang.GroovyObject controller,
                                       java.lang.String templateName)

Specified by:

getTemplateURI in interface GrailsApplicationAttributes

getGroovyPagesUriService

public GroovyPagesUriService getGroovyPagesUriService()

Specified by:

getGroovyPagesUriService in interface GrailsApplicationAttributes

getMessageSource

public org.springframework.context.MessageSource getMessageSource()

Specified by:

getMessageSource in interface GrailsApplicationAttributes