org.oddjob.util

Class URLClassLoaderType

java.lang.Object

org.oddjob.util.URLClassLoaderType

All Implemented Interfaces:

ArooaValue, ArooaLifeAware, ValueFactory<java.lang.ClassLoader>

public class URLClassLoaderType
extends java.lang.Object
implements ValueFactory<java.lang.ClassLoader>, ArooaLifeAware

Description

A simple wrapper for URLClassloader.

The class loader is created when this type is configured, and the same class loader is then shared with all jobs that reference this type. Because creating numerous class loader can use up the permgen heap space it is best to avoid creating the type in a loop. Instead add it to VariablesJob outside the loop and only reference it inside the loop.

Example

A simple example. A single directory is added to the class path.

<oddjob id="this">
    <job>
        <oddjob id="nested" file="${this.dir}/URLClassLoaderInner.xml">
            <classLoader>
                <url-class-loader>
                    <files>
                        <file file="${this.args[0]}/test/classloader"/>
                    </files>
                </url-class-loader>
            </classLoader>
        </oddjob>
    </job>
</oddjob>

Author:

rob

Nested Class Summary

Nested classes/interfaces inherited from interface org.oddjob.arooa.types.ValueFactory

ValueFactory.Conversions

Constructor Summary

Constructors

Constructor and Description
URLClassLoaderType()

Method Summary

Modifier and Type	Method and Description
void	configured() The configuration for the bean has been fully configured.
protected java.lang.ClassLoader	createClassLoader()
void	destroy() The configuration for the bean is about to be destroyed.
java.io.File[]	getFiles()
java.lang.ClassLoader	getParent()
java.net.URL[]	getUrls()
void	initialised() The configuration for the bean has been initialised.
boolean	isNoInherit()
void	setFiles(java.io.File[] files)
void	setNoInherit(boolean noInherit)
void	setParent(java.lang.ClassLoader parent)
void	setUrls(java.net.URL[] urls)
java.lang.String	toString()
java.lang.ClassLoader	toValue() Provide an instance of the type this is a factory for.

Methods inherited from class java.lang.Object

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

Constructor Detail

URLClassLoaderType

public URLClassLoaderType()

Method Detail

toValue

public java.lang.ClassLoader toValue()

Description copied from interface: ValueFactory

Provide an instance of the type this is a factory for.

Specified by:

toValue in interface ValueFactory<java.lang.ClassLoader>

Returns:

An instance of the type. May be null.

createClassLoader

protected java.lang.ClassLoader createClassLoader()

getUrls

public java.net.URL[] getUrls()

setUrls

public void setUrls(java.net.URL[] urls)

Property: urls

Description: URLs to add to the classpath.

Required: No.

getFiles

public java.io.File[] getFiles()

setFiles

public void setFiles(java.io.File[] files)

Property: files

Description: Files to add to the classpath.

Required: No.

isNoInherit

public boolean isNoInherit()

setNoInherit

public void setNoInherit(boolean noInherit)

Property: noInherit

Description: Don't inherit the parent class loader.

Required: No.

getParent

public java.lang.ClassLoader getParent()

setParent

@Inject
public void setParent(java.lang.ClassLoader parent)

Property: parent

Description: The parent class loader to inherit.

Required: No, defaults to any existing Oddjob class loader.

initialised

public void initialised()

Description copied from interface: ArooaLifeAware

The configuration for the bean has been initialised. Constant properties and element properties will have been injected.

Specified by:

initialised in interface ArooaLifeAware

configured

public void configured()

Description copied from interface: ArooaLifeAware

The configuration for the bean has been fully configured. Runtime properties will have been injected.

Specified by:

configured in interface ArooaLifeAware

destroy

public void destroy()

Description copied from interface: ArooaLifeAware

The configuration for the bean is about to be destroyed. A bean can use this method to free resources.

Specified by:

destroy in interface ArooaLifeAware

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object