org.springframework.xd.shell.command

Class ModuleCommands

java.lang.Object

org.springframework.xd.shell.command.ModuleCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

@Component
public class ModuleCommands
extends java.lang.Object
implements org.springframework.shell.core.CommandMarker

Commands for working with modules. Allows retrieval of information about available modules, as well as creating new composed modules.

Author:

Glenn Renfro, Eric Bottard, Florent Biville, David Turanski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleCommands.QualifiedModuleName

Constructor Summary

Constructors

Constructor and Description
ModuleCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
java.lang.String	composeModule(java.lang.String name, java.lang.String dsl, boolean force)
java.lang.String	destroyModule(ModuleCommands.QualifiedModuleName module)
Table	listModules()
java.lang.String	moduleInfo(ModuleCommands.QualifiedModuleName module, boolean showHidden)
java.lang.String	uploadModule(RESTModuleType type, java.lang.String name, java.io.File file, boolean force)

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleCommands

public ModuleCommands()

Method Detail

available

@CliAvailabilityIndicator(value={"module compose","module list","module info","module delete","module upload"})
public boolean available()

moduleInfo

@CliCommand(value="module info",
            help="Get information about a module")
public java.lang.String moduleInfo(@CliOption(mandatory=true,key={"name",""},help="name of the module to query, in the form \'type:name\'")
                                     ModuleCommands.QualifiedModuleName module,
                                     @CliOption(key="hidden",help="whether to show \'hidden\' options",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                                     boolean showHidden)

composeModule

@CliCommand(value="module compose",
            help="Create a virtual module")
public java.lang.String composeModule(@CliOption(mandatory=true,key={"name",""},help="the name to give to the module")
                                        java.lang.String name,
                                        @CliOption(mandatory=true,key="definition",optionContext="completion-module disable-string-converter",help="module definition using xd dsl")
                                        java.lang.String dsl,
                                        @CliOption(key="force",help="force update if module already exists (only if not in use)",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                                        boolean force)

uploadModule

@CliCommand(value="module upload",
            help="Upload a new module")
public java.lang.String uploadModule(@CliOption(mandatory=true,key="type",help="the type for the uploaded module")
                                       RESTModuleType type,
                                       @CliOption(mandatory=true,key="name",help="the name for the uploaded module")
                                       java.lang.String name,
                                       @CliOption(mandatory=true,key={"","file"},help="path to the module archive")
                                       java.io.File file,
                                       @CliOption(key="force",help="force update if module already exists (only if not in use)",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                                       boolean force)
                              throws java.io.IOException

Throws:

java.io.IOException

destroyModule

@CliCommand(value="module delete",
            help="Delete a virtual module")
public java.lang.String destroyModule(@CliOption(mandatory=true,key={"name",""},help="name of the module to delete, in the form \'type:name\'")
                                        ModuleCommands.QualifiedModuleName module)

listModules

@CliCommand(value="module list",
            help="List all modules")
public Table listModules()