org.springframework.cloud.dataflow.shell.command

Class AppRegistryCommands

java.lang.Object

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

All Implemented Interfaces:

Aware, ResourceLoaderAware

@ShellComponent
public class AppRegistryCommands
extends Object
implements 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, Thomas Risberg, Gunnar Hillert, Christian Tzolov, Chris Schaefer, Chris Bono

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.

Field Summary

Fields

Modifier and Type	Field and Description
protected DataFlowShell	dataFlowShell
protected ResourceLoader	resourceLoader

Constructor Summary

Constructors

Constructor and Description
AppRegistryCommands(DataFlowShell dataFlowShell)

Method Summary

Modifier and Type	Method and Description
protected AppRegistryOperations	appRegistryOperations()
org.springframework.shell.Availability	availableWithCreateRole()
org.springframework.shell.Availability	availableWithDestroyRole()
org.springframework.shell.Availability	availableWithUModifyRole()
org.springframework.shell.Availability	availableWithViewRole()
String	defaultApplication(AppRegistryCommands.QualifiedApplicationName application, String version)
String	importFromResource(String uri, boolean local, boolean force)
TablesInfo	info(String name, ApplicationType type, String version, boolean exhaustive)
Object	list(AppRegistryCommands.QualifiedApplicationName application)
protected String	prettyPrintDefaultValue(org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty o) Escapes some special values so that they don't disturb console rendering and are easier to read.
String	register(String name, ApplicationType type, org.springframework.cloud.dataflow.schema.AppBootSchemaVersion bootVersion, String uri, String metadataUri, boolean force)
void	setResourceLoader(ResourceLoader resourceLoader)
String	unregister(String name, ApplicationType type, String version)
String	unregisterAll()

Methods inherited from class java.lang.Object

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

Field Detail

dataFlowShell

protected final DataFlowShell dataFlowShell

resourceLoader

protected ResourceLoader resourceLoader

Constructor Detail

AppRegistryCommands

public AppRegistryCommands(DataFlowShell dataFlowShell)

Method Detail

setResourceLoader

public void setResourceLoader(ResourceLoader resourceLoader)

Specified by:

setResourceLoader in interface ResourceLoaderAware

availableWithViewRole

public org.springframework.shell.Availability availableWithViewRole()

availableWithCreateRole

public org.springframework.shell.Availability availableWithCreateRole()

availableWithUModifyRole

public org.springframework.shell.Availability availableWithUModifyRole()

availableWithDestroyRole

public org.springframework.shell.Availability availableWithDestroyRole()

info

@ShellMethod(key="app info",
             value="Get information about an application")
 @ShellMethodAvailability(value="availableWithViewRole")
public TablesInfo info(@ShellOption(value="--name",help="name of the application to query",valueProvider=ApplicationNameValueProvider.class)
                                                                                                                                                                        String name,
                                                                                                                                                                        @ShellOption(help="type of the application to query",valueProvider=org.springframework.shell.standard.EnumValueProvider.class)
                                                                                                                                                                        ApplicationType type,
                                                                                                                                                                        @ShellOption(help="the version for the registered application",defaultValue="__NULL__")
                                                                                                                                                                        String version,
                                                                                                                                                                        @ShellOption(help="return all metadata, including common Spring Boot properties",defaultValue="false")
                                                                                                                                                                        boolean exhaustive)

unregister

@ShellMethod(key="app unregister",
             value="Unregister an application")
 @ShellMethodAvailability(value="availableWithDestroyRole")
public String unregister(@ShellOption(value={"","--name"},help="name of the application to unregister",valueProvider=ApplicationNameValueProvider.class)
                                                                                                                                                                        String name,
                                                                                                                                                                        @ShellOption(help="type of the application to unregister",valueProvider=org.springframework.shell.standard.EnumValueProvider.class)
                                                                                                                                                                        ApplicationType type,
                                                                                                                                                                        @ShellOption(help="the version application to unregister",defaultValue="__NULL__")
                                                                                                                                                                        String version)

unregisterAll

@ShellMethod(key="app all unregister",
             value="Unregister all applications")
 @ShellMethodAvailability(value="availableWithDestroyRole")
public String unregisterAll()

defaultApplication

@ShellMethod(key="app default",
             value="Change the default application version")
 @ShellMethodAvailability(value="availableWithUModifyRole")
public String defaultApplication(@ShellOption(value={"","--id"},help="id of the application to query in the form of \'type:name\'")
                                                                                                                                                                                          AppRegistryCommands.QualifiedApplicationName application,
                                                                                                                                                                                          @ShellOption(help="the new default application version")
                                                                                                                                                                                          String version)

register

@ShellMethod(key="app register",
             value="Register a new application")
 @ShellMethodAvailability(value="availableWithCreateRole")
public String register(@ShellOption(value={"","--name"},help="the name for the registered application")
                                                                                                                                                                    String name,
                                                                                                                                                                    @ShellOption(help="the type for the registered application",valueProvider=org.springframework.shell.standard.EnumValueProvider.class)
                                                                                                                                                                    ApplicationType type,
                                                                                                                                                                    @ShellOption(value={"-b","--bootVersion"},help="the boot version to use for the registered application",defaultValue="__NULL__")
                                                                                                                                                                    org.springframework.cloud.dataflow.schema.AppBootSchemaVersion bootVersion,
                                                                                                                                                                    @ShellOption(help="URI for the application artifact")
                                                                                                                                                                    String uri,
                                                                                                                                                                    @ShellOption(value={"-m","--metadata-uri","--metadataUri"},help="Metadata URI for the application artifact",defaultValue="__NULL__")
                                                                                                                                                                    String metadataUri,
                                                                                                                                                                    @ShellOption(help="force update if application is already registered (only if not in use)",defaultValue="false")
                                                                                                                                                                    boolean force)

list

@ShellMethod(key="app list",
             value="List all registered applications")
 @ShellMethodAvailability(value="availableWithViewRole")
public Object list(@ShellOption(value={"","--id"},help="id of the application to query in the form of \'type:name\'",defaultValue="__NULL__")
                                                                                                                                                                AppRegistryCommands.QualifiedApplicationName application)

importFromResource

@ShellMethod(key="app import",
             value="Register all applications listed in a properties file")
 @ShellMethodAvailability(value="availableWithCreateRole")
public String importFromResource(@ShellOption(help="URI for the properties file")
                                                                                                                                                                                                       String uri,
                                                                                                                                                                                                       @ShellOption(help="whether to resolve the URI locally (as opposed to on the server)",defaultValue="true",arity=1)
                                                                                                                                                                                                       boolean local,
                                                                                                                                                                                                       @ShellOption(help="force update if any module already exists (only if not in use)",defaultValue="false")
                                                                                                                                                                                                       boolean force)

appRegistryOperations

protected AppRegistryOperations appRegistryOperations()

prettyPrintDefaultValue

protected String prettyPrintDefaultValue(org.springframework.boot.configurationmetadata.ConfigurationMetadataProperty o)

Escapes some special values so that they don't disturb console rendering and are easier to read.

Parameters:

o - the configurationMetadataProperty to pretty print

Returns:

the pretty printed value