org.springframework.cloud.dataflow.shell.command

Class AppRegistryCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.AppRegistryCommands

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ResourceLoaderAware, org.springframework.shell.core.CommandMarker

@Component
public class AppRegistryCommands
extends Object
implements org.springframework.shell.core.CommandMarker, org.springframework.context.ResourceLoaderAware

Commands for working with the application registry. Allows retrieval of information about available applications, as well as creating and removing application registrations.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppRegistryCommands.QualifiedApplicationName Unique identifier for an application, including the name and type.

Constructor Summary

Constructors

Constructor and Description
AppRegistryCommands()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	available()
String	importFromResource(String uri, boolean local, boolean force)
List<Object>	info(AppRegistryCommands.QualifiedApplicationName application)
org.springframework.shell.table.Table	list()
String	register(String name, org.springframework.cloud.dataflow.core.ApplicationType type, String uri, boolean force)
void	setDataFlowShell(DataFlowShell dataFlowShell)
void	setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
String	unregister(String name, org.springframework.cloud.dataflow.core.ApplicationType type)

Methods inherited from class java.lang.Object

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

Constructor Detail

AppRegistryCommands

public AppRegistryCommands()

Method Detail

setDataFlowShell

@Autowired
public void setDataFlowShell(DataFlowShell dataFlowShell)

setResourceLoader

public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface org.springframework.context.ResourceLoaderAware

available

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

info

@CliCommand(value="app info",
            help="Get information about an application")
public List<Object> info(@CliOption(mandatory=true,key={"","id"},help="id of the application to query in the form of \'type:name\'")
                           AppRegistryCommands.QualifiedApplicationName application)

register

@CliCommand(value="app register",
            help="Register a new application")
public String register(@CliOption(mandatory=true,key={"","name"},help="the name for the registered application")
                         String name,
                         @CliOption(mandatory=true,key="type",help="the type for the registered application")
                         org.springframework.cloud.dataflow.core.ApplicationType type,
                         @CliOption(mandatory=true,key="uri",help="URI for the application artifact")
                         String uri,
                         @CliOption(key="force",help="force update if application is already registered (only if not in use)",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                         boolean force)

unregister

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

list

@CliCommand(value="app list",
            help="List all registered applications")
public org.springframework.shell.table.Table list()

importFromResource

@CliCommand(value="app import",
            help="Register all applications listed in a properties file")
public String importFromResource(@CliOption(mandatory=true,key={"","uri"},help="URI for the properties file")
                                   String uri,
                                   @CliOption(key="local",help="whether to resolve the URI locally (as opposed to on the server)",specifiedDefaultValue="true",unspecifiedDefaultValue="true")
                                   boolean local,
                                   @CliOption(key="force",help="force update if any module already exists (only if not in use)",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                                   boolean force)