CdnClassLoader (Groovy Documentation)

com.cedarsoftware.ncube.util.CdnClassLoader

Authors:
Ken Partlow ([email protected]) Greg Morefield ([email protected]) John DeRegnaucourt ([email protected])
Copyright (c) Cedar Software LLC

Licensed under the Apache License, Version 2.0 (the "License") you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`CdnClassLoader.PreferClassNodeResolver`

Constructor Summary

Constructors
Constructor and description
`CdnClassLoader (java.lang.ClassLoader loader, boolean preventRemoteBeanInfo = true, boolean preventRemoteCustomizer = true, java.util.List<java.lang.String> acceptedDomains = null)` Create a GroovyClassLoader using the given ClassLoader as parent
`CdnClassLoader (java.util.List<java.lang.String> urlList, java.util.List<java.lang.String> acceptedDomains = null)` Create a class loader that will have the additional URLs added to the classpath.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`addURL(java.lang.String url)` Add the passed in String URL to the classpath.
	`void`	`clearCache()` Clear any internal caches.
	`java.lang.Class`	`defineClass(java.lang.String name, byte[] byteCode)` Caches the class, if name is supplied and caching is configured, then delegates to super class to defineClass from raw bytes
	`java.net.URL`	`findResource(java.lang.String name)` Finds the resource with the specified name on the URL search path.
	`java.util.Enumeration<java.net.URL>`	`findResources(java.lang.String name)` Returns an Enumeration of URLs representing all of the resources on the URL search path having the specified name.
	`org.codehaus.groovy.control.ClassNodeResolver`	`getClassNodeResolver()`
	`static java.lang.String`	`getGeneratedClassesDirectory()` Returns directory to use for Class caching.
	`java.net.URL`	`getResource(java.lang.String name)` Finds the resource with the given name.
	`java.util.Enumeration<java.net.URL>`	`getResources(java.lang.String name)` Finds all the resources with the given name.
	`static void`	`setGeneratedClassesDirectory(java.lang.String classesDir)` Specifies directory to use for caching Class files generated during Groovy compiles.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class groovy.lang.GroovyClassLoader`	groovy.lang.GroovyClassLoader#loadClass(java.lang.String, boolean, boolean, boolean), groovy.lang.GroovyClassLoader#loadClass(java.lang.String), groovy.lang.GroovyClassLoader#loadClass(java.lang.String, boolean, boolean), groovy.lang.GroovyClassLoader#defineClass(java.lang.String, [B), groovy.lang.GroovyClassLoader#defineClass(org.codehaus.groovy.ast.ClassNode, java.lang.String, java.lang.String), groovy.lang.GroovyClassLoader#addURL(java.net.URL), groovy.lang.GroovyClassLoader#addClasspath(java.lang.String), groovy.lang.GroovyClassLoader#setResourceLoader(groovy.lang.GroovyResourceLoader), groovy.lang.GroovyClassLoader#getResourceLoader(), groovy.lang.GroovyClassLoader#parseClass(groovy.lang.GroovyCodeSource, boolean), groovy.lang.GroovyClassLoader#parseClass(java.lang.String), groovy.lang.GroovyClassLoader#parseClass(java.io.InputStream, java.lang.String), groovy.lang.GroovyClassLoader#parseClass(groovy.lang.GroovyCodeSource), groovy.lang.GroovyClassLoader#parseClass(java.io.File), groovy.lang.GroovyClassLoader#parseClass(java.lang.String, java.lang.String), groovy.lang.GroovyClassLoader#generateScriptName(), groovy.lang.GroovyClassLoader#getLoadedClasses(), groovy.lang.GroovyClassLoader#setShouldRecompile(java.lang.Boolean), groovy.lang.GroovyClassLoader#isShouldRecompile(), groovy.lang.GroovyClassLoader#clearCache(), groovy.lang.GroovyClassLoader#newInstance([Ljava.net.URL;, java.lang.ClassLoader), groovy.lang.GroovyClassLoader#newInstance([Ljava.net.URL;), groovy.lang.GroovyClassLoader#getResourceAsStream(java.lang.String), groovy.lang.GroovyClassLoader#findResource(java.lang.String), groovy.lang.GroovyClassLoader#findResources(java.lang.String), groovy.lang.GroovyClassLoader#close(), groovy.lang.GroovyClassLoader#getURLs(), groovy.lang.GroovyClassLoader#getSystemClassLoader(), groovy.lang.GroovyClassLoader#getResource(java.lang.String), groovy.lang.GroovyClassLoader#getSystemResourceAsStream(java.lang.String), groovy.lang.GroovyClassLoader#getSystemResource(java.lang.String), groovy.lang.GroovyClassLoader#getResources(java.lang.String), groovy.lang.GroovyClassLoader#getSystemResources(java.lang.String), groovy.lang.GroovyClassLoader#getParent(), groovy.lang.GroovyClassLoader#setDefaultAssertionStatus(boolean), groovy.lang.GroovyClassLoader#setPackageAssertionStatus(java.lang.String, boolean), groovy.lang.GroovyClassLoader#setClassAssertionStatus(java.lang.String, boolean), groovy.lang.GroovyClassLoader#clearAssertionStatus(), groovy.lang.GroovyClassLoader#wait(long, int), groovy.lang.GroovyClassLoader#wait(long), groovy.lang.GroovyClassLoader#wait(), groovy.lang.GroovyClassLoader#equals(java.lang.Object), groovy.lang.GroovyClassLoader#toString(), groovy.lang.GroovyClassLoader#hashCode(), groovy.lang.GroovyClassLoader#getClass(), groovy.lang.GroovyClassLoader#notify(), groovy.lang.GroovyClassLoader#notifyAll()
`class java.net.URLClassLoader`	java.net.URLClassLoader#newInstance([Ljava.net.URL;, java.lang.ClassLoader), java.net.URLClassLoader#newInstance([Ljava.net.URL;), java.net.URLClassLoader#getResourceAsStream(java.lang.String), java.net.URLClassLoader#findResource(java.lang.String), java.net.URLClassLoader#findResources(java.lang.String), java.net.URLClassLoader#close(), java.net.URLClassLoader#getURLs(), java.net.URLClassLoader#loadClass(java.lang.String), java.net.URLClassLoader#getSystemClassLoader(), java.net.URLClassLoader#getResource(java.lang.String), java.net.URLClassLoader#getSystemResourceAsStream(java.lang.String), java.net.URLClassLoader#getSystemResource(java.lang.String), java.net.URLClassLoader#getResources(java.lang.String), java.net.URLClassLoader#getSystemResources(java.lang.String), java.net.URLClassLoader#getParent(), java.net.URLClassLoader#setDefaultAssertionStatus(boolean), java.net.URLClassLoader#setPackageAssertionStatus(java.lang.String, boolean), java.net.URLClassLoader#setClassAssertionStatus(java.lang.String, boolean), java.net.URLClassLoader#clearAssertionStatus(), java.net.URLClassLoader#wait(long, int), java.net.URLClassLoader#wait(long), java.net.URLClassLoader#wait(), java.net.URLClassLoader#equals(java.lang.Object), java.net.URLClassLoader#toString(), java.net.URLClassLoader#hashCode(), java.net.URLClassLoader#getClass(), java.net.URLClassLoader#notify(), java.net.URLClassLoader#notifyAll()

- Constructor Detail
  - CdnClassLoader(java.lang.ClassLoader loader, boolean preventRemoteBeanInfo = true, boolean preventRemoteCustomizer = true, java.util.List<java.lang.String> acceptedDomains = null)
    
    Create a GroovyClassLoader using the given ClassLoader as parent
  - CdnClassLoader(java.util.List<java.lang.String> urlList, java.util.List<java.lang.String> acceptedDomains = null)
    
    Create a class loader that will have the additional URLs added to the classpath.
    Parameters:
    urlList - List of String URLs to be added to the classpath.
    acceptedDomains - List of String prefixes of white-list domains which are allowed to be searched for dynamic code or resources.
- Method Detail
  - void addURL(java.lang.String url)
    
    Add the passed in String URL to the classpath.
    Parameters:
    url - String url to add to the classpath.
  - void clearCache()
    
    Clear any internal caches. The resource caches which map relative paths to fully qualified URLs are cleared, as well as the parent class loader is told to clear its internal class cache.
  - java.lang.Class defineClass(java.lang.String name, byte[] byteCode)
    
    Caches the class, if name is supplied and caching is configured, then delegates to super class to defineClass from raw bytes
    Parameters:
    name - String name of class to define, or null, if unknown
    byteCode - byte [] of raw Class bytes
    Returns:
    generated Class definition
  - java.net.URL findResource(java.lang.String name)
    
    Finds the resource with the specified name on the URL search path.
    Parameters:
    name - the name of the resource
    Returns:
    a URL for the resource, or null if the resource could not be found, or if the loader is closed.
  - java.util.Enumeration<java.net.URL> findResources(java.lang.String name)
    
    Returns an Enumeration of URLs representing all of the resources on the URL search path having the specified name.
    Parameters:
    name - the resource name
    Throws:
    IOException if an I/O exception occurs
    Returns:
    an Enumeration of URLs If the loader is closed, the Enumeration will be empty.
  - org.codehaus.groovy.control.ClassNodeResolver getClassNodeResolver()
  - static java.lang.String getGeneratedClassesDirectory()
    
    Returns directory to use for Class caching.
    Returns:
    String path to directory to use for Class caching, if enabled; otherwise, empty string
  - java.net.URL getResource(java.lang.String name)
    
    Finds the resource with the given name. A resource is some data (images, audio, text, etc) that can be accessed by class code in a way that is independent of the location of the code.
    The name of a resource is a '/'-separated path name that identifies the resource. This implementation caches local resource paths to URLs so that multiple requests for the same relative resource will be answered without any network traffic.
    Parameters:
    name - The resource name
    Returns:
    A URL object for reading the resource, or null if the resource could not be found or the invoker doesn't have adequate privileges to get the resource.
  - java.util.Enumeration<java.net.URL> getResources(java.lang.String name)
    
    Finds all the resources with the given name. A resource is some data (images, audio, text, code, etc) that can be accessed by class code in a way that is independent of the location of the code.
    The name of a resource is a /-separated path name that identifies the resource.
    The search order is described in the documentation for #getResource(String).
    apiNote:
    When overriding this method it is recommended that an implementation ensures that any delegation is consistent with the getResource(String) method. This should ensure that the first element returned by the Enumeration's nextElement method is the same resource that the getResource(String) method would return.
    throws:
    IOException If I/O errors occur
    
    Parameters:
    name - The resource name
    Returns:
    An enumeration of java.net.URL<tt>URL</tt> objects for the resource. If no resources could be found, the enumeration will be empty. Resources that the class loader doesn't have access to will not be in the enumeration.
    See Also:
    findResources(String)
  - static void setGeneratedClassesDirectory(java.lang.String classesDir)
    
    Specifies directory to use for caching Class files generated during Groovy compiles. If the directory doesn't exist and can't be created, the Class caching will be disabled
    Parameters:
    classesDir - String containing relative or absolute path to use for Class caching. A null or empty string will disable caching

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class CdnClassLoader

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

CdnClassLoader(java.lang.ClassLoader loader, boolean preventRemoteBeanInfo = true, boolean preventRemoteCustomizer = true, java.util.List<java.lang.String> acceptedDomains = null)

CdnClassLoader(java.util.List<java.lang.String> urlList, java.util.List<java.lang.String> acceptedDomains = null)

Method Detail

void addURL(java.lang.String url)

void clearCache()

java.lang.Class defineClass(java.lang.String name, byte[] byteCode)

java.net.URL findResource(java.lang.String name)

java.util.Enumeration<java.net.URL> findResources(java.lang.String name)

org.codehaus.groovy.control.ClassNodeResolver getClassNodeResolver()

static java.lang.String getGeneratedClassesDirectory()

java.net.URL getResource(java.lang.String name)

java.util.Enumeration<java.net.URL> getResources(java.lang.String name)

static void setGeneratedClassesDirectory(java.lang.String classesDir)