org.apache.lens.cli.commands

Class LensStorageCommands

java.lang.Object

org.apache.lens.cli.commands.BaseLensCommand

org.apache.lens.cli.commands.LensCRUDCommand<XStorage>

org.apache.lens.cli.commands.LensStorageCommands

All Implemented Interfaces:

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

@Component
 @UserDocumentation(title="Commands for Storage Management",
                   description="These commands provide CRUD for Storages")
public class LensStorageCommands
extends LensCRUDCommand<XStorage>
implements org.springframework.shell.core.CommandMarker

The Class LensStorageCommands.

Field Summary

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

DATE_FMT, DATE_PARSER

Constructor Summary

Constructors

Constructor and Description
LensStorageCommands()

Method Summary

Modifier and Type	Method and Description
String	createStorage(File path) Creates the storage.
String	describeStorage(String name) Describe storage.
APIResult	doUpdate(String name, String path)
String	dropStorage(String name) Drop storage.
List<String>	getAll()
String	getStorages()
String	updateStorage(String name, File path) Update storage.

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

create, describe, drop, getSingleObjectName, showAll, update

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

LensStorageCommands

public LensStorageCommands()

Method Detail

getStorages

@CliCommand(value="show storages",
            help="list all storages")
public String getStorages()

createStorage

@CliCommand(value="create storage",
            help="Create a new Storage from file <path-to-storage-spec>")
public String createStorage(@CliOption(key={"","path"},mandatory=true,help="<path-to-storage-spec>") @NonNull
                                                                                                                                          File path)

Creates the storage.

Parameters:

path - the storage spec path

Returns:

the string

dropStorage

@CliCommand(value="drop storage",
            help="drop storage <storage-name>")
public String dropStorage(@CliOption(key={"","name"},mandatory=true,help="<storage-name>")
                                                                                                            String name)

Drop storage.

Parameters:

name - the storage name

Returns:

the string

updateStorage

@CliCommand(value="update storage",
            help="update storage <storage-name> with storage spec from <path-to-storage-spec>")
public String updateStorage(@CliOption(key={"","name"},mandatory=true,help="<storage-name>")
                                                                                                                                                                String name,
                                                                                                                                                                @CliOption(key={"","path"},mandatory=true,help="<path-to-storage-spec>") @NonNull
                                                                                                                                                                File path)

Update storage.

Parameters:

name - the storage name

path - the new storage spec path

Returns:

the string

describeStorage

@CliCommand(value="describe storage",
            help="describe storage <storage-name>")
public String describeStorage(@CliOption(key={"","name"},mandatory=true,help="<storage-name>")
                                                                                                                        String name)

Describe storage.

Parameters:

name - the storage name

Returns:

the string

getAll

public List<String> getAll()

Specified by:

getAll in class LensCRUDCommand<XStorage>

doUpdate

public APIResult doUpdate(String name,
                          String path)

Specified by:

doUpdate in class LensCRUDCommand<XStorage>