org.springframework.xd.dirt.module

Class ResourceModuleRegistry

java.lang.Object

org.springframework.xd.dirt.module.ResourceModuleRegistry

All Implemented Interfaces:

ModuleRegistry

Direct Known Subclasses:

WritableResourceModuleRegistry

public class ResourceModuleRegistry
extends java.lang.Object
implements ModuleRegistry

Resource based implementation of ModuleRegistry.

While not being coupled to java.io.File access, will try to sanitize file paths as much as possible.

Author:

Eric Bottard, David Turanski

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARCHIVE_AS_FILE_EXTENSION The extension the module 'File' must have if it's not in exploded dir format.
static java.lang.String	HASH_EXTENSION The extension to use for storing an uploaded module hash.
protected org.springframework.core.io.support.ResourcePatternResolver	resolver
protected java.lang.String	root

Constructor Summary

Constructors

Constructor and Description
ResourceModuleRegistry(java.lang.String root)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	collect(org.springframework.core.io.Resource resource, java.util.List<ModuleDefinition> holder)
ModuleDefinition	findDefinition(java.lang.String name, ModuleType moduleType) Lookup a module of the given type with the given name.
java.util.List<ModuleDefinition>	findDefinitions() Returns all module definitions.
java.util.List<ModuleDefinition>	findDefinitions(ModuleType type) Searches the registry for the type specified and returns all module definitions that match the type.
java.util.List<ModuleDefinition>	findDefinitions(java.lang.String name) Searches the registry for the name specified and returns all module definitions that match the name regardless of module type.
protected java.lang.Iterable<org.springframework.core.io.Resource>	getResources(java.lang.String moduleType, java.lang.String moduleName, java.lang.String suffix)
protected org.springframework.core.io.Resource	hashResource(org.springframework.core.io.Resource moduleResource)
void	setRequireHashFiles(boolean requireHashFiles)

Methods inherited from class java.lang.Object

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

Field Detail

ARCHIVE_AS_FILE_EXTENSION

public static final java.lang.String ARCHIVE_AS_FILE_EXTENSION

The extension the module 'File' must have if it's not in exploded dir format.

See Also:

Constant Field Values

HASH_EXTENSION

public static final java.lang.String HASH_EXTENSION

The extension to use for storing an uploaded module hash.

See Also:

Constant Field Values

resolver

protected org.springframework.core.io.support.ResourcePatternResolver resolver

root

protected java.lang.String root

Constructor Detail

ResourceModuleRegistry

public ResourceModuleRegistry(java.lang.String root)

Method Detail

hashResource

protected org.springframework.core.io.Resource hashResource(org.springframework.core.io.Resource moduleResource)
                                                     throws java.io.IOException

Throws:

java.io.IOException

findDefinition

public ModuleDefinition findDefinition(java.lang.String name,
                              ModuleType moduleType)

Description copied from interface: ModuleRegistry

Lookup a module of the given type with the given name.

Specified by:

findDefinition in interface ModuleRegistry

Returns:

null if this registry does not have such a module

findDefinitions

public java.util.List<ModuleDefinition> findDefinitions(java.lang.String name)

Description copied from interface: ModuleRegistry

Searches the registry for the name specified and returns all module definitions that match the name regardless of module type.

Specified by:

findDefinitions in interface ModuleRegistry

Parameters:

name - The module definition name to be searched.

Returns:

A list of the module definitions that have the name specified by the input parameter. If no module definition is found with the name an empty list will be returned.

findDefinitions

public java.util.List<ModuleDefinition> findDefinitions(ModuleType type)

Description copied from interface: ModuleRegistry

Searches the registry for the type specified and returns all module definitions that match the type.

Specified by:

findDefinitions in interface ModuleRegistry

Parameters:

type - The module type name to be searched.

Returns:

A list of the module definitions that have the type specified by the input parameter. If no module definition is found with the type an empty list will be returned.

findDefinitions

public java.util.List<ModuleDefinition> findDefinitions()

Description copied from interface: ModuleRegistry

Returns all module definitions.

Specified by:

findDefinitions in interface ModuleRegistry

Returns:

A list of the module definitions. If no module definition is found with the type an empty list will be returned.

getResources

protected java.lang.Iterable<org.springframework.core.io.Resource> getResources(java.lang.String moduleType,
                                                                    java.lang.String moduleName,
                                                                    java.lang.String suffix)
                                                                         throws java.io.IOException

Throws:

java.io.IOException

collect

protected void collect(org.springframework.core.io.Resource resource,
           java.util.List<ModuleDefinition> holder)
                throws java.io.IOException

Throws:

java.io.IOException

setRequireHashFiles

public void setRequireHashFiles(boolean requireHashFiles)