org.zanata.client.commands

Interface ConfigurableOptions

All Superinterfaces:

BasicOptions

All Known Subinterfaces:

ConfigurableProjectOptions, GetStatisticsOptions, GlossaryDeleteOptions, GlossaryPushOptions, PublicanPullOptions, PublicanPushOptions, PullOptions, PushOptions, PushPullOptions, PutProjectOptions, PutUserOptions, PutVersionOptions

All Known Implementing Classes:

ConfigurableOptionsImpl, ConfigurableProjectOptionsImpl, GetStatisticsOptionsImpl, ListLocalOptionsImpl, ListRemoteOptionsImpl, PublicanPullOptionsImpl, PublicanPushOptionsImpl, PutProjectOptionsImpl, PutUserOptionsImpl, PutVersionOptionsImpl

public interface ConfigurableOptions
extends BasicOptions

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

Author:

Sean Flanigan

Method Summary

Methods

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.
void	setKey(String key)
void	setLogHttp(boolean traceLogging)
void	setUrl(URL url)
void	setUserConfig(File userConfig)
void	setUsername(String username)

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

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

Method Detail

getKey

String getKey()

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

setKey

void setKey(String key)

getUrl

URL getUrl()

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

setUrl

void setUrl(URL url)

getUserConfig

File getUserConfig()

Client configuration file.

setUserConfig

void setUserConfig(File userConfig)

getUsername

String getUsername()

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

setUsername

void setUsername(String username)

getLogHttp

boolean getLogHttp()

Enable HTTP message logging.

setLogHttp

void setLogHttp(boolean traceLogging)