org.springframework.xd.dirt.module

Class AbstractModuleRegistry

java.lang.Object

org.springframework.xd.dirt.module.AbstractModuleRegistry

All Implemented Interfaces:

ModuleRegistry

Direct Known Subclasses:

RedisModuleRegistry, ResourceModuleRegistry

public abstract class AbstractModuleRegistry
extends java.lang.Object
implements ModuleRegistry

Provides common behavior for ModuleRegistry and knows how to handle custom classpath population for storages that support it.

Author:

Eric Bottard, Mark Fisher, Gary Russell

Constructor Summary

Constructors

Constructor and Description
AbstractModuleRegistry()

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 abstract java.lang.String	inferModuleName(org.springframework.core.io.Resource resource) Recover the name of the module, given its resource location.
protected abstract org.springframework.core.io.Resource	locateApplicationContext(java.lang.String name, ModuleType type) Return a resource pointing to an ApplicationContext XML definition file.
protected abstract java.util.List<org.springframework.core.io.Resource>	locateApplicationContexts(ModuleType type) Return a list of resources pointing to ApplicationContext XML definition files.
protected java.net.URL[]	maybeLocateClasspath(org.springframework.core.io.Resource resource, java.lang.String name, ModuleType moduleType) Return an array of jar files locations or null if the module is a plain xml file.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractModuleRegistry

public AbstractModuleRegistry()

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.

inferModuleName

protected abstract java.lang.String inferModuleName(org.springframework.core.io.Resource resource)

Recover the name of the module, given its resource location.

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.

locateApplicationContext

protected abstract org.springframework.core.io.Resource locateApplicationContext(java.lang.String name,
                                                            ModuleType type)

Return a resource pointing to an ApplicationContext XML definition file.

locateApplicationContexts

protected abstract java.util.List<org.springframework.core.io.Resource> locateApplicationContexts(ModuleType type)

Return a list of resources pointing to ApplicationContext XML definition files.

maybeLocateClasspath

protected java.net.URL[] maybeLocateClasspath(org.springframework.core.io.Resource resource,
                                  java.lang.String name,
                                  ModuleType moduleType)

Return an array of jar files locations or null if the module is a plain xml file. Default implementation returns null system.