org.springframework.cloud.dataflow.shell.command

Class ModuleCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.ModuleCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

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

Commands for working with modules. Allows retrieval of information about available modules, as well as creating and removing module registrations.

Author:

Glenn Renfro, Eric Bottard, Florent Biville, David Turanski, Patrick Peralta

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleCommands.QualifiedModuleName Unique identifier for a module, including the name and type.

Constructor Summary

Constructors

Constructor and Description
ModuleCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
List<Object>	info(ModuleCommands.QualifiedModuleName module)
org.springframework.shell.table.Table	list()
String	register(String name, org.springframework.cloud.dataflow.core.ArtifactType type, String coordinates, boolean force)
void	setDataFlowShell(DataFlowShell dataFlowShell)
String	unregister(String name, org.springframework.cloud.dataflow.core.ArtifactType type)

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

setDataFlowShell

@Autowired
public void setDataFlowShell(DataFlowShell dataFlowShell)

available

@CliAvailabilityIndicator(value={"module list","module info","module unregister","module register"})
public boolean available()

info

@CliCommand(value="module info",
            help="Get information about a module")
public List<Object> info(@CliOption(mandatory=true,key={"","name"},help="name of the module to query in the form of \'type:name\'")
                           ModuleCommands.QualifiedModuleName module)

register

@CliCommand(value="module register",
            help="Register a new module")
public String register(@CliOption(mandatory=true,key={"","name"},help="the name for the registered module")
                         String name,
                         @CliOption(mandatory=true,key="type",help="the type for the registered module")
                         org.springframework.cloud.dataflow.core.ArtifactType type,
                         @CliOption(mandatory=true,key="coordinates",help="coordinates to the module archive")
                         String coordinates,
                         @CliOption(key="force",help="force update if module already exists (only if not in use)",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                         boolean force)

unregister

@CliCommand(value="module unregister",
            help="Unregister a module")
public String unregister(@CliOption(mandatory=true,key={"","name"},help="name of the module to unregister")
                           String name,
                           @CliOption(mandatory=false,key="type",help="type of the module to unregister")
                           org.springframework.cloud.dataflow.core.ArtifactType type)

list

@CliCommand(value="module list",
            help="List all modules")
public org.springframework.shell.table.Table list()