org.springframework.cloud.dataflow.shell.command

Class LibraryCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.LibraryCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

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

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

Author:

Eric Bottard

Constructor Summary

Constructors

Constructor and Description
LibraryCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
org.springframework.shell.table.Table	list()
String	register(String name, String coordinates, boolean force)
void	setDataFlowShell(DataFlowShell dataFlowShell)
String	unregister(String name)

Methods inherited from class java.lang.Object

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

Constructor Detail

LibraryCommands

public LibraryCommands()

Method Detail

setDataFlowShell

@Autowired
public void setDataFlowShell(DataFlowShell dataFlowShell)

available

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

register

@CliCommand(value="library register",
            help="Register a new library")
public String register(@CliOption(mandatory=true,key={"","name"},help="the name for the library to register")
                         String name,
                         @CliOption(mandatory=true,key="coordinates",help="coordinates to the library")
                         String coordinates,
                         @CliOption(key="force",help="force update if library already exists (only if not in use)",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                         boolean force)

unregister

@CliCommand(value="library unregister",
            help="Unregister a library")
public String unregister(@CliOption(mandatory=true,key={"","name"},help="name of the library to unregister")
                           String name)

list

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