org.walkmod

Class WalkModFacade

java.lang.Object

org.walkmod.WalkModFacade

public class WalkModFacade
extends Object

Facade to execute walkmod services.

Author:

Raquel Pau

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
WalkModFacade() Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead
WalkModFacade(boolean offline, boolean verbose, boolean printError) Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead
WalkModFacade(boolean offline, boolean verbose, boolean printError, String[] includes, String[] excludes) Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead
WalkModFacade(File cfg, boolean offline, boolean verbose, boolean printError) Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead
WalkModFacade(File cfg, boolean offline, boolean verbose, boolean printError, String[] includes, String[] excludes) Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead
WalkModFacade(File walkmodCfg, OptionsBuilder optionsBuilder, ConfigurationProvider configurationProvider) Initalizes a Walkmod service
WalkModFacade(OptionsBuilder optionsBuilder) Initalizes a Walkmod service
WalkModFacade(String cfg, boolean offline, boolean verbose, boolean printError) Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead
WalkModFacade(String cfg, boolean offline, boolean verbose, boolean printError, boolean throwsException, String[] includes, String[] excludes) Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead
WalkModFacade(String cfg, boolean offline, boolean verbose, boolean printError, String[] includes, String[] excludes) Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Method Summary

Modifier and Type	Method and Description
void	addChainConfig(ChainConfig chainCfg, boolean recursive) Adds a new chain configuration into the configuration file
void	addConfigurationParameter(String param, String value, String type, String category, String name, String chain, boolean recursive) Sets an specific parameter value into a bean.
void	addModules(List<String> modules) Adds a module into the configuration file
void	addPluginConfig(PluginConfig pluginConfig, boolean recursive) Adds a new plugin into the configuration file
void	addProviderConfig(ProviderConfig providerCfg, boolean recursive) Adds a new provider configuration into the configuration file
void	addTransformationConfig(String chain, String path, boolean recursive, TransformationConfig transformationCfg) Adds a new transformation configuration into the configuration file
List<File>	apply(String... chains) Applies a list of transformation chains.
List<File>	check(String... chains) Applies a list of transformation chains without updating the source files.
Configuration	getConfiguration() Returns the equivalent configuration representation of the Walkmod config file.
void	init() Initializes an empty walkmod configuration file
List<BeanDefinition>	inspectPlugin(PluginConfig plugin) Retrieves the bean definitions that contains an specific plugin.
void	install() Downloads the list of declared plugins in the configuration file using Ivy.
void	removeChains(List<String> chains, boolean recursive) Removes the chains from the Walkmod config file.
void	removeModules(List<String> modules) Removes the module list from the configuration file
void	removePluginConfig(PluginConfig pluginConfig, boolean recursive) Removes a plugin from the configuration file.
void	removeProviders(List<String> providers, boolean recursive) Removes the list of configuration providers from the config file.
void	removeTransformations(String chain, List<String> transformations, boolean recursive) Remove a list of transformations for an specific chain.
void	setReader(String chain, String type, String path, boolean recursive) Sets an specific reader for an specific chain.
void	setWriter(String chain, String type, String path, boolean recursive) Sets an specific writer for an specific chain.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.log4j.Logger log

Constructor Detail

WalkModFacade

public WalkModFacade(File cfg,
                     boolean offline,
                     boolean verbose,
                     boolean printError)

Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Facade constructor

Parameters:

cfg - configuration file.

offline - if the missing plugins are downloaded.

verbose - if log messages are printed in the System.out

printError - if the exception stack trace is printed in the System.out

WalkModFacade

public WalkModFacade(File cfg,
                     boolean offline,
                     boolean verbose,
                     boolean printError,
                     String[] includes,
                     String[] excludes)

Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Facade constructor

Parameters:

cfg - configuration file.

offline - if the missing plugins are downloaded.

verbose - if log messages are printed in the System.out

printError - if the exception stack trace is printed in the System.out

includes - the list of included files.

excludes - the list of excluded files.

WalkModFacade

public WalkModFacade(String cfg,
                     boolean offline,
                     boolean verbose,
                     boolean printError)

Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Facade constructor using the walkmod.xml configuration file.

Parameters:

cfg - configuration file

offline - if the missing plugins are downloaded.

verbose - if log messages are printed in the System.out

printError - if the exception trace is printed in the System.out

WalkModFacade

@Deprecated
public WalkModFacade(String cfg,
                                 boolean offline,
                                 boolean verbose,
                                 boolean printError,
                                 String[] includes,
                                 String[] excludes)

Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Facade constructor using the walkmod.xml configuration file.

Parameters:

cfg - configuration file

offline - if the missing plugins are downloaded.

verbose - if log messages are printed in the System.out

printError - if the exception trace is printed in the System.out

includes - the list of included files.

excludes - the list of excluded files.

WalkModFacade

@Deprecated
public WalkModFacade(String cfg,
                                 boolean offline,
                                 boolean verbose,
                                 boolean printError,
                                 boolean throwsException,
                                 String[] includes,
                                 String[] excludes)

Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Facade constructor using the walkmod.xml configuration file.

Parameters:

cfg - configuration file

offline - if the missing plugins are downloaded.

verbose - if log messages are printed in the System.out

printError - if the exception trace is printed in the System.out

throwsException - if the exception is thrown to the calling process

includes - the list of included files.

excludes - the list of excluded files.

WalkModFacade

@Deprecated
public WalkModFacade(boolean offline,
                                 boolean verbose,
                                 boolean printError)

Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Facade constructor using the walkmod.xml configuration file.

Parameters:

offline - if the missing plugins are downloaded.

verbose - if log messages are printed in the System.out

printError - if the exception trace is printed in the System.out

WalkModFacade

@Deprecated
public WalkModFacade(boolean offline,
                                 boolean verbose,
                                 boolean printError,
                                 String[] includes,
                                 String[] excludes)

Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Facade constructor using the walkmod.xml configuration file.

Parameters:

offline - if the missing plugins are downloaded.

verbose - if log messages are printed in the System.out

printError - if the exception trace is printed in the System.out

includes - the list of included files.

excludes - the list of excluded files.

WalkModFacade

@Deprecated
public WalkModFacade()

Deprecated. Use #{link #WalkModFacade(File,OptionsBuilder, ConfigurationProvider} instead

Default facade constructor. It uses the walkmod.xml configuration file, it is not off-line, it is verbose and doesn't print the exceptions' stack

WalkModFacade

public WalkModFacade(OptionsBuilder optionsBuilder)

Initalizes a Walkmod service

Parameters:

optionsBuilder - Map of option. See Options and OptionsBuilder for available options and default values.

WalkModFacade

public WalkModFacade(File walkmodCfg,
                     OptionsBuilder optionsBuilder,
                     ConfigurationProvider configurationProvider)

Initalizes a Walkmod service

Parameters:

walkmodCfg - Walkmod configuration file. If null, file named 'walkmod.xml' is searched at the root.

optionsBuilder - Map of option. See Options and OptionsBuilder for available options and default values.

configurationProvider - Configuration provider responsible for the resolution of plugins (used to use custom classloading strategies). If null Ivy is used.

Method Detail

apply

public List<File> apply(String... chains)
                 throws InvalidConfigurationException

Applies a list of transformation chains.

Parameters:

chains - the list of applied transformation chains.

Returns:

The list of modified/created files.

Throws:

InvalidConfigurationException - if the walkmod configuration is invalid and it is working in no verbose mode.

check

public List<File> check(String... chains)
                 throws InvalidConfigurationException

Applies a list of transformation chains without updating the source files.

Parameters:

chains - the list of applied transformation chains.

Returns:

The list of affected files.

Throws:

InvalidConfigurationException - if the walkmod configuration is invalid and it is working in no verbose mode.

init

public void init()
          throws Exception

Initializes an empty walkmod configuration file

Throws:

Exception - in case that the walkmod configuration file can't be created.

addChainConfig

public void addChainConfig(ChainConfig chainCfg,
                           boolean recursive)
                    throws Exception

Adds a new chain configuration into the configuration file

Parameters:

chainCfg - chain configuration to add

recursive - Adds the new chain into all the submodules

Throws:

Exception - in case that the walkmod configuration file can't be read.

addTransformationConfig

public void addTransformationConfig(String chain,
                                    String path,
                                    boolean recursive,
                                    TransformationConfig transformationCfg)
                             throws Exception

Adds a new transformation configuration into the configuration file

Parameters:

chain - chain identifier where the transformation will be appended. It can be null.

path - the path where the transformation config will be applied if the chain does not exists or is null.

recursive - if the transformation config is added recursively to all the submodules.

transformationCfg - transformation configuration to add

Throws:

Exception - in case that the walkmod configuration file can't be read.

addProviderConfig

public void addProviderConfig(ProviderConfig providerCfg,
                              boolean recursive)
                       throws Exception

Adds a new provider configuration into the configuration file

Parameters:

providerCfg - provider configuration to add.

recursive - if the provider config is added recursively to all the submodules.

Throws:

Exception - in case that the walkmod configuration file can't be read.

addPluginConfig

public void addPluginConfig(PluginConfig pluginConfig,
                            boolean recursive)
                     throws Exception

Adds a new plugin into the configuration file

Parameters:

pluginConfig - the plugin to add

recursive - if the plugin config is added recursively to all the submodules.

Throws:

Exception - in case that the walkmod configuration file can't be read.

install

public void install()
             throws InvalidConfigurationException

Downloads the list of declared plugins in the configuration file using Ivy. Ignores the ConfigurationProvided if passed in the constructor.

Throws:

InvalidConfigurationException - if the walkmod configuration is invalid and it is working in no verbose mode.

addModules

public void addModules(List<String> modules)
                throws Exception

Adds a module into the configuration file

Parameters:

modules - Modules to add

Throws:

Exception - if the walkmod configuration file can't be read.

removeTransformations

public void removeTransformations(String chain,
                                  List<String> transformations,
                                  boolean recursive)
                           throws Exception

Remove a list of transformations for an specific chain. If it is recursive, this removal action is applied into all the submodules.

Parameters:

chain - To remove the transformations. By default, it is the "default" chain.

transformations - List of transformation names (type ids) to be removed.

recursive - If the action is applied to all the submodules.

Throws:

Exception - if the walkmod configuration file can't be read.

setWriter

public void setWriter(String chain,
                      String type,
                      String path,
                      boolean recursive)
               throws Exception

Sets an specific writer for an specific chain.

Parameters:

chain - Chain to apply the writer

type - Writer type to set

path - Writer path to set

recursive - If to set the writer to all the submodules.

Throws:

Exception - if the walkmod configuration file can't be read.

setReader

public void setReader(String chain,
                      String type,
                      String path,
                      boolean recursive)
               throws Exception

Sets an specific reader for an specific chain.

Parameters:

chain - Chain to apply the writer

type - Reader type to set

path - Reader path to set

recursive - If to set the reader to all the submodules.

Throws:

Exception - if the walkmod configuration file can't be read.

removePluginConfig

public void removePluginConfig(PluginConfig pluginConfig,
                               boolean recursive)
                        throws Exception

Removes a plugin from the configuration file.

Parameters:

pluginConfig - Plugin configuration to remove.

recursive - If it necessary to remove the plugin from all the submodules.

Throws:

Exception - if the walkmod configuration file can't be read.

removeModules

public void removeModules(List<String> modules)
                   throws Exception

Removes the module list from the configuration file

Parameters:

modules - Module names to remove

Throws:

Exception - if the walkmod configuration file can't be read.

removeProviders

public void removeProviders(List<String> providers,
                            boolean recursive)
                     throws Exception

Removes the list of configuration providers from the config file.

Parameters:

providers - Name of the configuration providers to remove.

recursive - If it necessary to remove the plugin from all the submodules.

Throws:

Exception - If the walkmod configuration file can't be read.

getConfiguration

public Configuration getConfiguration()
                               throws Exception

Returns the equivalent configuration representation of the Walkmod config file.

Returns:

Configuration object representation of the config file.

Throws:

Exception - If the walkmod configuration file can't be read.

removeChains

public void removeChains(List<String> chains,
                         boolean recursive)
                  throws Exception

Removes the chains from the Walkmod config file.

Parameters:

chains - Chain names to remove

recursive - If it necessary to remove the chains from all the submodules.

Throws:

Exception - If the walkmod configuration file can't be read.

inspectPlugin

public List<BeanDefinition> inspectPlugin(PluginConfig plugin)

Retrieves the bean definitions that contains an specific plugin.

Parameters:

plugin - Plugin container of bean definitions.

Returns:

List of bean definitions.

addConfigurationParameter

public void addConfigurationParameter(String param,
                                      String value,
                                      String type,
                                      String category,
                                      String name,
                                      String chain,
                                      boolean recursive)
                               throws Exception

Sets an specific parameter value into a bean.

Parameters:

param - Parameter name

value - Parameter value

type - Bean type to set the parameter

category - Bean category to set the parameter (walker, reader, transformation, writer)

name - Bean name/alias to set the parameter

chain - Bean chain to filter the beans to take into account

recursive - If it necessary to set the parameter to all the submodules.

Throws:

Exception - If the walkmod configuration file can't be read.