org.zanata.client.commands

Class ConfigurableOptionsImpl

java.lang.Object

org.zanata.client.commands.BasicOptionsImpl

org.zanata.client.commands.ConfigurableOptionsImpl

All Implemented Interfaces:

BasicOptions, ConfigurableOptions

Direct Known Subclasses:

ConfigurableGlossaryOptionsImpl, ConfigurableProjectOptionsImpl, PutProjectOptionsImpl, PutUserOptionsImpl, PutVersionOptionsImpl

public abstract class ConfigurableOptionsImpl
extends BasicOptionsImpl
implements ConfigurableOptions

Base options for commands which support configuration by the user's zanata.ini

Author:

Sean Flanigan

Constructor Summary

Constructors

Constructor and Description
ConfigurableOptionsImpl()

Method Summary

Modifier and Type	Method and Description
String	getKey() API key for accessing the REST API.
boolean	getLogHttp() Enable HTTP message logging.
URL	getUrl() Base URL for the server.
File	getUserConfig() Client configuration file.
String	getUsername() Username for accessing the REST API.
boolean	isAuthRequired() Use to disable check for presence of username and API key before running command.
boolean	isDisableSSLCert() Disable SSL certificate verification when connecting to Zanata host by https.
void	setDisableSSLCert(boolean disableSSLCert)
void	setKey(String key)
void	setLogHttp(boolean logHttp)
void	setUrl(URL url)
void	setUserConfig(File userConfig)
void	setUsername(String username)

Methods inherited from class org.zanata.client.commands.BasicOptionsImpl

getCommandHooks, getDebug, getErrors, getHelp, getQuiet, isDebugSet, isErrorsSet, isInteractiveMode, isInteractiveModeSet, isQuietSet, setBatchMode, setCommandHooks, setDebug, setErrors, setHelp, setInteractiveMode, setQuiet

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zanata.client.commands.BasicOptions

getCommandDescription, getCommandHooks, getCommandName, getDebug, getErrors, getHelp, getQuiet, initCommand, isDebugSet, isErrorsSet, isInteractiveMode, isInteractiveModeSet, isQuietSet, setCommandHooks, setDebug, setErrors, setHelp, setInteractiveMode, setQuiet

Constructor Detail

ConfigurableOptionsImpl

public ConfigurableOptionsImpl()

Method Detail

getKey

public String getKey()

Description copied from interface: ConfigurableOptions

API key for accessing the REST API. Defaults to the value in zanata.ini.

Specified by:

getKey in interface ConfigurableOptions

setKey

public void setKey(String key)

Specified by:

setKey in interface ConfigurableOptions

getUrl

public URL getUrl()

Description copied from interface: ConfigurableOptions

Base URL for the server. Defaults to the value in zanata.xml.

Specified by:

getUrl in interface ConfigurableOptions

setUrl

public void setUrl(URL url)

Specified by:

setUrl in interface ConfigurableOptions

setUserConfig

public void setUserConfig(File userConfig)

Specified by:

setUserConfig in interface ConfigurableOptions

getUserConfig

public File getUserConfig()

Description copied from interface: ConfigurableOptions

Client configuration file.

Specified by:

getUserConfig in interface ConfigurableOptions

getUsername

public String getUsername()

Description copied from interface: ConfigurableOptions

Username for accessing the REST API. Defaults to the value in zanata.ini.

Specified by:

getUsername in interface ConfigurableOptions

setUsername

public void setUsername(String username)

Specified by:

setUsername in interface ConfigurableOptions

getLogHttp

public boolean getLogHttp()

Description copied from interface: ConfigurableOptions

Enable HTTP message logging.

Specified by:

getLogHttp in interface ConfigurableOptions

setLogHttp

public void setLogHttp(boolean logHttp)

Specified by:

setLogHttp in interface ConfigurableOptions

isDisableSSLCert

public boolean isDisableSSLCert()

Description copied from interface: ConfigurableOptions

Disable SSL certificate verification when connecting to Zanata host by https.

Specified by:

isDisableSSLCert in interface ConfigurableOptions

setDisableSSLCert

public void setDisableSSLCert(boolean disableSSLCert)

Specified by:

setDisableSSLCert in interface ConfigurableOptions

isAuthRequired

public boolean isAuthRequired()

Description copied from interface: ConfigurableOptions

Use to disable check for presence of username and API key before running command.

Specified by:

isAuthRequired in interface ConfigurableOptions

Returns:

true if this command should fail when username or API key is absent.