public interface FabricExchange
Title: Service Event Fabric Core
Description: Interface for access to Fabric Exchange configuration parameters.
Copyright: Copyright (c) 2012
Company: StreamScape Technologies
Modifier and Type | Method and Description |
---|---|
boolean |
anonymousRegistration()
Checks if the sysplex enables an anonymous registration of new users.
|
java.lang.String |
getAdvancedParameter(java.lang.String name)
Returns the value of the advanced parameter with the specified name.
|
UserState |
getAnonymousUser()
Returns an initial state of users created by an anonymous registration
(i.e.
|
long |
getBlockedThreadAdvisoryThreshold()
Returns a time (in seconds) for a blocked thread after which the special advisory
(
BlockedThreadAdvisory ) will be raised. |
java.util.Map |
getClientThresholds()
Returns a list of thresholds for the number of external (remote) clients currently connected to the node.
|
int |
getScavengerReconnectAttempts()
Returns a number of reconnect attempts which will be made by the Scavenger thread.
|
long |
getScavengerReconnectInterval()
Returns a time (in seconds) between successive reconnect attempts which will be made by the Scavenger thread.
|
int |
getSystemWorkerPoolSize()
Returns a size of the internal thread pool (number of thread in the pool).
|
ThreadPoolType |
getSystemWorkerPoolType()
Returns a type of the internal thread pool.
|
long |
getThreadMonitorInterval()
Returns a time (in seconds) between successive repeats in the monitor which observes a state of the
JVM threads. |
java.util.List |
getTopology()
Returns the whole set of topology links that presents the current topology of the sysplex.
|
int |
getWorkerPoolSize()
Returns a size of the main thread pool (number of threads in the pool).
|
int |
getWorkerPoolSizeThreshold()
This parameter is not supported for now.
|
ThreadPoolType |
getWorkerPoolType()
Returns a type of the main thread pool.
|
int |
getWorkerQueueSizeThreshold()
This parameter is not supported for now.
|
java.util.List |
listAdvancedParameters()
Returns a list of names of the advanced parameters.
|
long |
nextGlobalCount()
Increments the
Global Counter and returns its new value. |
long |
resetGlobalCounter()
Resets the
Global Counter , setting its value to 1 . |
void |
setAdvancedParameter(java.lang.String name,
java.lang.String value)
Sets the specified value to the advanced parameter with the specified name.
|
void |
setAnonymousRegistration(boolean anonymousRegistration)
Sets a parameter specifying if the sysplex enables an anonymous registration of new users.
|
void |
setAnonymousUser(UserState state)
Sets an initial state of users created by an anonymous registration
(i.e.
|
void |
setBlockedThreadAdvisoryThreshold(long advisoryThreshold)
Sets a time (in seconds) for a blocked thread after which the special advisory
(
BlockedThreadAdvisory ) will be raised. |
void |
setClientThresholds(java.util.Map thresholds)
Sets a list of thresholds for the number of external (remote) clients currently connected to the node.
|
void |
setScavengerReconnectAttempts(int reconnectAttempts)
Sets a number of reconnect attempts which will be made by the Scavenger thread.
|
void |
setScavengerReconnectInterval(long reconnectInterval)
Sets a time (in seconds) between successive reconnect attempts which will be made by the Scavenger thread.
|
void |
setSystemWorkerPoolSize(int poolSize)
Sets a size of the internal thread pool (number of thread in the pool).
|
void |
setSystemWorkerPoolType(ThreadPoolType poolType)
Sets a type of the internal thread pool.
|
void |
setThreadMonitorInterval(long monitorInterval)
Sets a time (in seconds) between successive repeats in the monitor which observes a state of the
JVM threads. |
void |
setWorkerPoolSize(int poolSize)
Sets a size of the main thread pool (number of threads in the pool).
|
void |
setWorkerPoolType(ThreadPoolType poolType)
Sets a type of the main thread pool.
|
long |
showGlobalCounter()
Returns the current value of the
Global Counter . |
static final java.lang.String WORKER_POOL_SIZE
static final java.lang.String WORKER_POOL_TYPE
static final java.lang.String WORKER_POOL_SIZE_THRESHOLD
static final java.lang.String WORKER_QUEUE_SIZE_THRESHOLD
static final java.lang.String SYSTEM_WORKER_POOL_SIZE
static final java.lang.String SYSTEM_WORKER_POOL_TYPE
static final java.lang.String SCAVENGER_RECONNECT_ATTEMPTS
static final java.lang.String SCAVENGER_RECONNECT_INTERVAL
static final java.lang.String ANONYMOUS_REGISTRATION
static final java.lang.String ANONYMOUS_USER
static final java.lang.String THREAD_MONITOR_INTERVAL
static final java.lang.String BLOCKED_THREAD_ADVISORY_THRESHOLD
static final java.lang.String CONNECTION_TIMEOUT
static final java.lang.String REPLY_TIMEOUT
static final java.lang.String FAST_REPLY_TIMEOUT
static final java.lang.String LONG_REPLY_TIMEOUT
static final java.lang.String BROADCAST_REPLY_TIMEOUT
static final java.lang.String TOKEN_DELAY
static final java.lang.String TOKEN_MONITOR_INTERVAL
static final java.lang.String FAST_FAIL_TIMEOUT
static final java.lang.String ACCESSOR_MONITOR_INTERVAL
static final java.lang.String ACCESSOR_POOL_SIZE
static final java.lang.String ACCESSOR_POOL_EXPIRATION_TIMEOUT
static final java.lang.String NODE_WEIGHT
static final java.lang.String WEB_APP_TOKEN_AUTHENTICATION
static final java.lang.String CLIENT_THRESHOLDS
static final java.lang.String GROUP_EVENT_QUEUE_MAX_DEPTH
static final java.lang.String GROUP_EVENT_QUEUE_FLUSH_INTERVAL
static final int DEFAULT_WORKER_POOL_SIZE
static final ThreadPoolType DEFAULT_WORKER_POOL_TYPE
static final int DEFAULT_WORKER_POOL_SIZE_THRESHOLD
static final int DEFAULT_WORKER_QUEUE_SIZE_THRESHOLD
static final int DEFAULT_SYSTEM_WORKER_POOL_SIZE
static final ThreadPoolType DEFAULT_SYSTEM_WORKER_POOL_TYPE
static final int DEFAULT_SCAVENGER_RECONNECT_ATTEMPTS
static final long DEFAULT_SCAVENGER_RECONNECT_INTERVAL
static final boolean DEFAULT_ANONYMOUS_REGISTRATION
static final UserState DEFAULT_ANONYMOUS_USER
static final long DEFAULT_THREAD_MONITOR_INTERVAL
static final long DEFAULT_BLOCKED_THREAD_ADVISORY_THRESHOLD
static final long DEFAULT_CONNECTION_TIMEOUT
static final long DEFAULT_REPLY_TIMEOUT
static final long DEFAULT_FAST_REPLY_TIMEOUT
static final long DEFAULT_LONG_REPLY_TIMEOUT
static final long DEFAULT_BROADCAST_REPLY_TIMEOUT
static final long DEFAULT_TOKEN_DELAY
static final long DEFAULT_TOKEN_MONITOR_INTERVAL
static final long DEFAULT_FAST_FAIL_TIMEOUT
static final long DEFAULT_ACCESSOR_MONITOR_INTERVAL
static final int DEFAULT_ACCESSOR_POOL_SIZE
static final long DEFAULT_ACCESSOR_POOL_EXPIRATION_TIMEOUT
static final int DEFAULT_NODE_WEIGHT
static final boolean DEFAULT_WEB_APP_TOKEN_AUTHENTICATION
static final long DEFAULT_GROUP_EVENT_QUEUE_MAX_DEPTH
static final long DEFAULT_GROUP_EVENT_QUEUE_FLUSH_INTERVAL
int getWorkerPoolSize()
Default value is 100
.
void setWorkerPoolSize(int poolSize) throws FabricExchangeException
The value must be positive.
poolSize
- the size to be set.FabricExchangeException
- if the specified size is not positive (i.e. poolSize <= 0
);ThreadPoolType getWorkerPoolType()
Default value is ThreadPoolType.DYNAMIC
.
void setWorkerPoolType(ThreadPoolType poolType)
poolType
- the type to be set.int getWorkerPoolSizeThreshold()
int getWorkerQueueSizeThreshold()
int getSystemWorkerPoolSize()
Default value is 25
.
void setSystemWorkerPoolSize(int poolSize) throws FabricExchangeException
The value must be positive.
poolSize
- the size to be set.FabricExchangeException
- if the specified size is not positive (i.e. poolSize <= 0
);ThreadPoolType getSystemWorkerPoolType()
Default value is ThreadPoolType.DYNAMIC
.
void setSystemWorkerPoolType(ThreadPoolType poolType)
poolType
- the type to be set.int getScavengerReconnectAttempts()
Value 0
means that the Scavenger will not attempt to reconnect.
Negative value means that the Scavenger will try to reconnect infinitely (until successful connection).
Default value is -1
.
void setScavengerReconnectAttempts(int reconnectAttempts)
0
means that the Scavenger will not attempt to reconnect.
reconnectAttempts
- the number of attempts to be set.long getScavengerReconnectInterval()
Default value is 30L
.
void setScavengerReconnectInterval(long reconnectInterval) throws FabricExchangeException
reconnectInterval
- the time interval to be set.FabricExchangeException
- if the specified interval is not positive (i.e. reconnectInterval <= 0
);boolean anonymousRegistration()
Default value is true
.
This parameter is replicated in the sysplex.
true
if the sysplex enables an anonymous registration, false
otherwise.void setAnonymousRegistration(boolean anonymousRegistration) throws FabricExchangeException
If the node is in the sysplex, only administrator can can change this parameter. So if the Runtime user is not an administrator this operation will fail.
anonymousRegistration
- true
if the sysplex enables an anonymous registration, false
otherwise.FabricExchangeException
- if the user has insufficient right to perform this operation.UserState getAnonymousUser()
Default value is .
This parameter is replicated in the sysplex.
void setAnonymousUser(UserState state) throws FabricExchangeException
UserState.ENABLED
and UserState.DISABLED
values are allowed.
If the node is in the sysplex, only administrator can can change this parameter. So if the Runtime user is not an administrator this operation will fail.
state
- true
the state to be set.FabricExchangeException
- if the user has insufficient right to perform this operation or
if the specified state is not allowed.long getThreadMonitorInterval()
JVM
threads.
Non-positive value means that this monitor is not used.
Default value is 60L
.
void setThreadMonitorInterval(long monitorInterval)
JVM
threads.
Non-positive value means that this monitor will be disabled.
monitorInterval
- the time interval to be set.long getBlockedThreadAdvisoryThreshold()
BlockedThreadAdvisory
) will be raised.
Non-positive value means that this threshold is not used.
Default value is 900L
.
BlockedThreadAdvisory
.void setBlockedThreadAdvisoryThreshold(long advisoryThreshold)
BlockedThreadAdvisory
) will be raised.
Non-positive value means that the advisory will not be raised.
advisoryThreshold
- the threshold to be set.java.util.Map getClientThresholds()
setClientThresholds(Map)
for details.void setClientThresholds(java.util.Map thresholds) throws FabricExchangeException
ClientThresholdAdvisory.EVENT_ID
] is raised.
thresholds
- the thresholds to be set.FabricExchangeException
- if the specified values are invalid (null or not supported).java.lang.String getAdvancedParameter(java.lang.String name)
Supported parameters are the following:
"connectionTimeout"
- the time (in seconds) of waiting for establishing outgoing connections."replyTimeout"
- the time (in seconds) of waiting for reply for internal standard requests.
This parameter is replicated in the sysplex."fastReplyTimeout"
- the time (in seconds) of waiting for reply for internal fast requests.
This parameter is replicated in the sysplex."longReplyTimeout"
- the time (in seconds) of waiting for reply for internal long requests.
This parameter is replicated in the sysplex."broadcastReplyTimeout"
- the time (in seconds) of waiting for reply for internal broadcast requests.
This parameter is replicated in the sysplex."tokenDelay"
- the delay (in milliseconds) before passing the synchronization token to the next node.
This parameter is replicated in the sysplex."tokenMonitorInterval"
- the time (in seconds) between successive repetitions in the monitor which
observes a state of the synchronization token."fastFailTimeout"
- the time (in seconds) of waiting for a synchronization token before
applying the 'fast-fail' behavior (moving the node to a standalone mode)."accessorMonitorInterval"
- the time (in seconds) between successive repetitions in the monitor which
observes a state of Fabric Accessors
in the node."accessorPoolSize"
- the maximum number of Fabric Accessors
in the pool
of Fabric Component
(Dataspace
or Service
). Such pools are used in RPL scripts."accessorPoolExpirationTimeout"
- the time (in seconds) before closing an idle accessor in the pool.
"accessorPoolSize"
parameter for further information."nodeWeight"
- the weight of the node in the sysplex. This parameter can specify a priority of the node
in various situations.
Fabric Accessor
to select the node
if the nodeName
parameter is not specified (see FabricComponentAccessor
)."webAppTokenAuthentication"
- checks if the sysplex allows users authentication with Web Application Token
.
This parameter is replicated in the sysplex."groupEventQueueMaxDepth"
- the maximum number of events that can be stored
in the internal event queue of a Fabric Group before flushing them to corresponding consumers.
"groupEventQueueFlushInterval"
- the time (in seconds) between successive repetitions
in the thread which flushes events from the internal event queue of a Fabric Group.
name
- the specified parameter name.null
if this parameter is not supported.void setAdvancedParameter(java.lang.String name, java.lang.String value) throws FabricExchangeException
MacroProcessor
for details).
Supported parameters are the following:
"connectionTimeout"
- the time (in seconds) of waiting for establishing outgoing connections.
"replyTimeout"
- the time (in seconds) of waiting for reply for internal standard requests.
"fastReplyTimeout"
- the time (in seconds) of waiting for reply for internal fast requests.
"longReplyTimeout"
- the time (in seconds) of waiting for reply for internal long requests.
"broadcastReplyTimeout"
- the time (in seconds) of waiting for reply for internal broadcast requests.
"tokenDelay"
- the delay (in milliseconds) before passing the synchronization token to the next node.
"tokenMonitorInterval"
- the time (in seconds) between successive repetitions in the monitor which
observes a state of the synchronization token.
"fastFailTimeout"
- the time (in seconds) of waiting for a synchronization token before
applying the 'fast-fail' behavior (moving the node to a standalone mode).
"accessorMonitorInterval"
- the time (in seconds) between successive repetitions in the monitor which
observes a state of Fabric Accessors
in the node.
"accessorPoolSize"
- the maximum number of Fabric Accessors
in the pool
of Fabric Component
(Dataspace
or Service
). Such pools are used in RPL scripts.
"accessorPoolExpirationTimeout"
- the time (in seconds) before closing an idle accessor in the pool.
"accessorPoolSize"
parameter for further information.
"nodeWeight"
- the weight of the node in the sysplex. This parameter can specify a priority of the node
in various situations.
Fabric Accessor
to select the node
if the nodeName
parameter is not specified (see FabricComponentAccessor
).
"webAppTokenAuthentication"
- checks if the sysplex allows users authentication with Web Application Token
.
Such token can be assigned to a user and used for authentication instead of a standard username/password pair."groupEventQueueMaxDepth"
- the maximum number of events that can be stored in the internal event queue
of a Fabric Group before flushing them to corresponding consumers.
"groupEventQueueFlushInterval"
- the time (in seconds) between successive repetitions in the thread which
flushes events from the internal event queue of a Fabric Group.
name
- the name of the parameter.value
- the value to be set.FabricExchangeException
- if the specified parameter is not supported or
if the specified value is invalid.java.util.List listAdvancedParameters()
java.util.List getTopology()
long nextGlobalCount()
Global Counter
and returns its new value.
long showGlobalCounter()
Global Counter
.
long resetGlobalCounter() throws FabricExchangeException
Global Counter
, setting its value to 1
.
If the node is in the sysplex, only administrator can invoke this method. So if the Runtime user is not an administrator this operation will fail.
0
).FabricExchangeException
- if the Runtime user is not administrator.Copyright © 2015-2024 StreamScape Technologies. All rights reserved.