Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.codehaus.groovy.grails.io.support
[Java] Class GrailsResourceUtils

java.lang.Object
  org.codehaus.groovy.grails.io.support.GrailsResourceUtils

public class GrailsResourceUtils
extends java.lang.Object

Utility methods for resource handling / figuring out class names.

Authors:
Graeme Rocher
Juergen Hoeller
Since:
2.0

Field Summary
static java.lang.String CLASSPATH_URL_PREFIX

Pseudo URL prefix for loading from the class path: "classpath:"
static java.util.regex.Pattern[] COMPILER_ROOT_PATTERNS

static java.util.regex.Pattern DOMAIN_PATH_PATTERN

static java.lang.String FILE_URL_PREFIX

URL prefix for loading from the file system: "file:"
static java.lang.String GRAILS_APP_DIR

The name of the Grails application directory
static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_EIGHTH_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_ELEVENTH_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_FIFTH_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_FIRST_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_FOURTH_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_NINTH_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_SECOND_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_SEVENTH_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_SIXTH_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_TENTH_MATCH

static java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_THIRD_MATCH

static java.lang.String JAR_URL_SEPARATOR

static java.lang.String REGEX_FILE_SEPARATOR

static java.util.regex.Pattern RESOURCE_PATH_PATTERN

static java.util.regex.Pattern SPRING_SCRIPTS_PATH_PATTERN

static java.lang.String URL_PROTOCOL_CODE_SOURCE

URL protocol for an entry from an OC4J jar file: "code-source"
static java.lang.String URL_PROTOCOL_FILE

URL protocol for a file in the file system: "file"
static java.lang.String URL_PROTOCOL_JAR

URL protocol for an entry from a jar file: "jar"
static java.lang.String URL_PROTOCOL_VFS

URL protocol for a JBoss VFS resource: "vfs"
static java.lang.String URL_PROTOCOL_VFSZIP

URL protocol for an entry from a JBoss jar file: "vfszip"
static java.lang.String URL_PROTOCOL_WSJAR

URL protocol for an entry from a WebSphere jar file: "wsjar"
static java.lang.String URL_PROTOCOL_ZIP

URL protocol for an entry from a zip file: "zip"
static java.lang.String VIEWS_DIR_PATH

The path to the views directory
static java.lang.String WEB_APP_DIR

The name of the Web app dir within Grails
static java.lang.String WEB_INF

The relative path to the WEB-INF directory
static java.util.regex.Pattern[] patterns

 
Method Summary
static java.lang.String appendPiecesForUri(java.lang.String... pieces)

static java.lang.String applyRelativePath(java.lang.String path, java.lang.String relativePath)

Apply the given relative path to the given path, assuming standard Java folder separation (i.e. "/" separators).
static java.lang.String classPackageAsResourcePath(java.lang.Class clazz)

Given an input class object, return a string which consists of the class's package name as a pathname, i.e., all dots ('.') are replaced by slashes ('/').

static java.lang.String cleanPath(java.lang.String path)

Normalize the path by suppressing sequences like "path/.." and inner simple dots.
static java.net.URL extractJarFileURL(java.net.URL jarUrl)

static Resource getAppDir(Resource resource)

static java.lang.String getArtefactDirectory(java.lang.String path)

static java.lang.String getClassName(Resource resource)

Gets the class name of the specified Grails resource
static java.lang.String getClassName(java.lang.String path)

Returns the class name for a Grails resource.
static java.io.File getFile(java.net.URL resourceUrl, java.lang.String description)

Resolve the given resource URL to a java.io.File, i.e. to a file in the file system.
static java.io.File getFile(java.net.URI resourceUri, java.lang.String description)

Resolve the given resource URI to a java.io.File, i.e. to a file in the file system.
static java.io.File getFile(java.net.URI resourceUri)

Resolve the given resource URI to a java.io.File, i.e. to a file in the file system.
static java.lang.String getFilename(java.lang.String path)

Extract the filename from the given path, e.g.

static java.lang.String getPathFromRoot(java.lang.String path)

Get the path relative to an artefact folder under grails-app i.e:
static java.lang.String getRelativeInsideWebInf(Resource resource)

static java.lang.String getStaticResourcePathForResource(Resource resource, java.lang.String contextPath)

static Resource getViewsDir(Resource resource)

static java.lang.Object instantiateFromConfig(groovy.util.ConfigObject config, java.lang.String configKey, java.lang.String defaultClassName)

static java.lang.Object instantiateFromFlatConfig(java.util.Map flatConfig, java.lang.String configKey, java.lang.String defaultClassName)

static boolean isDomainClass(java.net.URL url)

Checks whether the file referenced by the given url is a domain class
static boolean isFileURL(java.net.URL url)

Determine whether the given URL points to a resource in the file system, that is, has protocol "file" or "vfs".
static boolean isGrailsPath(java.lang.String path)

static boolean isGrailsResource(Resource r)

static boolean isJarURL(java.net.URL url)

Determine whether the given URL points to a resource in a jar file, that is, has protocol "jar", "zip", "wsjar" or "code-source".
static java.net.URI toURI(java.net.URL url)

Create a URI instance for the given URL, replacing spaces with "%20" quotes first.
static java.net.URI toURI(java.lang.String location)

Create a URI instance for the given location String, replacing spaces with "%20" quotes first.
static void useCachesIfNecessary(java.net.URLConnection con)

 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Field Detail

CLASSPATH_URL_PREFIX

public static final java.lang.String CLASSPATH_URL_PREFIX
Pseudo URL prefix for loading from the class path: "classpath:"

COMPILER_ROOT_PATTERNS

public static java.util.regex.Pattern[] COMPILER_ROOT_PATTERNS

DOMAIN_PATH_PATTERN

public static java.util.regex.Pattern DOMAIN_PATH_PATTERN

FILE_URL_PREFIX

public static final java.lang.String FILE_URL_PREFIX
URL prefix for loading from the file system: "file:"

GRAILS_APP_DIR

public static final java.lang.String GRAILS_APP_DIR
The name of the Grails application directory

GRAILS_RESOURCE_PATTERN_EIGHTH_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_EIGHTH_MATCH

GRAILS_RESOURCE_PATTERN_ELEVENTH_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_ELEVENTH_MATCH

GRAILS_RESOURCE_PATTERN_FIFTH_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_FIFTH_MATCH

GRAILS_RESOURCE_PATTERN_FIRST_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_FIRST_MATCH

GRAILS_RESOURCE_PATTERN_FOURTH_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_FOURTH_MATCH

GRAILS_RESOURCE_PATTERN_NINTH_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_NINTH_MATCH

GRAILS_RESOURCE_PATTERN_SECOND_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_SECOND_MATCH

GRAILS_RESOURCE_PATTERN_SEVENTH_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_SEVENTH_MATCH

GRAILS_RESOURCE_PATTERN_SIXTH_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_SIXTH_MATCH

GRAILS_RESOURCE_PATTERN_TENTH_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_TENTH_MATCH

GRAILS_RESOURCE_PATTERN_THIRD_MATCH

public static final java.util.regex.Pattern GRAILS_RESOURCE_PATTERN_THIRD_MATCH

JAR_URL_SEPARATOR

public static final java.lang.String JAR_URL_SEPARATOR

REGEX_FILE_SEPARATOR

public static final java.lang.String REGEX_FILE_SEPARATOR

RESOURCE_PATH_PATTERN

public static java.util.regex.Pattern RESOURCE_PATH_PATTERN

SPRING_SCRIPTS_PATH_PATTERN

public static java.util.regex.Pattern SPRING_SCRIPTS_PATH_PATTERN

URL_PROTOCOL_CODE_SOURCE

public static final java.lang.String URL_PROTOCOL_CODE_SOURCE
URL protocol for an entry from an OC4J jar file: "code-source"

URL_PROTOCOL_FILE

public static final java.lang.String URL_PROTOCOL_FILE
URL protocol for a file in the file system: "file"

URL_PROTOCOL_JAR

public static final java.lang.String URL_PROTOCOL_JAR
URL protocol for an entry from a jar file: "jar"

URL_PROTOCOL_VFS

public static final java.lang.String URL_PROTOCOL_VFS
URL protocol for a JBoss VFS resource: "vfs"

URL_PROTOCOL_VFSZIP

public static final java.lang.String URL_PROTOCOL_VFSZIP
URL protocol for an entry from a JBoss jar file: "vfszip"

URL_PROTOCOL_WSJAR

public static final java.lang.String URL_PROTOCOL_WSJAR
URL protocol for an entry from a WebSphere jar file: "wsjar"

URL_PROTOCOL_ZIP

public static final java.lang.String URL_PROTOCOL_ZIP
URL protocol for an entry from a zip file: "zip"

VIEWS_DIR_PATH

public static final java.lang.String VIEWS_DIR_PATH
The path to the views directory

WEB_APP_DIR

public static final java.lang.String WEB_APP_DIR
The name of the Web app dir within Grails

WEB_INF

public static final java.lang.String WEB_INF
The relative path to the WEB-INF directory

patterns

public static final java.util.regex.Pattern[] patterns

 
Method Detail

appendPiecesForUri

public static java.lang.String appendPiecesForUri(java.lang.String... pieces)

applyRelativePath

public static java.lang.String applyRelativePath(java.lang.String path, java.lang.String relativePath)
Apply the given relative path to the given path, assuming standard Java folder separation (i.e. "/" separators).
Parameters:
path - the path to start from (usually a full file path)
relativePath - the relative path to apply (relative to the full file path above)
Returns:
the full file path that results from applying the relative path

classPackageAsResourcePath

public static java.lang.String classPackageAsResourcePath(java.lang.Class clazz)
Given an input class object, return a string which consists of the class's package name as a pathname, i.e., all dots ('.') are replaced by slashes ('/'). Neither a leading nor trailing slash is added. The result could be concatenated with a slash and the name of a resource and fed directly to ClassLoader.getResource(). For it to be fed to Class.getResource instead, a leading slash would also have to be prepended to the returned value.
Parameters:
clazz - the input class. A null value or the default (empty) package will result in an empty string ("") being returned.
Returns:
a path which represents the package name
See Also:
java.lang.ClassLoader#getResource
java.lang.Class#getResource

cleanPath

public static java.lang.String cleanPath(java.lang.String path)
Normalize the path by suppressing sequences like "path/.." and inner simple dots.

The result is convenient for path comparison. For other uses, notice that Windows separators ("\") are replaced by simple slashes.

Parameters:
path - the original path
Returns:
the normalized path

extractJarFileURL

public static java.net.URL extractJarFileURL(java.net.URL jarUrl)

getAppDir

public static Resource getAppDir(Resource resource)

getArtefactDirectory

public static java.lang.String getArtefactDirectory(java.lang.String path)

getClassName

public static java.lang.String getClassName(Resource resource)
Gets the class name of the specified Grails resource
Parameters:
resource - The Spring Resource
Returns:
The class name or null if the resource is not a Grails class

getClassName

public static java.lang.String getClassName(java.lang.String path)
Returns the class name for a Grails resource.
Parameters:
path - The path to check
Returns:
The class name or null if it doesn't exist

getFile

public static java.io.File getFile(java.net.URL resourceUrl, java.lang.String description)
Resolve the given resource URL to a java.io.File, i.e. to a file in the file system.
throws:
java.io.FileNotFoundException if the URL cannot be resolved to a file in the file system
Parameters:
resourceUrl - the resource URL to resolve
description - a description of the original resource that the URL was created for (for example, a class path location)
Returns:
a corresponding File object

getFile

public static java.io.File getFile(java.net.URI resourceUri, java.lang.String description)
Resolve the given resource URI to a java.io.File, i.e. to a file in the file system.
throws:
FileNotFoundException if the URL cannot be resolved to a file in the file system
Parameters:
resourceUri - the resource URI to resolve
description - a description of the original resource that the URI was created for (for example, a class path location)
Returns:
a corresponding File object

getFile

public static java.io.File getFile(java.net.URI resourceUri)
Resolve the given resource URI to a java.io.File, i.e. to a file in the file system.
throws:
FileNotFoundException if the URL cannot be resolved to a file in the file system
Parameters:
resourceUri - the resource URI to resolve
Returns:
a corresponding File object

getFilename

public static java.lang.String getFilename(java.lang.String path)
Extract the filename from the given path, e.g. "mypath/myfile.txt" -> "myfile.txt".
Parameters:
path - the file path (may be null)
Returns:
the extracted filename, or null if none

getPathFromRoot

public static java.lang.String getPathFromRoot(java.lang.String path)
Get the path relative to an artefact folder under grails-app i.e: Input: /usr/joe/project/grails-app/conf/BootStrap.groovy Output: BootStrap.groovy Input: /usr/joe/project/grails-app/domain/com/mystartup/Book.groovy Output: com/mystartup/Book.groovy
Parameters:
path - The path to evaluate
Returns:
The path relative to the root folder grails-app

getRelativeInsideWebInf

public static java.lang.String getRelativeInsideWebInf(Resource resource)

getStaticResourcePathForResource

public static java.lang.String getStaticResourcePathForResource(Resource resource, java.lang.String contextPath)

getViewsDir

public static Resource getViewsDir(Resource resource)

instantiateFromConfig

}
}
public static java.lang.Object instantiateFromConfig(groovy.util.ConfigObject config, java.lang.String configKey, java.lang.String defaultClassName)

instantiateFromFlatConfig

public static java.lang.Object instantiateFromFlatConfig(java.util.Map flatConfig, java.lang.String configKey, java.lang.String defaultClassName)

isDomainClass

public static boolean isDomainClass(java.net.URL url)
Checks whether the file referenced by the given url is a domain class
Parameters:
url - The URL instance
Returns:
true if it is a domain class

isFileURL

public static boolean isFileURL(java.net.URL url)
Determine whether the given URL points to a resource in the file system, that is, has protocol "file" or "vfs".
Parameters:
url - the URL to check
Returns:
whether the URL has been identified as a file system URL

isGrailsPath

public static boolean isGrailsPath(java.lang.String path)

isGrailsResource

public static boolean isGrailsResource(Resource r)

isJarURL

public static boolean isJarURL(java.net.URL url)
Determine whether the given URL points to a resource in a jar file, that is, has protocol "jar", "zip", "wsjar" or "code-source".

"zip" and "wsjar" are used by BEA WebLogic Server and IBM WebSphere, respectively, but can be treated like jar files. The same applies to "code-source" URLs on Oracle OC4J, provided that the path contains a jar separator.

Parameters:
url - the URL to check
Returns:
whether the URL has been identified as a JAR URL

toURI

public static java.net.URI toURI(java.net.URL url)
Create a URI instance for the given URL, replacing spaces with "%20" quotes first.

Furthermore, this method works on JDK 1.4 as well, in contrast to the URL.toURI() method.

throws:
URISyntaxException if the URL wasn't a valid URI
Parameters:
url - the URL to convert into a URI instance
Returns:
the URI instance
See Also:
java.net.URL#toURI()

toURI

public static java.net.URI toURI(java.lang.String location)
Create a URI instance for the given location String, replacing spaces with "%20" quotes first.
throws:
URISyntaxException if the location wasn't a valid URI
Parameters:
location - the location String to convert into a URI instance
Returns:
the URI instance

useCachesIfNecessary

public static void useCachesIfNecessary(java.net.URLConnection con)

 

Groovy Documentation