Package org.springframework.cloud.dataflow.shell.command

Class ConfigCommands

java.lang.Object

org.springframework.cloud.dataflow.shell.command.ConfigCommands

@ShellComponent
public class ConfigCommands
extends Object

Configuration commands for the Shell.

Author:

Gunnar Hillert, Marius Bogoevici, Ilayaperumal Gopinathan, Gary Russell, Mark Pollack, Eric Bottard, Mike Heath, Chris Bono

Method Summary

Modifier and Type	Method	Description
TablesInfo	info()
String	target(String uri, String username, String password, String clientRegistrationId, String credentialsProviderCommand, boolean skipSslValidation, String proxyUri, String proxyUsername, String proxyPassword)
String	triggerTarget()	Triggers a connection to the DataFlow server using the configured coordinates.

Methods inherited from class java.lang.Object

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

Method Details

target

@ShellMethod(key="dataflow config server",
             value="Configure the Spring Cloud Data Flow REST server to use")
public String target(@ShellOption(value={"","--uri"},help="the location of the Spring Cloud Data Flow REST endpoint",defaultValue="http://localhost:9393/")
 String uri,
 @ShellOption(help="the username for authenticated access to the Admin REST endpoint",defaultValue="__NULL__")
 String username,
 @ShellOption(help="the password for authenticated access to the Admin REST endpoint (valid only with a username)",defaultValue="__NULL__")
 String password,
 @ShellOption(help="the registration id for oauth2 config ",defaultValue="dataflow-shell")
 String clientRegistrationId,
 @ShellOption(help="a command to run that outputs the HTTP credentials used for authentication",defaultValue="__NULL__")
 String credentialsProviderCommand,
 @ShellOption(help="accept any SSL certificate (even self-signed)",defaultValue="false")
 boolean skipSslValidation,
 @ShellOption(help="the uri of the proxy server",defaultValue="__NULL__")
 String proxyUri,
 @ShellOption(help="the username for authenticated access to the secured proxy server",defaultValue="__NULL__")
 String proxyUsername,
 @ShellOption(help="the password for authenticated access to the secured proxy server (valid only with a username)",defaultValue="__NULL__")
 String proxyPassword)
              throws Exception

Throws:

Exception

triggerTarget

public String triggerTarget()
                     throws Exception

Triggers a connection to the DataFlow server using the configured coordinates.

Returns:

result message of the connection attempt

Throws:

Exception - from target method.

info

@ShellMethod(key="dataflow config info",
             value="Show the Dataflow server being used")
public TablesInfo info()