org.springframework.xd.module.options

Class DefaultModuleOptionsMetadataResolver

java.lang.Object

org.springframework.xd.module.options.DefaultModuleOptionsMetadataResolver

All Implemented Interfaces:

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

public class DefaultModuleOptionsMetadataResolver
extends java.lang.Object
implements ModuleOptionsMetadataResolver, org.springframework.context.ResourceLoaderAware

The default implementation of ModuleOptionsMetadataResolver that deals with simple modules and reads the companion .properties file sitting next to the module definition.

The following strategies will be applied in turn:

• look for a file named <modulename>.properties next to the module xml definition file
• if that file exists
  • look for an "options_class" property. If found, use a PojoModuleOptionsMetadata backed by that POJO class name
  • use a SimpleModuleOptionsMetadata backed by keys of the form options.<name>.description. Additionally, one can provide options.<name>.default and options.<name>.type properties.
• return an instance of PassthruModuleOptionsMetadata.

Author:

Eric Bottard, Gunnar Hillert

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPTIONS_CLASS Name of the property containing a POJO fully qualified classname, which will be used to create a PojoModuleOptionsMetadata.

Constructor Summary

Constructors

Constructor and Description
DefaultModuleOptionsMetadataResolver() Construct a new DefaultModuleOptionsMetadataResolver, using a GenericConversionService which is augmented with a StringToEnumIgnoringCaseConverterFactory.
DefaultModuleOptionsMetadataResolver(org.springframework.core.convert.ConversionService conversionService) Construct a new DefaultModuleOptionsMetadataResolver that will use the provided conversion service when converting from String to rich object (supported for PojoModuleOptionsMetadata only).

Method Summary

Methods

Modifier and Type	Method and Description
ModuleOptionsMetadata	resolve(ModuleDefinition definition) Return metadata about a module, as identified by the given moduleDefinition.
void	setCompositeResolver(ModuleOptionsMetadataResolver compositeResolver)
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

OPTIONS_CLASS

public static final java.lang.String OPTIONS_CLASS

Name of the property containing a POJO fully qualified classname, which will be used to create a PojoModuleOptionsMetadata.

See Also:

Constant Field Values

Constructor Detail

DefaultModuleOptionsMetadataResolver

public DefaultModuleOptionsMetadataResolver(org.springframework.core.convert.ConversionService conversionService)

Construct a new DefaultModuleOptionsMetadataResolver that will use the provided conversion service when converting from String to rich object (supported for PojoModuleOptionsMetadata only).

Parameters:

conversionService - Must not be null

DefaultModuleOptionsMetadataResolver

public DefaultModuleOptionsMetadataResolver()

Construct a new DefaultModuleOptionsMetadataResolver, using a GenericConversionService which is augmented with a StringToEnumIgnoringCaseConverterFactory. See also PojoModuleOptionsMetadata.

Method Detail

setCompositeResolver

public void setCompositeResolver(ModuleOptionsMetadataResolver compositeResolver)

resolve

public ModuleOptionsMetadata resolve(ModuleDefinition definition)

Description copied from interface: ModuleOptionsMetadataResolver

Return metadata about a module, as identified by the given moduleDefinition.

Specified by:

resolve in interface ModuleOptionsMetadataResolver

setResourceLoader

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

Specified by:

setResourceLoader in interface org.springframework.context.ResourceLoaderAware