org.jboss.as.controller.client

Class ModelControllerClientConfiguration.Builder

java.lang.Object

org.jboss.as.controller.client.ModelControllerClientConfiguration.Builder

Enclosing interface:

ModelControllerClientConfiguration

public static class ModelControllerClientConfiguration.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ModelControllerClientConfiguration	build() Builds the configuration object based on this builder's settings.
ModelControllerClientConfiguration.Builder	setClientBindAddress(String clientBindAddress) Sets the local address to which the client socket should be bound.
ModelControllerClientConfiguration.Builder	setConnectionTimeout(int connectionTimeout) Maximum time, in milliseconds, to wait for the connection to be established
ModelControllerClientConfiguration.Builder	setExecutorService(ExecutorService executorService) Sets the executor service to use for asynchronous tasks.
ModelControllerClientConfiguration.Builder	setHandler(CallbackHandler handler) Sets the handler for callbacks to obtain authentication information.
ModelControllerClientConfiguration.Builder	setHostName(String hostName) Sets the remote host name to which the client should connect.
ModelControllerClientConfiguration.Builder	setPort(int port) Sets the remote port to which the client should connect
ModelControllerClientConfiguration.Builder	setProtocol(String protocol) Sets the protocol to use for communicating with the remote process.
ModelControllerClientConfiguration.Builder	setSaslOptions(Map<String,String> saslOptions) Sets the SASL options for the remote connection
ModelControllerClientConfiguration.Builder	setShutdownExecutorOnClose(boolean shutdown) Sets whether the configuration's executor should be shut down when the Closeable.close() method is called.
ModelControllerClientConfiguration.Builder	setSslContext(SSLContext sslContext) Sets the SSL context for the remote connection

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setHostName

public ModelControllerClientConfiguration.Builder setHostName(String hostName)

Sets the remote host name to which the client should connect.

Parameters:

hostName - the host name. Cannot be null

Returns:

a builder to allow continued configuration

setClientBindAddress

public ModelControllerClientConfiguration.Builder setClientBindAddress(String clientBindAddress)

Sets the local address to which the client socket should be bound.

Parameters:

clientBindAddress - the local address, or null to choose one automatically

Returns:

a builder to allow continued configuration

setPort

public ModelControllerClientConfiguration.Builder setPort(int port)

Sets the remote port to which the client should connect

Parameters:

port - the port

Returns:

a builder to allow continued configuration

setHandler

public ModelControllerClientConfiguration.Builder setHandler(CallbackHandler handler)

Sets the handler for callbacks to obtain authentication information.

Parameters:

handler - the handler, or null if callbacks are not supported.

Returns:

a builder to allow continued configuration

setSaslOptions

public ModelControllerClientConfiguration.Builder setSaslOptions(Map<String,String> saslOptions)

Sets the SASL options for the remote connection

Parameters:

saslOptions - the sasl options

Returns:

a builder to allow continued configuration

setSslContext

public ModelControllerClientConfiguration.Builder setSslContext(SSLContext sslContext)

Sets the SSL context for the remote connection

Parameters:

sslContext - the SSL context

Returns:

a builder to allow continued configuration

setProtocol

public ModelControllerClientConfiguration.Builder setProtocol(String protocol)

Sets the protocol to use for communicating with the remote process.

Parameters:

protocol - the protocol, or null if a default protocol for the specified port should be used

Returns:

a builder to allow continued configuration

setConnectionTimeout

public ModelControllerClientConfiguration.Builder setConnectionTimeout(int connectionTimeout)

Maximum time, in milliseconds, to wait for the connection to be established

Parameters:

connectionTimeout - the timeout

Returns:

a builder to allow continued configuration

setExecutorService

public ModelControllerClientConfiguration.Builder setExecutorService(ExecutorService executorService)

Sets the executor service to use for asynchronous tasks. If not set a default executor will be used.

Parameters:

executorService - the executor. May be null

Returns:

a builder to allow continued configuration

setShutdownExecutorOnClose

public ModelControllerClientConfiguration.Builder setShutdownExecutorOnClose(boolean shutdown)

Sets whether the configuration's executor should be shut down when the Closeable.close() method is called. If not set the behavior depends on whether an executor was provided to setExecutorService(ExecutorService). If yes, then the executor will not be shut down; if no, then the default executor will be shut down.

Parameters:

shutdown - true if the executor should be shut down in the close method.

Returns:

a builder to allow continued configuration

build

public ModelControllerClientConfiguration build()

Builds the configuration object based on this builder's settings.

Returns:

the configuration