org.springframework.xd.dirt.module

Interface ModuleRegistry

All Known Subinterfaces:

WritableModuleRegistry

All Known Implementing Classes:

DelegatingModuleRegistry, ResourceModuleRegistry, SingletonModuleRegistry, SynchronizingModuleRegistry, WritableResourceModuleRegistry, ZooKeeperComposedModuleDefinitionRegistry

public interface ModuleRegistry

A module registry is used to lookup modules by name and/or type. A non-null / non-empty result indicates that a module exists, but further validation and introspection is left to the caller.

Author:

Mark Fisher, Gary Russell, Glenn Renfro

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.

Method Detail

findDefinition

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

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

Returns:

null if this registry does not have such a module

findDefinitions

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.

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

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

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

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

java.util.List<ModuleDefinition> findDefinitions()

Returns all module definitions.

Returns:

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