Top Description Fields Constructors Methods
net.sf.ehcache.config

public Class ManagementRESTServiceConfiguration

extends Object
Class Inheritance
Imports
net.sf.ehcache.statistics.StatisticsGateway, net.sf.ehcache.util.counter.sampled.SampledCounterConfig, .SampledRateCounterConfig
Configuration class of management REST services.
Author
Ludovic Orban

Field Summary

Modifier and TypeField and Description
public static final String
AUTO_LOCATION

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

private volatile String
bind

public static final String
DEFAULT_BIND

Default bind value.

public static final int
DEFAULT_SECURITY_SVC_TIMEOUT

Default timeout for the connection to the configured security service

private volatile boolean
enabled

private volatile boolean
needClientAuth

public static final String
NO_BIND

Synthetic bind value used when no server must be bound.

private volatile int
sampleHistorySize

private volatile int
sampleIntervalSeconds

private volatile int
sampleSearchIntervalSeconds

private volatile String
securityServiceLocation

private volatile int
securityServiceTimeout

private volatile boolean
sslEnabled

Constructor Summary

AccessConstructor and Description
public
ManagementRESTServiceConfiguration()

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

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

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

public String

Returns:

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

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

public int

Returns:

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

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

public int

Returns:

the sample history size
getSampleHistorySize()

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

public int

Returns:

the sample interval in seconds
getSampleIntervalSeconds()

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

public int

Returns:

the sample search interval in seconds
getSampleSearchIntervalSeconds()

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

public String

Returns:

a string representing the URL of the security service.
getSecurityServiceLocation()

Returns the security service location required for trusted identity assertion to the embedded REST management service.

public int

Returns:

security service timeout
getSecurityServiceTimeout()

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

public boolean

Returns:

true if REST services should be enabled.
isEnabled()

Check if the REST services should be enabled or not.

public boolean

Returns:

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

Indicates whether or not the embedded agent should require ssl client certificate authorization.

public boolean

Returns:

true if ssl should be enabled, false if not.
isSslEnabled()

Indicates whether or not the embedded agent should enabled ssl.

public SampledCounterConfig

Returns:

a SampledCounterConfig
makeSampledCounterConfig()

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

public SampledRateCounterConfig

Returns:

a SampledCounterConfig
makeSampledGetRateCounterConfig()

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

public SampledRateCounterConfig

Returns:

a SampledCounterConfig
makeSampledSearchRateCounterConfig()

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

public void
setBind(String
host:port pair to which the REST server should be bound.
bind)

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

public void
setEnabled(boolean
true if the REST services should be enabled.
enabled)

Set that the REST services should be enabled or disabled.

public void
setNeedClientAuth(boolean needClientAuth)

Set ssl client certificate authorization required setting.

public void
setSampleHistorySize(final int
to set
sampleHistorySize)

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

public void
setSampleIntervalSeconds(final int
to set
sampleIntervalSeconds)

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

public void
setSampleSearchIntervalSeconds(final int
to set
sampleSearchInterval)

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

public void
setSecurityServiceLocation(String
a string representing the URL of the security service.
securityServiceURL)

Sets the security service location required for trusted identity assertion to the embedded REST management service.

public void
setSecurityServiceTimeout(int
milliseconds to timeout
securityServiceTimeout)

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

public void
setSslEnabled(boolean
boolean to indicate ssl status.
sslEnabled)

Set ssl indicator for this embedded agent.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

AUTO_LOCATIONback to summary
public static final String AUTO_LOCATION

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

bindback to summary
private volatile String bind
DEFAULT_BINDback to summary
public static final String DEFAULT_BIND

Default bind value.

DEFAULT_SECURITY_SVC_TIMEOUTback to summary
public static final int DEFAULT_SECURITY_SVC_TIMEOUT

Default timeout for the connection to the configured security service

enabledback to summary
private volatile boolean enabled
needClientAuthback to summary
private volatile boolean needClientAuth
NO_BINDback to summary
public static final String NO_BIND

Synthetic bind value used when no server must be bound.

sampleHistorySizeback to summary
private volatile int sampleHistorySize
sampleIntervalSecondsback to summary
private volatile int sampleIntervalSeconds
sampleSearchIntervalSecondsback to summary
private volatile int sampleSearchIntervalSeconds
securityServiceLocationback to summary
private volatile String securityServiceLocation
securityServiceTimeoutback to summary
private volatile int securityServiceTimeout
sslEnabledback to summary
private volatile boolean sslEnabled

Constructor Detail

ManagementRESTServiceConfigurationback to summary
public ManagementRESTServiceConfiguration()

Method Detail

getBindback to summary
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:String

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

getHostback to summary
public String getHost()

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

Returns:String

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

getPortback to summary
public int getPort()

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

Returns:int

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

getSampleHistorySizeback to summary
public int getSampleHistorySize()

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

Returns:int

the sample history size

getSampleIntervalSecondsback to summary
public int getSampleIntervalSeconds()

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

Returns:int

the sample interval in seconds

getSampleSearchIntervalSecondsback to summary
public int getSampleSearchIntervalSeconds()

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

Returns:int

the sample search interval in seconds

getSecurityServiceLocationback to summary
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:String

a string representing the URL of the security service.

getSecurityServiceTimeoutback to summary
public int getSecurityServiceTimeout()

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

Returns:int

security service timeout

isEnabledback to summary
public boolean isEnabled()

Check if the REST services should be enabled or not.

Returns:boolean

true if REST services should be enabled.

isNeedClientAuthback to summary
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:boolean

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

See Also
isSslEnabled()
isSslEnabledback to summary
public boolean isSslEnabled()

Indicates whether or not the embedded agent should enabled ssl.

Returns:boolean

true if ssl should be enabled, false if not.

makeSampledCounterConfigback to summary
public SampledCounterConfig makeSampledCounterConfig()

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

Returns:SampledCounterConfig

a SampledCounterConfig

See Also
getSampleIntervalSeconds(), getSampleHistorySize()
makeSampledGetRateCounterConfigback to summary
public SampledRateCounterConfig makeSampledGetRateCounterConfig()

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

Returns:SampledRateCounterConfig

a SampledCounterConfig

See Also
getSampleIntervalSeconds(), getSampleHistorySize()
makeSampledSearchRateCounterConfigback to summary
public SampledRateCounterConfig makeSampledSearchRateCounterConfig()

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

Returns:SampledRateCounterConfig

a SampledCounterConfig

See Also
getSampleSearchIntervalSeconds(), getSampleHistorySize()
setBindback to summary
public void setBind(String bind)

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

Parameters
bind:String

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

setEnabledback to summary
public void setEnabled(boolean enabled)

Set that the REST services should be enabled or disabled.

Parameters
enabled:boolean

true if the REST services should be enabled.

setNeedClientAuthback to summary
public void setNeedClientAuth(boolean needClientAuth)

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

See Also
setSslEnabled(boolean)
setSampleHistorySizeback to summary
public void setSampleHistorySize(final int sampleHistorySize)

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

Parameters
sampleHistorySize:int

to set

setSampleIntervalSecondsback to summary
public void setSampleIntervalSeconds(final int sampleIntervalSeconds)

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

Parameters
sampleIntervalSeconds:int

to set

setSampleSearchIntervalSecondsback to summary
public void setSampleSearchIntervalSeconds(final int sampleSearchInterval)

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

Parameters
sampleSearchInterval:int

to set

setSecurityServiceLocationback to summary
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:String

a string representing the URL of the security service.

setSecurityServiceTimeoutback to summary
public void setSecurityServiceTimeout(int securityServiceTimeout)

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

Parameters
securityServiceTimeout:int

milliseconds to timeout

setSslEnabledback to summary
public void setSslEnabled(boolean sslEnabled)

Set ssl indicator for this embedded agent.

Parameters
sslEnabled:boolean

boolean to indicate ssl status.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override