public class ManagementRESTServiceConfiguration
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
bind |
static java.lang.String |
DEFAULT_BIND
Default bind value.
|
static int |
DEFAULT_REST_SAMPLE_HISTORY_SIZE
Default REST statistic sample history size
|
static int |
DEFAULT_REST_SAMPLE_INTERVAL
Default REST statistic sample interval
|
static int |
DEFAULT_SECURITY_SVC_TIMEOUT
Default timeout for the connection to the configured security service
|
private boolean |
enabled |
private boolean |
needClientAuth |
private int |
sampleHistorySize |
private int |
sampleIntervalSeconds |
private int |
sampleSearchIntervalSeconds |
private java.lang.String |
securityServiceLocation |
private int |
securityServiceTimeout |
private boolean |
sslEnabled |
Constructor and Description |
---|
ManagementRESTServiceConfiguration() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBind()
Get the host:port pair to which the REST server should be bound.
|
java.lang.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 |
java.lang.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(java.lang.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(java.lang.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.
|
java.lang.String |
toString() |
public static final java.lang.String DEFAULT_BIND
public static final int DEFAULT_SECURITY_SVC_TIMEOUT
public static final int DEFAULT_REST_SAMPLE_HISTORY_SIZE
public static final int DEFAULT_REST_SAMPLE_INTERVAL
private volatile boolean enabled
private volatile java.lang.String securityServiceLocation
private volatile boolean sslEnabled
private volatile boolean needClientAuth
private volatile int securityServiceTimeout
private volatile java.lang.String bind
private volatile int sampleHistorySize
private volatile int sampleIntervalSeconds
private volatile int sampleSearchIntervalSeconds
public boolean isEnabled()
public void setEnabled(boolean enabled)
enabled
- true if the REST services should be enabled.public java.lang.String getSecurityServiceLocation()
public void setSecurityServiceLocation(java.lang.String securityServiceURL)
securityServiceURL
- a string representing the URL of the security service.public int getSecurityServiceTimeout()
public void setSecurityServiceTimeout(int securityServiceTimeout)
securityServiceTimeout
- milliseconds to timeoutpublic java.lang.String getBind()
public java.lang.String getHost()
public int getPort()
public boolean isSslEnabled()
public void setSslEnabled(boolean sslEnabled)
sslEnabled
- boolean to indicate ssl status.public boolean isNeedClientAuth()
isSslEnabled()
public void setNeedClientAuth(boolean needClientAuth)
needClientAuth
- setSslEnabled(boolean)
public void setBind(java.lang.String bind)
bind
- host:port pair to which the REST server should be bound.public int getSampleHistorySize()
SampledCounterConfig
for sampled statisticspublic void setSampleHistorySize(int sampleHistorySize)
SampledCounterConfig
for sampled statisticssampleHistorySize
- to setpublic int getSampleIntervalSeconds()
SampledCounterConfig
for sampled statisticspublic void setSampleIntervalSeconds(int sampleIntervalSeconds)
SampledCounterConfig
for sampled statisticssampleIntervalSeconds
- to setpublic int getSampleSearchIntervalSeconds()
SampledRateCounterConfig
for sampled statisticspublic void setSampleSearchIntervalSeconds(int sampleSearchInterval)
SampledCounterConfig
for sampled statisticssampleSearchInterval
- to setpublic SampledCounterConfig makeSampledCounterConfig()
SampledCounterConfig
based on the global settings defined on this objectSampledCounterConfig
getSampleIntervalSeconds()
,
getSampleHistorySize()
public SampledRateCounterConfig makeSampledGetRateCounterConfig()
SampledCounterConfig
based on the global settings defined on this objectSampledCounterConfig
getSampleIntervalSeconds()
,
getSampleHistorySize()
public SampledRateCounterConfig makeSampledSearchRateCounterConfig()
SampledCounterConfig
based on the global settings defined on this objectSampledCounterConfig
getSampleSearchIntervalSeconds()
,
getSampleHistorySize()
public java.lang.String toString()
toString
in class java.lang.Object