|
IBM WebSphereTM eXtreme Scale, Release 8.6 API Specification |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CatalogServerProperties
Defines a set of properties to be used at initialization by the ObjectGrid server runtime. This property object is used to determine if this process will act as a catalog service and if so the properties of the catalog service.
Field Summary | |
---|---|
static String |
DEFAULT_DOMAIN
The default name for a catalog service domain. |
static int |
HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE
Constant representing a heartbeat level at an aggressive rate. |
static int |
HEARTBEAT_FREQUENCY_LEVEL_RELAXED
Constant representing a heartbeat level at relaxed rate. |
static int |
HEARTBEAT_FREQUENCY_LEVEL_TYPICAL
Constant representing a heartbeat level at a typical rate. |
static String |
ORB_TRANSPORT
The Object Request Broker or ORB transport |
static long |
PLACEMENT_DEFERRAL_INTERVAL_DEFAULT
Constant representing the default interval for deferral of balancing and placement of work items to the containers |
static String |
PROP_CATALOG_CLUSTER_END_POINTS
The format of the string should be "serverName:hostName:clientPort:peerPort<,serverName:hostName:clientPort:peerPort>". |
static String |
PROP_CATALOG_SERVER
A boolean to indicate whether the server should start a catalog service. |
static String |
PROP_DOMAIN_NAME
Defines the domain name used to uniquely identify this catalog service grid to clients when routing to multiple domains. |
static String |
PROP_ENABLE_MANAGEMENT_CONCENTRATOR
Determines whether or not the initialization of the MBeanServer notifications concentrator |
static String |
PROP_ENABLE_QUORUM
Determines whether or not quorum is enabled. |
static String |
PROP_FOREIGN_DOMAINS
A bidirectional connection will be established to each of the foreign domains for the purpose of exchanging data in a multi-primary scenario. |
static String |
PROP_HEARTBEAT_FREQUENCY_LEVEL
Sets the heartbeat frequency level. |
static String |
PROP_JMX_SERVICE_PORT
Deprecated. Deprecated in version 7.1. Use ServerProperties.PROP_JMX_SERVICE_PORT instead |
static String |
PROP_PLACEMENT_DEFERRAL_INTERVAL
Determines the placement deferral interval. |
static String |
PROP_SUFFIX_DOMAIN_ENDPOINTS
Use this string as a suffix when reading and writing domain end points properties. |
static String |
PROP_TRANSPORT
Determines the transport on the catalog service domain for server to server communication |
static String |
XIO_TRANSPORT
The eXtremeIO or XIO transport |
Method Summary | |
---|---|
String |
getCatalogClusterEndpoints()
Retrieves the list of catalog service endpoints. |
URL |
getClusterSecurityURL()
Retrieves the cluster security file location. |
String |
getDomainEndPoints(String domain)
Retrieves the end points for the specified domain |
String |
getDomainName()
Retrieves the name of the domain that this catalog service defines. |
String |
getForeignDomains()
Get the current foreign domains. |
int |
getHeartBeatFrequencyLevel()
Retrieves the heartbeat frequency level. |
long |
getPlacementDeferralInterval()
Gets the placement deferral interval. |
boolean |
getQuorum()
Returns whether or not this catalog service is enforcing quorum. |
String |
getServerSecurityFileName()
Retrieves the server security file name. |
String |
getTransport()
Returns the transport for the catalog service domain |
boolean |
isCatalogServer()
Returns whether this process is defined as a catalog service or not. |
boolean |
isManagementConcentrator()
Returns whether or not this catalog service is initialising the MBean notifications concentrator. |
void |
load(InputStream input)
Loads the properties from input into this property object. |
void |
setCatalogClusterEndpoints(String clusterEndpoints)
Sets the endpoint for each of the catalog service grid members. |
void |
setCatalogServer(boolean isCatalog)
Defines this process as a catalog service if isCatalog is true. |
void |
setClusterSecurityURL(URL clusterSecurity)
Sets the location of the security file specific to the catalog service. |
void |
setDomainEndPoints(String domain,
String endPoints)
Set end points for catalog servers in a foreign domain. |
void |
setDomainName(String domainName)
Assigns the name of the ObjectGrid domain that this catalog service manages. |
void |
setForeignDomains(String foreignDomains)
Set the foreign domains that this domain will communicate with to establish a multi-primary topology. |
void |
setHeartBeatFrequencyLevel(int frequencyLevel)
Sets the heartbeat frequency level. |
void |
setManagementConcentrator(boolean enabled)
Defines the behavior of this catalog service to enable the MBean notifications concentrator. |
void |
setPlacementDeferralInterval(long placementDeferralInterval)
Sets the placement deferral interval. |
void |
setQuorum(boolean quorum)
Defines the behavior of this catalog service to enable quorum. |
void |
setServerSecurityFileName(String serverSecurity)
Sets the server security file name. |
void |
setTransport(String transport)
Sets the transport for the catalog service domain |
void |
store(OutputStream output)
Writes the properties from this object into output . |
Field Detail |
---|
static final String DEFAULT_DOMAIN
setDomainName(String)
,
Constant Field Valuesstatic final String PROP_DOMAIN_NAME
setDomainName(String)
,
Constant Field Valuesstatic final String PROP_ENABLE_QUORUM
setQuorum(boolean)
,
Constant Field Valuesstatic final String PROP_ENABLE_MANAGEMENT_CONCENTRATOR
setManagementConcentrator(boolean)
,
Constant Field Valuesstatic final String PROP_FOREIGN_DOMAINS
See the PROP_SUFFIX_DOMAIN_ENDPOINTS
property for an
example on how to set the end points for each foreign domain.
static final String PROP_SUFFIX_DOMAIN_ENDPOINTS
<domainName>.endPoints=<host>:<port>,<host>:<port>
Example:
domainName=NewYork foreignDomains=London,Tokyo London.endPoints=datagridcat1.london.acme.com:2809,datagridcat2.london.acme.com:2809 Tokyo.endPoints=datagridcat1.tokyo.acme.com:2809,datagridcat2.tokyo.acme.com:2809
static final String PROP_JMX_SERVICE_PORT
ServerProperties.PROP_JMX_SERVICE_PORT
instead
ServerProperties.PROP_JMX_SERVICE_PORT
,
Constant Field Valuesstatic final String PROP_CATALOG_CLUSTER_END_POINTS
static final String PROP_HEARTBEAT_FREQUENCY_LEVEL
setHeartBeatFrequencyLevel(int)
,
Constant Field Valuesstatic final String PROP_CATALOG_SERVER
setCatalogServer(boolean)
,
Constant Field Valuesstatic final int HEARTBEAT_FREQUENCY_LEVEL_TYPICAL
A typical heartbeat frequency allows reasonable failover detection and resource utilization. This value is the default.
static final int HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE
An increased heartbeat frequency allows failures to be detected more quickly, but can also uses additional CPU and network resources. This level is more sensitive to missing heartbeats when the server is stressed.
static final int HEARTBEAT_FREQUENCY_LEVEL_RELAXED
A decreased heartbeat frequency increases the time to detect failures, but also decreases CPU and network utilization.
static final long PLACEMENT_DEFERRAL_INTERVAL_DEFAULT
An increase in the deferral interval will lower CPU utilization, but the placement of work items will be completed over time. A decrease in the deferral interval will increase short term CPU utilization, but the placement of work items will be more immediate and expedited. The value is in milliseconds.
setPlacementDeferralInterval(long)
,
PROP_PLACEMENT_DEFERRAL_INTERVAL
,
Constant Field Valuesstatic final String PROP_PLACEMENT_DEFERRAL_INTERVAL
setPlacementDeferralInterval(long)
,
Constant Field Valuesstatic final String PROP_TRANSPORT
XIO_TRANSPORT
,
ORB_TRANSPORT
,
Constant Field Valuesstatic final String ORB_TRANSPORT
PROP_TRANSPORT
,
setTransport(String)
,
getTransport()
static final String XIO_TRANSPORT
PROP_TRANSPORT
,
setTransport(String)
,
getTransport()
Method Detail |
---|
void setCatalogServer(boolean isCatalog)
isCatalog
is true. The default value is
false
.
isCatalog
- Defines this process as a catalog service if true.boolean isCatalogServer()
void setDomainName(String domainName)
domainName
- A unique name for this catalog service.DEFAULT_DOMAIN
String getDomainName()
void setCatalogClusterEndpoints(String clusterEndpoints)
clusterEndpoints
- The endpoints string containing all of the catalog services.String getCatalogClusterEndpoints()
void setHeartBeatFrequencyLevel(int frequencyLevel)
Valid values include:
HEARTBEAT_FREQUENCY_LEVEL_TYPICAL
(default)
HEARTBEAT_FREQUENCY_LEVEL_RELAXED
HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE
frequencyLevel
- one of three values: -1, 0 or 1 as defined by the
constants that begin with name HEARTBEAT_FREQUENCY_LEVEL.
IllegalArgumentException
- if the frequencyLevel is out of range.int getHeartBeatFrequencyLevel()
Valid values include:
HEARTBEAT_FREQUENCY_LEVEL_TYPICAL
HEARTBEAT_FREQUENCY_LEVEL_RELAXED
HEARTBEAT_FREQUENCY_LEVEL_AGGRESSIVE
void setClusterSecurityURL(URL clusterSecurity)
clusterSecurity
- The cluster security file location.URL getClusterSecurityURL()
void setServerSecurityFileName(String serverSecurity)
serverSecurity
- Retrieves the server security file name.String getServerSecurityFileName()
void setQuorum(boolean quorum)
By default, the quorum is disabled.
quorum
- Whether this catalog service should enforce quorum or not.boolean getQuorum()
void setManagementConcentrator(boolean enabled)
By default, the Management Concentrator is enabled.
enabled
- Whether this catalog service initialises the notification concentrator or not.boolean isManagementConcentrator()
void setForeignDomains(String foreignDomains)
Provide domain names in a comma separated list.
foreignDomains
- A comma separated list of foreign domain names.String getForeignDomains()
void setDomainEndPoints(String domain, String endPoints)
Domain end points are specified in the following format:
<domainName>.endPoints=<host>:<port>,<host>:<port>
domain
- The domain name to set the end points for.endPoints
- A comma separated list of host:port values.String getDomainEndPoints(String domain)
domain
- The domain name in which to retrieve the end points.void load(InputStream input) throws IOException
input
into this property object.
input
- A stream to load properties from.
IOException
- If the properties input has an invalid format.void store(OutputStream output) throws IOException
output
.
output
- A stream to write out the properties to.
IOException
- If the properties input has an invalid format.void setPlacementDeferralInterval(long placementDeferralInterval)
placementDeferralInterval
- is the interval in milliseconds for the deferral of balancing
and placement of work items to the containers. If the interval is -1 the default
interval will be used.long getPlacementDeferralInterval()
void setTransport(String transport)
XIO_TRANSPORT
,
ORB_TRANSPORT
String getTransport()
XIO_TRANSPORT
,
ORB_TRANSPORT
|
IBM WebSphereTM eXtreme Scale, Release 8.6 API Specification |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |