org.apache.lens.cli.commands

Class LensConnectionCommands

java.lang.Object

org.apache.lens.cli.commands.BaseLensCommand

org.apache.lens.cli.commands.LensConnectionCommands

All Implemented Interfaces:

org.springframework.shell.core.CommandMarker, org.springframework.shell.core.ExecutionProcessor

@Component
 @UserDocumentation(title="Commands for Session Management",
                   description="Opening the lens CLI shell is equivalent to open a session with lens server.This section provides all the commands available for in shell which are applicable for the full session.")
public class LensConnectionCommands
extends BaseLensCommand

The Class LensConnectionCommands.

Field Summary

Fields inherited from class org.apache.lens.cli.commands.BaseLensCommand

DATE_FMT, DATE_PARSER

Constructor Summary

Constructors

Constructor and Description
LensConnectionCommands()

Method Summary

Modifier and Type	Method and Description
String	addFile(String path) Adds the file.
String	addJar(String path) Adds the jar.
void	debug(boolean enable) Enables to show all class level logs on cli
String	getParam(String param) Gets the param.
String	getSessionHandle() Get the current session handle
String	listResources(String type) List resources.
org.springframework.shell.core.ExitShellRequest	quitShell() Quit shell.
String	removeFile(String path) Removes the file.
String	removeJar(String path) Removes the jar.
String	setParam(String keyval) Sets the param.
String	showParameters() Show parameters.
void	verbose(boolean enable) Enables to show only cliLogger(verbose) logs on cli

Methods inherited from class org.apache.lens.cli.commands.BaseLensCommand

afterReturningInvocation, afterThrowingInvocation, beforeInvocation, formatDate, formatJson, getClient, getClientWrapper, getOrDefaultQueryHandleString, getValidPath, removePrefixBeforeURI, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

LensConnectionCommands

public LensConnectionCommands()

Method Detail

setParam

@CliCommand(value="set",
            help="Assign <value> to session parameter specified with <key> on lens server")
public String setParam(@CliOption(key="",mandatory=true,help="<key>=<value>")
                                                                                                                                            String keyval)

Sets the param.

Parameters:

keyval - the keyval

Returns:

the string

getParam

@CliCommand(value="get",
            help="Fetches and prints session parameter specified with name <key> from lens server")
public String getParam(@CliOption(key={"","key"},mandatory=true,help="<key>")
                                                                                                                                                    String param)

Gets the param.

Parameters:

param - the param

Returns:

the param

showParameters

@CliCommand(value="show params",
            help="Fetches and prints all session parameter from lens server")
public String showParameters()

Show parameters.

Returns:

the string

addJar

@CliCommand(value="add jar",
            help="Adds jar resource to the session")
public String addJar(@CliOption(key={"","path"},mandatory=true,help="<path-to-jar-on-server-side>") @NonNull
                                                                                                       String path)

Adds the jar.

Parameters:

path - the path

Returns:

the string

removeJar

@CliCommand(value="remove jar",
            help="Removes a jar resource from session")
public String removeJar(@CliOption(key={"","path"},mandatory=true,help="<path-to-jar-on-server-side>") @NonNull
                                                                                                                String path)

Removes the jar.

Parameters:

path - the path

Returns:

the string

addFile

@CliCommand(value="add file",
            help="Adds a file resource to session")
public String addFile(@CliOption(key={"","path"},mandatory=true,help="<path-to-file-on-server-side>") @NonNull
                                                                                                        String path)

Adds the file.

Parameters:

path - the path

Returns:

the string

removeFile

@CliCommand(value="remove file",
            help="removes a file resource from session")
public String removeFile(@CliOption(key={"","path"},mandatory=true,help="<path-to-file-on-server-side>") @NonNull
                                                                                                                   String path)

Removes the file.

Parameters:

path - the path

Returns:

the stringadd

listResources

@CliCommand(value="list resources",
            help="list all resources from session. If type is provided,  lists resources of type <resource-type>. Valid values for type are jar and file.")
public String listResources(@CliOption(key={"","type"},mandatory=false,help="<resource-type>")
                                                                                                                                                                                                                            String type)

List resources.

Returns:

the string

getSessionHandle

@CliCommand(value="session",
            help="Print the current session handle")
public String getSessionHandle()

Get the current session handle

debug

@CliCommand(value="debug",
            help="prints all class level logs and verbose logs on cli for debugging purpose. \'debug false\' to turn off all class level logging and verbose level logging ")
public void debug(@CliOption(key={"","enable"},mandatory=false,unspecifiedDefaultValue="true")
                                                                                                                                                                                                                           boolean enable)

Enables to show all class level logs on cli

Parameters:

enable -

verbose

@CliCommand(value="verbose",
            help="Show cliLogger logs on cli. \'verbose false\'  turns off the cliLogger logs on console")
public void verbose(@CliOption(key={"","enable"},mandatory=false,unspecifiedDefaultValue="true")
                                                                                                                                                            boolean enable)

Enables to show only cliLogger(verbose) logs on cli

Parameters:

enable -

quitShell

@CliCommand(value={"close","bye"},
            help="Releases all resources of the server session and exits the shell")
public org.springframework.shell.core.ExitShellRequest quitShell()

Quit shell.

Returns:

the exit shell request