org.jboss.as.cli

Interface CliConfig

public interface CliConfig

This interface represents the JBoss CLI configuration.

Author:

Alexey Loubyansky

Method Summary

Modifier and Type	Method and Description
ControllerAddress	getAliasedControllerAddress(String alias) Obtain the ControllerAddress for a given alias.
int	getConnectionTimeout() Connection timeout period in milliseconds.
ControllerAddress	getDefaultControllerAddress() The default address of the controller from the configuration.
String	getDefaultControllerHost() Deprecated. Use getDefaultControllerAddress() instead.
int	getDefaultControllerPort() Deprecated. Use getDefaultControllerAddress() instead.
String	getDefaultControllerProtocol() The default server controller protocol for addresses where no protocol is specified.
String	getHistoryFileDir() The directory which contains the command and operation history file.
String	getHistoryFileName() The name of the command and operation history file.
int	getHistoryMaxSize() Maximum size of the history log.
SSLConfig	getSslConfig() The global SSL configuration if it has been defined.
boolean	isAccessControl() Whether the role based access control should be used to check the availability of the commands (for tab-completion).
boolean	isHistoryEnabled() Whether the record the history of executed commands and operations.
boolean	isResolveParameterValues() Whether to resolve system properties specified as command argument (or operation parameter) values before sending the operation request to the controller or let the resolution happen on the server side.
boolean	isSilent() Whether the info or error messages should be written to the terminal output.
boolean	isUseLegacyOverride() If true then for addresses specified without a protocol but with a port number of 9999 the protocol should be assumed to be 'remoting://'
boolean	isValidateOperationRequests() Whether the operation requests should be validated in terms of addresses, operation names and parameters before they are sent to the controller for execution.

Method Detail

getDefaultControllerHost

@Deprecated
String getDefaultControllerHost()

Deprecated. Use getDefaultControllerAddress() instead.

The default server controller host to connect to.

Returns:

default server controller host to connect to

getDefaultControllerPort

@Deprecated
int getDefaultControllerPort()

Deprecated. Use getDefaultControllerAddress() instead.

The default server controller port to connect to.

Returns:

default server controller port to connect to

getDefaultControllerProtocol

String getDefaultControllerProtocol()

The default server controller protocol for addresses where no protocol is specified.

Returns:

default server controller protocol

isUseLegacyOverride

boolean isUseLegacyOverride()

If true then for addresses specified without a protocol but with a port number of 9999 the protocol should be assumed to be 'remoting://'

Returns:

use legacy override option.

getDefaultControllerAddress

ControllerAddress getDefaultControllerAddress()

The default address of the controller from the configuration.

Returns:

The default address.

getAliasedControllerAddress

ControllerAddress getAliasedControllerAddress(String alias)

Obtain the ControllerAddress for a given alias.

Parameters:

alias - - The alias if the address mapping.

Returns:

The ControllerAddress if defined, otherwise null

isHistoryEnabled

boolean isHistoryEnabled()

Whether the record the history of executed commands and operations.

Returns:

true if the history is enabled, false - otherwise.

getHistoryFileName

String getHistoryFileName()

The name of the command and operation history file.

Returns:

name of the command and operation history file

getHistoryFileDir

String getHistoryFileDir()

The directory which contains the command and operation history file.

Returns:

directory which contains the command and operation history file.

getHistoryMaxSize

int getHistoryMaxSize()

Maximum size of the history log.

Returns:

maximum size of the history log

getConnectionTimeout

int getConnectionTimeout()

Connection timeout period in milliseconds.

Returns:

connection timeout in milliseconds

getSslConfig

SSLConfig getSslConfig()

The global SSL configuration if it has been defined.

Returns:

The SSLConfig

isValidateOperationRequests

boolean isValidateOperationRequests()

Whether the operation requests should be validated in terms of addresses, operation names and parameters before they are sent to the controller for execution.

Returns:

true is the operation requests should be validated, false - otherwise.

isResolveParameterValues

boolean isResolveParameterValues()

Whether to resolve system properties specified as command argument (or operation parameter) values before sending the operation request to the controller or let the resolution happen on the server side. If the method returns true, the resolution should be performed by the CLI, otherwise - on the server side.

Returns:

true if the system properties specified as operation parameter values should be resolved by the CLI, false if the resolution of the parameter values should happen on the server side.

isSilent

boolean isSilent()

Whether the info or error messages should be written to the terminal output. The output of the info and error messages is done in the following way: 1) the message is always logged using a logger (which is disabled in the config by default); 2) if the output target was specified on the command line using '>' it would be used; 3) if the output target was not specified, whether the message is written or not to the terminal output will depend on whether it's a silent mode or not.

Returns:

isAccessControl

boolean isAccessControl()

Whether the role based access control should be used to check the availability of the commands (for tab-completion).

Returns:

true if command availability checks should include RBAC, otherwise - false