net.sf.ehcache.config
Class ManagementRESTServiceConfiguration

java.lang.Object
  net.sf.ehcache.config.ManagementRESTServiceConfiguration

public class ManagementRESTServiceConfiguration
extends Object

Configuration class of management REST services.

Author:

Ludovic Orban

Field Summary

static String	AUTO_LOCATION Synthetic security service location used when it should be auto-discovered.
static String	DEFAULT_BIND Default bind value.
static int	DEFAULT_SECURITY_SVC_TIMEOUT Default timeout for the connection to the configured security service
static String	NO_BIND Synthetic bind value used when no server must be bound.

Constructor Summary

ManagementRESTServiceConfiguration()

Method Summary

String	getBind() Get the host:port pair to which the REST server should be bound.
String	getHost() Get the host part of the host:port pair to which the REST server should be bound.
int	getPort() Get the port part of the host:port pair to which the REST server should be bound.
int	getSampleHistorySize() Returns the sample history size to be applied to the SampledCounterConfig for sampled statistics
int	getSampleIntervalSeconds() Returns the sample interval in seconds to be applied to the SampledCounterConfig for sampled statistics
int	getSampleSearchIntervalSeconds() Returns the sample search interval in seconds to be applied to the SampledRateCounterConfig for sampled statistics
String	getSecurityServiceLocation() Returns the security service location required for trusted identity assertion to the embedded REST management service.
int	getSecurityServiceTimeout() Returns the connection/read timeout value for the security service in milliseconds.
boolean	isEnabled() Check if the REST services should be enabled or not.
boolean	isNeedClientAuth() Indicates whether or not the embedded agent should require ssl client certificate authorization.
boolean	isSslEnabled() Indicates whether or not the embedded agent should enabled ssl.
SampledCounterConfig	makeSampledCounterConfig() A factory method for SampledCounterConfig based on the global settings defined on this object
SampledRateCounterConfig	makeSampledGetRateCounterConfig() A factory method for SampledCounterConfig based on the global settings defined on this object
SampledRateCounterConfig	makeSampledSearchRateCounterConfig() A factory method for SampledCounterConfig based on the global settings defined on this object
void	setBind(String bind) Set the host:port pair to which the REST server should be bound.
void	setEnabled(boolean enabled) Set that the REST services should be enabled or disabled.
void	setNeedClientAuth(boolean needClientAuth) Set ssl client certificate authorization required setting.
void	setSampleHistorySize(int sampleHistorySize) Sets the sample history size to be applied to the SampledCounterConfig for sampled statistics
void	setSampleIntervalSeconds(int sampleIntervalSeconds) Sets the sample interval in seconds to be applied to the SampledCounterConfig for sampled statistics
void	setSampleSearchIntervalSeconds(int sampleSearchInterval) Sets the sample search interval in seconds to be applied to the SampledCounterConfig for sampled statistics
void	setSecurityServiceLocation(String securityServiceURL) Sets the security service location required for trusted identity assertion to the embedded REST management service.
void	setSecurityServiceTimeout(int securityServiceTimeout) Sets the connection/read timeout value for the security service in milliseconds.
void	setSslEnabled(boolean sslEnabled) Set ssl indicator for this embedded agent.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BIND

public static final String DEFAULT_BIND

Default bind value.

See Also:

Constant Field Values

NO_BIND

public static final String NO_BIND

Synthetic bind value used when no server must be bound.

See Also:

Constant Field Values

AUTO_LOCATION

public static final String AUTO_LOCATION

Synthetic security service location used when it should be auto-discovered.

See Also:

Constant Field Values

DEFAULT_SECURITY_SVC_TIMEOUT

public static final int DEFAULT_SECURITY_SVC_TIMEOUT

Default timeout for the connection to the configured security service

See Also:

Constant Field Values

Constructor Detail

ManagementRESTServiceConfiguration

public ManagementRESTServiceConfiguration()

Method Detail

isEnabled

public boolean isEnabled()

Check if the REST services should be enabled or not.

Returns:

true if REST services should be enabled.

setEnabled

public void setEnabled(boolean enabled)

Set that the REST services should be enabled or disabled.

Parameters:

enabled - true if the REST services should be enabled.

getSecurityServiceLocation

public String getSecurityServiceLocation()

Returns the security service location required for trusted identity assertion to the embedded REST management service. This feature is only available with an enterprise license.

If this value is set, then this service will require secure dialog with the TMS or other 3rd party REST client implementations. The service furnished by the enterprise version of the TMC is located is provided at /api/assertIdentity.

Returns:

a string representing the URL of the security service.

setSecurityServiceLocation

public void setSecurityServiceLocation(String securityServiceURL)

Sets the security service location required for trusted identity assertion to the embedded REST management service. This feature is only available with an enterprise license.

If this value is set, then this service will require secure dialog with the TMS or other 3rd party REST client implementations. The service furnished by the enterprise version of the TMC is located is provided at /api/assertIdentity.

Parameters:

securityServiceURL - a string representing the URL of the security service.

getSecurityServiceTimeout

public int getSecurityServiceTimeout()

Returns the connection/read timeout value for the security service in milliseconds.

Returns:

security service timeout

setSecurityServiceTimeout

public void setSecurityServiceTimeout(int securityServiceTimeout)

Sets the connection/read timeout value for the security service in milliseconds.

Parameters:

securityServiceTimeout - milliseconds to timeout

getBind

public String getBind()

Get the host:port pair to which the REST server should be bound. Format is: [IP address|host name]:[port number]

Returns:

the host:port pair to which the REST server should be bound.

getHost

public String getHost()

Get the host part of the host:port pair to which the REST server should be bound.

Returns:

the host part of the host:port pair to which the REST server should be bound.

getPort

public int getPort()

Get the port part of the host:port pair to which the REST server should be bound.

Returns:

the port part of the host:port pair to which the REST server should be bound.

isSslEnabled

public boolean isSslEnabled()

Indicates whether or not the embedded agent should enabled ssl.

Returns:

true if ssl should be enabled, false if not.

setSslEnabled

public void setSslEnabled(boolean sslEnabled)

Set ssl indicator for this embedded agent.

Parameters:

sslEnabled - boolean to indicate ssl status.

isNeedClientAuth

public boolean isNeedClientAuth()

Indicates whether or not the embedded agent should require ssl client certificate authorization. This configuration setting is only relevant if ssl is enabled.

Returns:

true if ssl client certificate authorization should be required, false if not.

See Also:

isSslEnabled()

setNeedClientAuth

public void setNeedClientAuth(boolean needClientAuth)

Set ssl client certificate authorization required setting. This configuration setting is only relevant if ssl is enabled.

Parameters:

needClientAuth -

See Also:

setSslEnabled(boolean)

setBind

public void setBind(String bind)

Set the host:port pair to which the REST server should be bound.

Parameters:

bind - host:port pair to which the REST server should be bound.

getSampleHistorySize

public int getSampleHistorySize()

Returns the sample history size to be applied to the SampledCounterConfig for sampled statistics

Returns:

the sample history size

setSampleHistorySize

public void setSampleHistorySize(int sampleHistorySize)

Sets the sample history size to be applied to the SampledCounterConfig for sampled statistics

Parameters:

sampleHistorySize - to set

getSampleIntervalSeconds

public int getSampleIntervalSeconds()

Returns the sample interval in seconds to be applied to the SampledCounterConfig for sampled statistics

Returns:

the sample interval in seconds

setSampleIntervalSeconds

public void setSampleIntervalSeconds(int sampleIntervalSeconds)

Sets the sample interval in seconds to be applied to the SampledCounterConfig for sampled statistics

Parameters:

sampleIntervalSeconds - to set

getSampleSearchIntervalSeconds

public int getSampleSearchIntervalSeconds()

Returns the sample search interval in seconds to be applied to the SampledRateCounterConfig for sampled statistics

Returns:

the sample search interval in seconds

setSampleSearchIntervalSeconds

public void setSampleSearchIntervalSeconds(int sampleSearchInterval)

Sets the sample search interval in seconds to be applied to the SampledCounterConfig for sampled statistics

Parameters:

sampleSearchInterval - to set

makeSampledCounterConfig

public SampledCounterConfig makeSampledCounterConfig()

A factory method for SampledCounterConfig based on the global settings defined on this object

Returns:

a SampledCounterConfig

See Also:

getSampleIntervalSeconds(), getSampleHistorySize()

makeSampledGetRateCounterConfig

public SampledRateCounterConfig makeSampledGetRateCounterConfig()

A factory method for SampledCounterConfig based on the global settings defined on this object

Returns:

a SampledCounterConfig

See Also:

getSampleIntervalSeconds(), getSampleHistorySize()

makeSampledSearchRateCounterConfig

public SampledRateCounterConfig makeSampledSearchRateCounterConfig()

A factory method for SampledCounterConfig based on the global settings defined on this object

Returns:

a SampledCounterConfig

See Also:

getSampleSearchIntervalSeconds(), getSampleHistorySize()

toString

public String toString()

Overrides:

toString in class Object