org.codehaus.groovy.grails.web.mapping

Class CachingLinkGenerator

java.lang.Object

org.codehaus.groovy.grails.web.mapping.DefaultLinkGenerator

org.codehaus.groovy.grails.web.mapping.CachingLinkGenerator

All Implemented Interfaces:

groovy.lang.GroovyObject, org.codehaus.groovy.grails.plugins.PluginManagerAware, LinkGenerator, org.springframework.beans.factory.Aware

public class CachingLinkGenerator
extends org.codehaus.groovy.grails.web.mapping.DefaultLinkGenerator

A link generator that uses a LRU cache to cache generated links.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_MAP_STRING
static java.lang.String	LINK_PREFIX
static java.lang.String	RESOURCE_PREFIX
static java.lang.String	USED_ATTRIBUTES_SUFFIX

Fields inherited from interface org.codehaus.groovy.grails.web.mapping.LinkGenerator

ATTRIBUTE_ABSOLUTE, ATTRIBUTE_ACTION, ATTRIBUTE_BASE, ATTRIBUTE_CONTEXT_PATH, ATTRIBUTE_CONTROLLER, ATTRIBUTE_ELEMENT_ID, ATTRIBUTE_EVENT, ATTRIBUTE_FRAGMENT, ATTRIBUTE_ID, ATTRIBUTE_MAPPING, ATTRIBUTE_METHOD, ATTRIBUTE_PARAMS, ATTRIBUTE_RELATIVE_URI, ATTRIBUTE_RESOURCE, ATTRIBUTE_URI, ATTRIBUTE_URL, LINK_ATTRIBUTES

Constructor Summary

Constructors

Constructor and Description
CachingLinkGenerator(java.lang.String serverBaseURL)
CachingLinkGenerator(java.lang.String serverBaseURL, java.util.Map<java.lang.String,java.lang.Object> linkCache)
CachingLinkGenerator(java.lang.String serverBaseURL, java.lang.String contextPath)
CachingLinkGenerator(java.lang.String serverBaseURL, java.lang.String contextPath, java.util.Map<java.lang.String,java.lang.Object> linkCache)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache()
protected java.lang.String	getCacheKeyValueForResource(java.lang.Object o)
java.lang.String	link(java.util.Map attrs, java.lang.String encoding) Generates a link to a controller, action or URI for the given named parameters.
protected java.lang.String	makeKey(java.lang.String prefix, java.util.Map attrs)
java.lang.String	resource(java.util.Map attrs) Generates a link to a static resource for the given named parameters.

Methods inherited from class org.codehaus.groovy.grails.web.mapping.DefaultLinkGenerator

getConfiguredServerBaseURL, getContextPath, getGrailsUrlConverter, getMappingContext, getPluginManager, getRequestStateLookupStrategy, getResourceId, getServerBaseURL, getUrlMappingsHolder, isAbsolute, link, makeServerURL, setConfiguredServerBaseURL, setContextPath, setGrailsUrlConverter, setMappingContext, setPluginManager, setRequestStateLookupStrategy, setUrlMappingsHolder

Methods inherited from class java.lang.Object

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

Methods inherited from interface groovy.lang.GroovyObject

getMetaClass, getProperty, invokeMethod, setMetaClass, setProperty

Field Detail

LINK_PREFIX

public static final java.lang.String LINK_PREFIX

See Also:

Constant Field Values

RESOURCE_PREFIX

public static final java.lang.String RESOURCE_PREFIX

See Also:

Constant Field Values

USED_ATTRIBUTES_SUFFIX

public static final java.lang.String USED_ATTRIBUTES_SUFFIX

See Also:

Constant Field Values

EMPTY_MAP_STRING

public static final java.lang.String EMPTY_MAP_STRING

See Also:

Constant Field Values

Constructor Detail

CachingLinkGenerator

public CachingLinkGenerator(java.lang.String serverBaseURL,
                    java.lang.String contextPath)

CachingLinkGenerator

public CachingLinkGenerator(java.lang.String serverBaseURL)

CachingLinkGenerator

public CachingLinkGenerator(java.lang.String serverBaseURL,
                    java.util.Map<java.lang.String,java.lang.Object> linkCache)

CachingLinkGenerator

public CachingLinkGenerator(java.lang.String serverBaseURL,
                    java.lang.String contextPath,
                    java.util.Map<java.lang.String,java.lang.Object> linkCache)

Method Detail

link

public java.lang.String link(java.util.Map attrs,
                    java.lang.String encoding)

Description copied from interface: LinkGenerator

Generates a link to a controller, action or URI for the given named parameters. Possible named parameters include:

• resource - If linking to a REST resource, the name of the resource or resource path to link to. Either 'resource' or 'controller' should be specified, but not both
• controller - The name of the controller to use in the link, if not specified the current controller will be linked
• action - The name of the action to use in the link, if not specified the default action will be linked
• uri - relative URI
• url - A map containing the action,controller,id etc.
• base - Sets the prefix to be added to the link target address, typically an absolute server URL. This overrides the behaviour of the absolute property, if both are specified.
• absolute - If set to "true" will prefix the link target address with the value of the grails.serverURL property from Config, or http://localhost:<port> if no value in Config and not running in production.
• id - The id to use in the link
• fragment - The link fragment (often called anchor tag) to use
• params - A map containing URL query parameters
• mapping - The named URL mapping to use to rewrite the link
• event - Webflow _eventId parameter

Specified by:

link in interface LinkGenerator

Overrides:

link in class org.codehaus.groovy.grails.web.mapping.DefaultLinkGenerator

Parameters:

attrs - The named parameters

encoding - The character encoding to use

Returns:

The generator link

getCacheKeyValueForResource

protected java.lang.String getCacheKeyValueForResource(java.lang.Object o)

resource

public java.lang.String resource(java.util.Map attrs)

Description copied from interface: LinkGenerator

Generates a link to a static resource for the given named parameters. Possible named parameters include:

• base - The base path of the URL, typically an absolute server path
• contextPath - The context path to link to, defaults to the servlet context path
• dir - The directory to link to
• file - The file to link to (relative to the directory if specified)
• plugin - The plugin that provides the resource
• absolute - Whether the link should be absolute or not

Specified by:

resource in interface LinkGenerator

Overrides:

resource in class org.codehaus.groovy.grails.web.mapping.DefaultLinkGenerator

Parameters:

attrs - The named parameters

Returns:

The link to the static resource

makeKey

protected java.lang.String makeKey(java.lang.String prefix,
                       java.util.Map attrs)

clearCache

public void clearCache()