org.springframework.xd.dirt.module

Class SynchronizingModuleRegistry

java.lang.Object

org.springframework.xd.dirt.module.SynchronizingModuleRegistry

All Implemented Interfaces:

ModuleRegistry, WritableModuleRegistry

public class SynchronizingModuleRegistry
extends java.lang.Object
implements WritableModuleRegistry

A ModuleRegistry that is configured with two delegates: a remote (source) and a local (target) registry. This registry will return results that exist in the remote registry but will synchronize them with the local registry. Results returned are always from the local registry (unless composed). Mutative operations go through to the remote repository though.

This is useful as reading Boot uber-jars requires local java.io.File access, but modules may reside in a remote registry (e.g. backed by HDFS). For such a case, simply use this registry as the main registry, configuring it with the hdfs:// registry as its source and the file:// one as its target.

Since:

1.2

Author:

Eric Bottard

Constructor Summary

Constructors

Constructor and Description
SynchronizingModuleRegistry(WritableModuleRegistry remoteRegistry, WritableModuleRegistry localRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	delete(ModuleDefinition definition) Attempt to delete the given definition, if that registry is responsible for it.
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.
boolean	registerNew(ModuleDefinition definition) Attempt to register the given definition, if that registry can handle it.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronizingModuleRegistry

public SynchronizingModuleRegistry(WritableModuleRegistry remoteRegistry,
                           WritableModuleRegistry localRegistry)

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.

delete

public boolean delete(ModuleDefinition definition)

Description copied from interface: WritableModuleRegistry

Attempt to delete the given definition, if that registry is responsible for it.

Specified by:

delete in interface WritableModuleRegistry

Returns:

true if this registry was responsible for the definition and it was actually deleted

registerNew

public boolean registerNew(ModuleDefinition definition)

Description copied from interface: WritableModuleRegistry

Attempt to register the given definition, if that registry can handle it.

Specified by:

registerNew in interface WritableModuleRegistry

Returns:

true if this registry is able to register the new definition and actually did