org.jolokia.jvmagent

Class JolokiaServerConfig

java.lang.Object

org.jolokia.jvmagent.JolokiaServerConfig

Direct Known Subclasses:

JvmAgentConfig

public class JolokiaServerConfig
extends Object

Configuration required for the JolokiaServer

Since:

28.12.12

Author:

roland

Constructor Summary

Constructors

Constructor and Description
JolokiaServerConfig(Map<String,String> pConfig) Constructor which prepares the server configuration from a map of given config options (key: option name, value: option value).

Method Summary

Methods

Modifier and Type	Method and Description
InetAddress	getAddress() Address to bind to, which is either used from the configuration option "host" or by default from InetAddress.getLocalHost()
com.sun.net.httpserver.Authenticator	getAuthenticator() Return a basic authenticator if user or password is given in the configuration.
int	getBacklog() Backlog of the HTTP server, which is the number of requests to keep before throwing them away
String	getContextPath() Context path under which the agent is reachable.
protected Map<String,String>	getDefaultConfig(Map<String,String> pConfig)
String	getExecutor() Executor to use as provided by the 'executor' option or "single" as default
Configuration	getJolokiaConfig() Get the Jolokia runtime configuration
String	getKeystore() Name of the keystore for 'https', if any
char[]	getKeystorePassword() Password for keystore if a keystore is used.
int	getPort() Port for the server to listen to
String	getProtocol() Protocol to use
int	getThreadNr() Thread number to use when executor model is "fixed"
protected void	init(Map<String,String> pConfig) Initialize the configuration with the given map
protected void	initConfigAndValidate(Map<String,String> agentConfig)
protected void	prepareDetectorOptions(Map<String,String> pConfig)
protected Map<String,String>	readPropertiesFromInputStream(InputStream pIs, String pLabel)
boolean	useSslClientAuthentication() When the protocol is 'https' then this property indicates whether SSL client certificate authentication should be used or not

Methods inherited from class java.lang.Object

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

Constructor Detail

JolokiaServerConfig

public JolokiaServerConfig(Map<String,String> pConfig)

Constructor which prepares the server configuration from a map of given config options (key: option name, value: option value). Also, default values are used for any parameter not provided (getDefaultConfig(Map)). The given configuration consist of two parts: Any global options as defined in ConfigKey are used for setting up the agent. All other options are taken for preparing the HTTP server under which the agent is served. The known properties are described in the reference manual. All other options are ignored.

Parameters:

pConfig - the configuration options to use.

Method Detail

init

protected void init(Map<String,String> pConfig)

Initialize the configuration with the given map

Parameters:

pConfig - map holding the configuration in string representation. A reference to the map will be kept

getDefaultConfig

protected Map<String,String> getDefaultConfig(Map<String,String> pConfig)

getJolokiaConfig

public Configuration getJolokiaConfig()

Get the Jolokia runtime configuration

Returns:

jolokia configuration

getProtocol

public String getProtocol()

Protocol to use

Returns:

protocol either 'http' or 'https'

getAddress

public InetAddress getAddress()

Address to bind to, which is either used from the configuration option "host" or by default from InetAddress.getLocalHost()

Returns:

the host's address

getPort

public int getPort()

Port for the server to listen to

Returns:

port

getAuthenticator

public com.sun.net.httpserver.Authenticator getAuthenticator()

Return a basic authenticator if user or password is given in the configuration. You can override this method if you want to provide an own authenticator.

Returns:

an authenticator if authentication is switched on, or null if no authentication should be used.

getBacklog

public int getBacklog()

Backlog of the HTTP server, which is the number of requests to keep before throwing them away

Returns:

backlog

getContextPath

public String getContextPath()

Context path under which the agent is reachable. This path will always end with a "/" for technical reasons.

Returns:

the context path.

getExecutor

public String getExecutor()

Executor to use as provided by the 'executor' option or "single" as default

Returns:

the executor model ("fixed", "single" or "cached")

getThreadNr

public int getThreadNr()

Thread number to use when executor model is "fixed"

Returns:

number of fixed threads

useSslClientAuthentication

public boolean useSslClientAuthentication()

When the protocol is 'https' then this property indicates whether SSL client certificate authentication should be used or not

Returns:

true when ssl client authentication should be used

getKeystore

public String getKeystore()

Name of the keystore for 'https', if any

Returns:

name of keystore.

getKeystorePassword

public char[] getKeystorePassword()

Password for keystore if a keystore is used. If not given, no password is assumed.

Returns:

the keystore password as char array or an empty array of no password is given

initConfigAndValidate

protected void initConfigAndValidate(Map<String,String> agentConfig)

readPropertiesFromInputStream

protected Map<String,String> readPropertiesFromInputStream(InputStream pIs,
                                               String pLabel)

prepareDetectorOptions

protected void prepareDetectorOptions(Map<String,String> pConfig)