Package io.permazen.cli.config

Class PermazenCliConfig

java.lang.Object

io.permazen.cli.config.CliConfig

io.permazen.cli.config.KeyValueCliConfig

io.permazen.cli.config.CoreApiCliConfig

io.permazen.cli.config.PermazenCliConfig

public class PermazenCliConfig
extends CoreApiCliConfig

Configuration for a CLI application supporting a Permazen database.

Field Summary

Fields

Modifier and Type	Field	Description
protected joptsimple.OptionSpec<File>	classpathOption
protected final HashSet<Class<?>>	modelClasses
protected joptsimple.OptionSpec<String>	modelClassOption
protected joptsimple.OptionSpec<String>	modelPackageOption
protected Permazen	pdb

Fields inherited from class io.permazen.cli.config.CoreApiCliConfig

db, disableNewSchema, enableGcScemas, encodingRegistry, encodingRegistryOption, gcSchemasOption, noNewSchemaOption, schemaFileOption, schemaModel, sessionMode, sessionModeOption

Fields inherited from class io.permazen.cli.config.KeyValueCliConfig

kvdb, kvdbDescription, kvi, kvis, nestedKVDatabase, nestedKVStore

Fields inherited from class io.permazen.cli.config.CliConfig

helpOption, loader, log, readOnlyOption, setReadOnly, setVerbose, verboseOption

Constructor Summary

Constructors

Constructor	Description
PermazenCliConfig()

Method Summary

Modifier and Type	Method	Description
void	addOptions(joptsimple.OptionParser parser)	Configure an OptionParser with the comand line flags supported by this instance.
protected void	addPermazenOptions(joptsimple.OptionParser parser)	Add Permazen layer command line flags to the given option parser.
protected void	configureSession(Session session)	Configure a new Session.
protected SessionMode	getDefaultSessionMode()	Get the default SessionMode.
Permazen	getPermazen()
protected void	processOptions(joptsimple.OptionSet options)	Review parsed options and do any preprocessing before starting database.
void	shutdownDatabase()	Shutdown the database.
void	startupDatabase(joptsimple.OptionSet options)	Configure and start up the database based on the parsed command line options.

Methods inherited from class io.permazen.cli.config.CoreApiCliConfig

addCoreApiOptions, addSessionModeOption, getDatabase

Methods inherited from class io.permazen.cli.config.KeyValueCliConfig

addKeyValueImplementationOptions, getDatabaseDescription, getKVDatabase

Methods inherited from class io.permazen.cli.config.CliConfig

addGenericOptions, createOptionParser, instantiateClass, loadClass, newPermazenExec, newPermazenShell, showHelp, startup

Methods inherited from class java.lang.Object

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

Field Details

classpathOption

protected joptsimple.OptionSpec<File> classpathOption

modelClassOption

protected joptsimple.OptionSpec<String> modelClassOption

modelPackageOption

protected joptsimple.OptionSpec<String> modelPackageOption

pdb

protected Permazen pdb

modelClasses

protected final HashSet<Class<?>> modelClasses

Constructor Details

PermazenCliConfig

public PermazenCliConfig()

Method Details

addOptions

public void addOptions(joptsimple.OptionParser parser)

Description copied from class: CoreApiCliConfig

Configure an OptionParser with the comand line flags supported by this instance.

Overrides:

addOptions in class CoreApiCliConfig

Parameters:

parser - command line flag parser

addPermazenOptions

protected void addPermazenOptions(joptsimple.OptionParser parser)

Add Permazen layer command line flags to the given option parser.

Parameters:

parser - command line flag parser

Throws:

IllegalArgumentException - if parser is null

IllegalStateException - if an option being added has already been added

processOptions

protected void processOptions(joptsimple.OptionSet options)

Description copied from class: CliConfig

Review parsed options and do any preprocessing before starting database.

Overrides:

processOptions in class CoreApiCliConfig

Parameters:

options - parsed command line options

getDefaultSessionMode

protected SessionMode getDefaultSessionMode()

Description copied from class: CoreApiCliConfig

Get the default SessionMode.

Overrides:

getDefaultSessionMode in class CoreApiCliConfig

startupDatabase

public void startupDatabase(joptsimple.OptionSet options)

Description copied from class: CliConfig

Configure and start up the database based on the parsed command line options.

Overrides:

startupDatabase in class CoreApiCliConfig

Parameters:

options - parsed command line options

shutdownDatabase

public void shutdownDatabase()

Description copied from class: CliConfig

Shutdown the database.

Overrides:

shutdownDatabase in class CoreApiCliConfig

getPermazen

public Permazen getPermazen()

Overrides:

getPermazen in class CliConfig

configureSession

protected void configureSession(Session session)

Description copied from class: CliConfig

Configure a new Session.

Overrides:

configureSession in class CoreApiCliConfig

Parameters:

session - new session to configure