org.springframework.cloud.dataflow.shell.command.common

Class AbstractStreamCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.common.AbstractStreamCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

Direct Known Subclasses:

ClassicStreamCommands, SkipperStreamCommands

public abstract class AbstractStreamCommands
extends Object
implements org.springframework.shell.core.CommandMarker

Stream commands.

Author:

Ilayaperumal Gopinathan, Mark Fisher, Gunnar Hillert, Glenn Renfro, Christian Tzolov, Janne Valkealahti

Field Summary

Fields

Modifier and Type	Field and Description
protected DataFlowShell	dataFlowShell
protected static String	PROPERTIES_FILE_OPTION
protected static String	PROPERTIES_OPTION
protected UserInput	userInput

Constructor Summary

Constructors

Constructor and Description
AbstractStreamCommands()

Method Summary

Modifier and Type	Method and Description
boolean	availableWithCreateRole()
boolean	availableWithViewRole()
String	createStream(String name, String dsl, boolean deploy)
String	destroyAllStreams(boolean force)
String	destroyStream(String name)
org.springframework.shell.table.Table	listStreams()
List<Object>	streamInfo(String name)
protected StreamOperations	streamOperations()
String	undeployAllStreams(boolean force)
String	undeployStream(String name)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTIES_OPTION

protected static final String PROPERTIES_OPTION

See Also:

Constant Field Values

PROPERTIES_FILE_OPTION

protected static final String PROPERTIES_FILE_OPTION

See Also:

Constant Field Values

dataFlowShell

protected DataFlowShell dataFlowShell

userInput

protected UserInput userInput

Constructor Detail

AbstractStreamCommands

public AbstractStreamCommands()

Method Detail

availableWithViewRole

@CliAvailabilityIndicator(value={"stream list","stream info"})
public boolean availableWithViewRole()

availableWithCreateRole

@CliAvailabilityIndicator(value={"stream create","stream undeploy","stream all undeploy","stream destroy","stream all destroy"})
public boolean availableWithCreateRole()

createStream

@CliCommand(value="stream create",
            help="Create a new stream definition")
public String createStream(@CliOption(mandatory=true,key={"","name"},help="the name to give to the stream")
                                                                                                                 String name,
                                                                                                                 @CliOption(mandatory=true,key="definition",help="a stream definition, using the DSL (e.g. \"http --port=9000 | hdfs\")",optionContext="disable-string-converter completion-stream")
                                                                                                                 String dsl,
                                                                                                                 @CliOption(key="deploy",help="whether to deploy the stream immediately",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                                                                                                 boolean deploy)

listStreams

@CliCommand(value="stream list",
            help="List created streams")
public org.springframework.shell.table.Table listStreams()

streamInfo

@CliCommand(value="stream info",
            help="Show information about a specific stream")
public List<Object> streamInfo(@CliOption(key={"","name"},help="the name of the stream to show",mandatory=true,optionContext="existing-stream disable-string-converter")
                                                                                                                             String name)

undeployStream

@CliCommand(value="stream undeploy",
            help="Un-deploy a previously deployed stream")
public String undeployStream(@CliOption(key={"","name"},help="the name of the stream to un-deploy",mandatory=true,optionContext="existing-stream disable-string-converter")
                                                                                                                             String name)

undeployAllStreams

@CliCommand(value="stream all undeploy",
            help="Un-deploy all previously deployed stream")
public String undeployAllStreams(@CliOption(key="force",help="bypass confirmation prompt",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                                                                                                                       boolean force)

destroyStream

@CliCommand(value="stream destroy",
            help="Destroy an existing stream")
public String destroyStream(@CliOption(key={"","name"},help="the name of the stream to destroy",mandatory=true,optionContext="existing-stream disable-string-converter")
                                                                                                               String name)

destroyAllStreams

@CliCommand(value="stream all destroy",
            help="Destroy all existing streams")
public String destroyAllStreams(@CliOption(key="force",help="bypass confirmation prompt",unspecifiedDefaultValue="false",specifiedDefaultValue="true")
                                                                                                                         boolean force)

streamOperations

protected StreamOperations streamOperations()