public class ManagementRESTServiceConfiguration extends Object
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
ManagementRESTServiceConfiguration() |
Modifier and Type | Method and Description |
---|---|
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() |
public static final String DEFAULT_BIND
public static final String NO_BIND
public static final String AUTO_LOCATION
public static final int DEFAULT_SECURITY_SVC_TIMEOUT
public boolean isEnabled()
public void setEnabled(boolean enabled)
enabled
- true if the REST services should be enabled.public String getSecurityServiceLocation()
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.
public void setSecurityServiceLocation(String securityServiceURL)
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.
securityServiceURL
- a string representing the URL of the security service.public int getSecurityServiceTimeout()
public void setSecurityServiceTimeout(int securityServiceTimeout)
securityServiceTimeout
- milliseconds to timeoutpublic String getBind()
public 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(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()
Copyright 2001-2020, Terracotta, Inc.