DefaultOperation (GeoWave Parent POM 2.0.2-SNAPSHOT API)

java.lang.Object
- org.locationtech.geowave.core.cli.api.DefaultOperation

All Implemented Interfaces:

Operation

Direct Known Subclasses:

AbstractGeoWaveQuery, AbstractSplitsCommand, AccumuloRunServerCommand, AccumuloSection, AnalyticSection, BigtableSection, CassandraSection, CompactIndexCommand, CompactStatsCommand, ConfigAWSCommand, ConfigSection, CopyCommand, CopyConfigStoreCommand, CopyStoreCommand, CoverageSection, CoverageStoreSection, CQLDelete, DatastoreSection, DebugSection, DeletePyramidLevelCommand, DynamoDBSection, ExplainCommand, FeatureLayerSection, FileSystemSection, GeoServerSection, GeoWaveTopLevelSection, GrpcSection, GWQLQuery, HBaseSection, HelpCommand, IndexSection, IngestOSMToGeoWaveCommand, IngestSection, InstallGdalCommand, KmeansJumpCommand, KmeansParallelCommand, KuduSection, Landsat8AnalyzeCommand, Landsat8DownloadCommand, Landsat8IngestCommand, Landsat8IngestRasterCommand, Landsat8IngestVectorCommand, Landsat8Section, LayerSection, MigrationCommand, MinimalFullTable, NewTokenCommand, OSMSection, PythonRunGatewayCommand, PythonSection, RasterSection, RedisSection, ResizeMRCommand, ResizeSparkCommand, RunBigtableEmulator, RunCassandraServer, RunDynamoDBLocal, RunGeoServer, RunHBaseServer, RunKuduLocal, RunRedisServer, Sentinel2AnalyzeCommand, Sentinel2DownloadCommand, Sentinel2ImageryProvidersCommand, Sentinel2IngestCommand, Sentinel2IngestRasterCommand, Sentinel2IngestVectorCommand, Sentinel2Section, ServiceEnabledCommand, StageOSMToHDFSCommand, StartGrpcServerCommand, StatsSection, StopGrpcServerCommand, StoreSection, StyleSection, TypeSection, UtilSection, VectorLocalExportCommand, VectorMRExportCommand, VectorSection, WorkspaceSection
```
public abstract class DefaultOperation
extends Object
implements Operation
```
The default operation prevents implementors from having to implement the 'prepare' function, if they don't want to.

Constructor Summary

Constructors
Constructor and Description

DefaultOperation()

Constructors
Constructor and Description
`DefaultOperation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`generateNewEncryptionToken(File tokenFile)` Generate a new token value in a specified file.
`File`	`getGeoWaveConfigFile()`
`File`	`getGeoWaveConfigFile(OperationParams params)`
`Properties`	`getGeoWaveConfigProperties()`
`Properties`	`getGeoWaveConfigProperties(OperationParams params)`
`Properties`	`getGeoWaveConfigProperties(OperationParams params, String filter)`
`File`	`getGeoWaveDirectory()`
`File`	`getSecurityTokenFile()`
`boolean`	`prepare(OperationParams params)` NOTE: ONLY USE THIS METHOD TO SET @PARAMETERSDELEGATE options.
`void`	`setSecurityTokenFile(File securityTokenFile)`
`String`	`usage()` Method to allow commands the option to override the default usage from jcommander where all the fields are printed out in alphabetical order.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultOperation
```
public DefaultOperation()
```
- Method Detail
  - prepare
```
public boolean prepare(OperationParams params)
                throws com.beust.jcommander.ParameterException
```
    Description copied from interface: Operation
    
    NOTE: ONLY USE THIS METHOD TO SET @PARAMETERSDELEGATE options. If you throw exceptions or do validation, then it will make help/explain commands not work correctly.
    
    Specified by:
    
    prepare in interface Operation
    
    Throws:
    
    com.beust.jcommander.ParameterException
  - generateNewEncryptionToken
```
protected boolean generateNewEncryptionToken(File tokenFile)
```
    Generate a new token value in a specified file.
    
    Parameters:
    
    tokenFile -
    
    Returns:
    
    true if the encryption tocken was successfully generated
  - getSecurityTokenFile
```
public File getSecurityTokenFile()
```
    Returns:
    
    the securityTokenFile
  - setSecurityTokenFile
```
public void setSecurityTokenFile(File securityTokenFile)
```
    Parameters:
    
    securityTokenFile - the securityTokenFile to set
  - getGeoWaveDirectory
```
public File getGeoWaveDirectory()
```
    Returns:
    
    the geowaveDirectory
  - getGeoWaveConfigFile
```
public File getGeoWaveConfigFile(OperationParams params)
```
    Returns:
    
    the geowaveConfigFile
  - getGeoWaveConfigFile
```
public File getGeoWaveConfigFile()
```
  - getGeoWaveConfigProperties
```
public Properties getGeoWaveConfigProperties(OperationParams params,
                                             String filter)
```
  - getGeoWaveConfigProperties
```
public Properties getGeoWaveConfigProperties(OperationParams params)
```
  - getGeoWaveConfigProperties
```
public Properties getGeoWaveConfigProperties()
```
  - usage
```
public String usage()
```
    Description copied from interface: Operation
    
    Method to allow commands the option to override the default usage from jcommander where all the fields are printed out in alphabetical order. Some classes may want to put the basic/required fields first, with optional fields at the bottom, or however other custom usage's would be necessary.
    
    If method returns null, the default usage from jcommander is used
    
    Specified by:
    
    usage in interface Operation

Class DefaultOperation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultOperation

Method Detail

prepare

generateNewEncryptionToken

getSecurityTokenFile

setSecurityTokenFile

getGeoWaveDirectory

getGeoWaveConfigFile

getGeoWaveConfigFile

getGeoWaveConfigProperties

getGeoWaveConfigProperties

getGeoWaveConfigProperties

usage