org.springframework.xd.module.options

Class ModuleUtils

java.lang.Object

org.springframework.xd.module.options.ModuleUtils

public class ModuleUtils
extends java.lang.Object

Contains utility methods for accessing a module's properties and dealing with ClassLoaders.

Author:

Eric Bottard, David Turanski

Constructor Summary

Constructors

Constructor and Description
ModuleUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.ClassLoader	createModuleDiscoveryClassLoader(org.springframework.core.io.Resource moduleLocation, java.lang.ClassLoader parent) Create a "simple" ClassLoader for a module, suitable for early discovery phase, before module options are known.
static java.lang.ClassLoader	createModuleRuntimeClassLoader(SimpleModuleDefinition definition, ModuleOptions moduleOptions, java.lang.ClassLoader parent) Create a ClassLoader suitable for running a module.
static java.util.Properties	loadModuleProperties(SimpleModuleDefinition moduleDefinition) Locate the module '.properties' file and load it as a Properties object.
static org.springframework.core.io.Resource	locateModuleResource(SimpleModuleDefinition definition, java.lang.String extension) Return an expected module resource given a file extension.
static org.springframework.core.io.Resource	modulePropertiesFile(SimpleModuleDefinition definition) Return a resource that can be used to load the module '.properties' file (containing e.g. information about module options, or null if no such file exists.
static org.springframework.core.io.Resource	resourceBasedConfigurationFile(SimpleModuleDefinition moduleDefinition) Return the resource that can be used to configure a module, or null if no such resource exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleUtils

public ModuleUtils()

Method Detail

createModuleRuntimeClassLoader

public static java.lang.ClassLoader createModuleRuntimeClassLoader(SimpleModuleDefinition definition,
                                                   ModuleOptions moduleOptions,
                                                   java.lang.ClassLoader parent)

Create a ClassLoader suitable for running a module. Extra libraries can come from paths that are derived from module options. Any path that starts with a slash will be assumed to be an in-Archive entry, whereas any other path (including those starting with a protocol) will be dealt with by a classical resource pattern resolver.

createModuleDiscoveryClassLoader

public static java.lang.ClassLoader createModuleDiscoveryClassLoader(org.springframework.core.io.Resource moduleLocation,
                                                     java.lang.ClassLoader parent)

Create a "simple" ClassLoader for a module, suitable for early discovery phase, before module options are known. Only the default library paths are used.

modulePropertiesFile

public static org.springframework.core.io.Resource modulePropertiesFile(SimpleModuleDefinition definition)

Return a resource that can be used to load the module '.properties' file (containing e.g. information about module options, or null if no such file exists.

loadModuleProperties

public static java.util.Properties loadModuleProperties(SimpleModuleDefinition moduleDefinition)

Locate the module '.properties' file and load it as a Properties object.

Returns:

null if no properties file exists

locateModuleResource

public static org.springframework.core.io.Resource locateModuleResource(SimpleModuleDefinition definition,
                                                        java.lang.String extension)

Return an expected module resource given a file extension. Will throw an exception if more than one such resource exists. The resource is searched using an insulated module ClassLoader that only knows about the flat contents of the module archive (does not search any parent classloader, nor any additional module library).

resourceBasedConfigurationFile

public static org.springframework.core.io.Resource resourceBasedConfigurationFile(SimpleModuleDefinition moduleDefinition)

Return the resource that can be used to configure a module, or null if no such resource exists.

Throws:

java.lang.IllegalStateException - if both a .xml and .groovy file are present