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

Class AbstractAppRegistryCommands

java.lang.Object

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

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker

Direct Known Subclasses:

ClassicAppRegistryCommands, SkipperAppRegistryCommands

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected DataFlowShell	dataFlowShell
protected org.springframework.core.io.ResourceLoader	resourceLoader

Constructor Summary

Constructors

Constructor and Description
AbstractAppRegistryCommands()

Method Summary

Modifier and Type	Method and Description
protected AppRegistryOperations	appRegistryOperations()
boolean	availableWithCreateRole()
boolean	availableWithViewRole()
String	importFromResource(String uri, boolean local, boolean force)
Object	list(AbstractAppRegistryCommands.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, String uri, String metadataUri, boolean force)
void	setDataFlowShell(DataFlowShell dataFlowShell)
void	setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)

Methods inherited from class java.lang.Object

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

Field Detail

dataFlowShell

protected DataFlowShell dataFlowShell

resourceLoader

protected org.springframework.core.io.ResourceLoader resourceLoader

Constructor Detail

AbstractAppRegistryCommands

public AbstractAppRegistryCommands()

Method Detail

setDataFlowShell

public void setDataFlowShell(DataFlowShell dataFlowShell)

setResourceLoader

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

availableWithViewRole

@CliAvailabilityIndicator(value="app list")
public boolean availableWithViewRole()

availableWithCreateRole

@CliAvailabilityIndicator(value={"app register","app import"})
public boolean availableWithCreateRole()

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")
                                                                                                        ApplicationType type,
                                                                                                        @CliOption(mandatory=true,key="uri",help="URI for the application artifact")
                                                                                                        String uri,
                                                                                                        @CliOption(key="metadata-uri",help="Metadata URI for the application artifact")
                                                                                                        String metadataUri,
                                                                                                        @CliOption(key="force",help="force update if application is already registered (only if not in use)",specifiedDefaultValue="true",unspecifiedDefaultValue="false")
                                                                                                        boolean force)

list

@CliCommand(value="app list",
            help="List all registered applications")
public Object list(@CliOption(key={"","id"},help="id of the application to query in the form of \'type:name\'")
                                                                                                      AbstractAppRegistryCommands.QualifiedApplicationName application)

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)

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.