com.highdeal.cnd.message
Class StatefulServiceClientTuning

java.lang.Object
  extended by com.highdeal.cnd.message.ServiceClientTuning
      extended by com.highdeal.cnd.message.StatefulServiceClientTuning

public class StatefulServiceClientTuning
extends ServiceClientTuning


Field Summary
static int RATER_DOWN_NOTIFICATION_DEFAULT_TIMEOUT
          Constant describing the default value of the timeout of the rater down notification (is 10000 ms).
 
Fields inherited from class com.highdeal.cnd.message.ServiceClientTuning
CONNECT_TIMEOUT, HEARTBEAT_DEFAULT_ACTIVATION_PERIOD_COUNT, HEARTBEAT_DEFAULT_DEAD_CONNECTION_PERIOD_COUNT, HEARTBEAT_DEFAULT_POLLING_PERIOD, SEARCH_INSTANCE_MAP_DEFAULT_TIMEOUT
 
Constructor Summary
StatefulServiceClientTuning()
          Initializes a StatefulServiceClientTuning with the default values
StatefulServiceClientTuning(int searchInstanceMapDurationInSecond, int heartBeatPollingPeriodInMilliSecond, int heartBeatActivationPeriodCount, int heartBeatDeadConnectionPeriodCount, int raterDownNotificationTimeoutInMilliSecond, int connectTimeoutInMilliSecond)
          Initializes a StatefulServiceClient with the specified value
 
Method Summary
 int getRaterDownNotificationTimeout()
          Returns the timeout in millisecond of the rater down request.
 void setRaterDownNotificationTimeout(int timeout)
          Sets the timeout in millisecond of the rater down request.
 
Methods inherited from class com.highdeal.cnd.message.ServiceClientTuning
getConnectTimeout, getHeartBeatActivationPeriodCount, getHeartBeatDeadConnectionPeriodCount, getHeartBeatPollingPeriod, getSearchInstanceMapTimeout, isDebugModeEnable, setConnectTimeout, setHeartBeatActivationPeriodCount, setHeartBeatDeadConnectionPeriodCount, setHeartBeatPollingPeriod, setSearchInstanceMapTimeout
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RATER_DOWN_NOTIFICATION_DEFAULT_TIMEOUT

public static final int RATER_DOWN_NOTIFICATION_DEFAULT_TIMEOUT
Constant describing the default value of the timeout of the rater down notification (is 10000 ms).

See Also:
Constant Field Values
Constructor Detail

StatefulServiceClientTuning

public StatefulServiceClientTuning()
Initializes a StatefulServiceClientTuning with the default values


StatefulServiceClientTuning

public StatefulServiceClientTuning(int searchInstanceMapDurationInSecond,
                                   int heartBeatPollingPeriodInMilliSecond,
                                   int heartBeatActivationPeriodCount,
                                   int heartBeatDeadConnectionPeriodCount,
                                   int raterDownNotificationTimeoutInMilliSecond,
                                   int connectTimeoutInMilliSecond)
Initializes a StatefulServiceClient with the specified value

Parameters:
searchInstanceMapDurationInSecond - The timeout of the search instance map
heartBeatPollingPeriodInMilliSecond - The heart beat polling period
heartBeatActivationPeriodCount - The heat beat activation polling period count
heartBeatDeadConnectionPeriodCount - The heart beat dead connection polling period count
raterDownNotificationTimeoutInMilliSecond - The timeout of the request informing the backup that a rater seems to be done
See Also:
ServiceClientTuning.setSearchInstanceMapTimeout(int), ServiceClientTuning.setHeartBeatPollingPeriod(int), ServiceClientTuning.setHeartBeatActivationPeriodCount(int), ServiceClientTuning.setHeartBeatDeadConnectionPeriodCount(int), setRaterDownNotificationTimeout(int)
Method Detail

getRaterDownNotificationTimeout

public int getRaterDownNotificationTimeout()
Returns the timeout in millisecond of the rater down request.

Returns:
A duration in millisecond

setRaterDownNotificationTimeout

public void setRaterDownNotificationTimeout(int timeout)
Sets the timeout in millisecond of the rater down request.

This timeout describes the maximum duration the charging client has to expect a response from the SAP CC Core Server system when a rater instance is no more connected with the charging client. If this timeout is too small, the server may not have the time to return its response and will make the client switch to the next backup. If too long the heartbeat process will be interrupted. Prevents the client to be lock a long time if the backup are down. Its default value is RATER_DOWN_NOTIFICATION_DEFAULT_TIMEOUT. This timeout must be set according to server parameters

Throws:
java.lang.IllegalArgumentException - if timeout is out of range

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)