org.springframework.xd.dirt.module

Class ArchiveModuleRegistry

java.lang.Object

org.springframework.xd.dirt.module.ArchiveModuleRegistry

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ResourceLoaderAware, ModuleRegistry

Direct Known Subclasses:

ResourceModuleRegistry, WriteCapableArchiveModuleRegistry

public class ArchiveModuleRegistry
extends java.lang.Object
implements ModuleRegistry, org.springframework.context.ResourceLoaderAware

A ModuleRegistry that expects to find Spring Boot archives (either as jar file or exploded directory) at the following location pattern: <registry root>/<module type>/<archive named after the module>.

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.
protected org.springframework.core.io.support.ResourcePatternResolver	resolver
protected java.lang.String	root

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
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 void	fromResource(org.springframework.core.io.Resource resource, java.util.List<ModuleDefinition> holder)
protected org.springframework.core.io.Resource[]	getResources(java.lang.String moduleType, java.lang.String moduleName, java.lang.String suffix)
void	setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

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

root

protected final java.lang.String root

resolver

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

Constructor Detail

ArchiveModuleRegistry

public ArchiveModuleRegistry(java.lang.String root)

Method Detail

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.

fromResource

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

Throws:

java.io.IOException

setResourceLoader

public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface org.springframework.context.ResourceLoaderAware

getResources

protected 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