A

addResourceLoader(ResourceLoader) - Method in ViewResourceLocator

addSearchPath(String) - Method in ViewResourceLocator

AppResourceLoader - Class in grails.plugin.viewtools

A place for file resource related functionality which may required an application context or logged-in user.

ATTACHMENT_LOCATION_KEY - Field in AppResourceLoader

B

bindMockWebRequest(ApplicationContext, Writer, Locale) - Method in GrailsWebEnvironment

bindRequestIfNull(ApplicationContext, Writer, Locale) - Method in GrailsWebEnvironment

buildResourceKey(String) - Method in AppResourceLoader

buildView(String) - Method in LoaderUrlBasedViewResolver

C

close() - Method in GrailsWebEnvironment

concatPaths(String) - Method in ViewResourceLocator

ConfigKeyAppResourceLoader - Class in grails.plugin.viewtools

ConfigKeyAppResourceLoader provides ability to load resources from a directory configured as app resource location.

createAttachmentFile(Long, String, String, Object, String) - Method in AppResourceLoader

Creates (or move) file relative to the MonthDirectory.

createTempFile(String, Object) - Method in AppResourceLoader

Creates a temp file inside the tempDir and, optionally, populates it with data.

D

deleteTempUploadedFiles(List) - Method in AppResourceLoader

E

F

findInClassPath(String) - Method in ViewResourceLocator

search on the base classpath

findInGrailsViewPaths(String) - Method in ViewResourceLocator

Looks in grails-app/views with WEB-INF for production and without it for prod

findInSearchLoaders(String) - Method in ViewResourceLocator

findInSearchLocations(String) - Method in ViewResourceLocator

findResource(ResourceLoader, List<String>) - Method in ViewResourceLocator

searches the list of paths for a specific loader

findResourceInBinaryPlugin(BinaryGrailsPlugin, String) - Method in ViewResourceLocator

this will not work in Grails2.

findResourceInPlugin(GrailsPlugin, String) - Method in ViewResourceLocator

find the uri in the plugin

findResourceWithPluginPath(String) - Method in ViewResourceLocator

if uri starts with "/plugin/" then this attempts to resolve it @return

findWithPluginController(String) - Method in ViewResourceLocator

Attempts to resolve a uri relative to a plugin controller.

forceMkdir(String) - Method in AppResourceLoader

G

getAttachmentsRelativePath(File) - Method in AppResourceLoader

returns the path relative to the the attachments directory

getClassLoader() - Method in AppResourceLoader

getClassLoader() - Method in ConfigKeyAppResourceLoader

getClassLoader() - Method in ViewResourceLocator

getControllerName() - Method in GrailsWebEnvironment

getCurrentTenant() - Method in AppResourceLoader

getFile(String) - Method in AppResourceLoader

Shorthand way to get the attachment file with nothing but the location column contents.

getLocation(String, Map, boolean) - Method in AppResourceLoader

Get a configured directory location from a nine.resources key.

getMonthDirectory(String, boolean) - Method in AppResourceLoader

Gets a month directory for a configuration key.

getPathWithinContext() - Method in ViewResourceLocator.FileSystemContextResource

getPathWithinContext() - Method in ViewResourceLocator.ViewContextResource

getPluginViewPathInfo(String) - Method in ViewResourceLocator

getProperFile(String, String, boolean) - Method in AppResourceLoader

getProperFile builds a File from a name and ensures it exists, or throws an error.

getRelativePath(File, File) - Method in AppResourceLoader

gets the relative path of the child with respect to the parent The child must be inside of the parent or the resulting string is null.

getRelativeTempPath(File) - Method in AppResourceLoader

returns the path relative to the the temporary resource directory

getResource(String) - Method in AppResourceLoader

if location starts with a / then it realtive to the war (web-app).

getResource(String) - Method in ConfigKeyAppResourceLoader

getResource(String) - Method in SandboxResourceLoader

getResource(String) - Method in ViewResourceLocator

getResourceByPath(String) - Method in SandboxResourceLoader

getResourceConfig(String) - Method in AppResourceLoader

getResourceDirFromKey(String) - Method in AppResourceLoader

get resource dir relative to the config key if key is null then it return the root location

getResourceRelative(String, String) - Method in AppResourceLoader

gets a resource with a locationBase and a relative location - if relative location starts with "/" just pass it to getResource() and ignore locationBase (will look in war (web-app in dev)) - if locationBase is null then we will use a default getLocation('attachments.location') - if relative location starts with URL like classpath:,file:, http: it be passed directly to resourceLoader - if locationBase starts with config: then it will use whatever key comes after to find the location (ex- config:reports.location)

getRootLocation() - Method in AppResourceLoader

Gets the rootLocation which is the base for all the app-related directories.

getScripts(Map) - Method in AppResourceLoader

Get a list of script locations as absolute files.

getSubDirectory(String, String, boolean, Map) - Method in AppResourceLoader

getTempDir() - Method in AppResourceLoader

getTenantUniqueKey() - Method in AppResourceLoader

GrailsWebEnvironment - Class in grails.plugin.viewtools

based on the RenderEnvironment in grails-rendering and private class in grails-mail All this does is bind a mock request and mock response is one doesn't exist deals with setting the WrappedResponseHolder.wrappedResponse as well

GrailsWebEnvironment(ApplicationContext, Writer, Locale) - Constructor in GrailsWebEnvironment

H

I

init() - Method in AppResourceLoader

init() - Method in ViewResourceLocator

initCopy() - Method in GrailsWebEnvironment

J

K

L

LoaderUrlBasedViewResolver - Class in grails.plugin.viewtools

Uses Springs ViewResolver design concepts.

loadView(String, Locale) - Method in LoaderUrlBasedViewResolver

AbstractCachingViewResolver calls this if it doesn't get a hit on the cache Most of the calls to this will look like "/reports/xxx.xyz" etc..

locate(String) - Method in ViewResourceLocator

Find a view resource for a path.

M

mergeClientValues(Map) - Method in AppResourceLoader

If the service which wants this directory offers some additional values for substitution they can be passed in with an args map.

N

O

P

Q

R

S

SandboxResourceLoader - Class in grails.plugin.viewtools

FileSystemResourceLoader capable of understanding a base paths to search in for security see grails PluginPathAwareFileSystemResourceLoader CURRENTLY NOT USED

scanPluginsForResource(String) - Method in ViewResourceLocator

The nuclear approach that scans every plugin to find the view

setApplicationContext(ApplicationContext) - Method in ViewResourceLocator

setBaseAppResourceKey(String) - Method in ConfigKeyAppResourceLoader

setConfiguration(Config) - Method in AppResourceLoader

setPluginManager(GrailsPluginManager) - Method in ViewResourceLocator

setResourceLoader(ResourceLoader) - Method in ViewResourceLocator

adds a resourceLoader to the GrailResourceLoader

setSearchLocations(Collection<String>) - Method in SandboxResourceLoader

T

U

V

verifyOrCreateLocation(File, String, boolean, boolean) - Method in AppResourceLoader

verifyOrCreateLocation checks for validity of the directory before it's returned.

ViewResourceLocator - Class in grails.plugin.viewtools

Extended because the handy methods we want in DefaultGroovyPageLocator are protected.

ViewResourceLocator.FileSystemContextResource - Class in grails.plugin.viewtools

FileSystemResource that explicitly expresses a context-relative path through implementing the ContextResource interface.

ViewResourceLocator.FileSystemContextResource(String) - Constructor in ViewResourceLocator.FileSystemContextResource

ViewResourceLocator.PluginViewPathInfo - Class in grails.plugin.viewtools

ViewResourceLocator.PluginViewPathInfo(String) - Constructor in ViewResourceLocator.PluginViewPathInfo

ViewResourceLocator.ViewContextResource - Class in grails.plugin.viewtools

a simple resource that build from a URI and adds the base path the resource used to find it

ViewResourceLocator.ViewContextResource(URI, String) - Constructor in ViewResourceLocator.ViewContextResource

W

WEB_APP_DIRECTORY - Field in SandboxResourceLoader

withNew(ApplicationContext, Writer, Locale, Closure) - Method in GrailsWebEnvironment

Establish an environment with a specific locale

X

Y

Z

_