Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.warmstandby
Class WarmStandbyConfiguration

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.warmstandby.WarmStandbyConfiguration

public class WarmStandbyConfiguration
extends java.lang.Object

The WarmStandbyConfiguration class contains redundancy configuration options, including:


Field Summary
static int MAX_TIMEOUT
          Maximum timeout/delay between channel reopening attempts.
 
Constructor Summary
WarmStandbyConfiguration(Endpoint activeEndpoint, Endpoint standbyEndpoint)
          Creates a WarmStandbyConfiguration instance.
WarmStandbyConfiguration(Endpoint activeEndpoint, Endpoint standbyEndpoint, int timeout, short attempts)
          Creates a WarmStandbyConfiguration instance.
WarmStandbyConfiguration(Endpoint activeEndpoint, Endpoint standbyEndpoint, int timeout, short attempts, short switchovers)
          Creates a WarmStandbyConfiguration instance.
WarmStandbyConfiguration(Endpoint activeEndpoint, Endpoint standbyEndpoint, int timeout, short attempts, short switchovers, int firstReconnectTimeout)
          Creates a WarmStandbyConfiguration instance.
 
Method Summary
 Endpoint getActiveEndpoint()
          Gets the active endpoint.
 java.lang.Short getAttempts()
          Gets the maximum number of reconnection attempts.
 java.lang.Integer getFirstReconnectTimeout()
          Gets timeout (in milliseconds) of first fast reconnect.
 Endpoint getStandbyEndpoint()
          Gets the standby endpoint.
 java.lang.Short getSwitchovers()
          Gets the number of primary/backup switchovers.
 java.lang.Integer getTimeout()
          Gets the timeout (in milliseconds) between the reconnection attempts.
 void setActiveEndpoint(Endpoint newActiveEndpoint)
          Sets the active endpoint.
 void setAttempts(java.lang.Short attemptsNum)
          Sets the maximum number of reconnection attempts.
 void setFirstReconnectTimeout(java.lang.Integer firstReconnectTimeout)
          Sets timeout of first fast reconnect.
 void setStandbyEndpoint(Endpoint newStandbyEndpoint)
          Sets the standby endpoint.
 void setSwitchovers(java.lang.Short switchoversNum)
          Sets the number of primary/backup switchovers.
 void setTimeout(java.lang.Integer newTimeout)
          Sets the newTimeout (in milliseconds) between the reconnection attempts.
 java.lang.String toString()
          Returns a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MAX_TIMEOUT

public static final int MAX_TIMEOUT
Maximum timeout/delay between channel reopening attempts.

See Also:
Constant Field Values
Constructor Detail

WarmStandbyConfiguration

public WarmStandbyConfiguration(Endpoint activeEndpoint,
                                Endpoint standbyEndpoint)
Creates a WarmStandbyConfiguration instance.

Parameters:
activeEndpoint - channel's Active Endpoint
standbyEndpoint - channel's Standby Endpoint

WarmStandbyConfiguration

public WarmStandbyConfiguration(Endpoint activeEndpoint,
                                Endpoint standbyEndpoint,
                                int timeout,
                                short attempts)
Creates a WarmStandbyConfiguration instance.

Parameters:
activeEndpoint - channel's Active Endpoint
standbyEndpoint - channel's Standby Endpoint
timeout - timeout between reconnection attempts (in milliseconds)
attempts - number of reconnection attempts

WarmStandbyConfiguration

public WarmStandbyConfiguration(Endpoint activeEndpoint,
                                Endpoint standbyEndpoint,
                                int timeout,
                                short attempts,
                                short switchovers)
Creates a WarmStandbyConfiguration instance.

Parameters:
activeEndpoint - channel's Active Endpoint
standbyEndpoint - channel's Standby Endpoint
timeout - timeout between reconnection attempts (in milliseconds)
attempts - number of reconnection attempts
switchovers - number of primary/backup switchovers

WarmStandbyConfiguration

public WarmStandbyConfiguration(Endpoint activeEndpoint,
                                Endpoint standbyEndpoint,
                                int timeout,
                                short attempts,
                                short switchovers,
                                int firstReconnectTimeout)
Creates a WarmStandbyConfiguration instance.

Parameters:
activeEndpoint - channel's Active Endpoint
standbyEndpoint - channel's Standby Endpoint
timeout - timeout between reconnection attempts (in milliseconds)
attempts - number of reconnection attempts
switchovers - number of primary/backup switchovers
firstReconnectTimeout - timeout of first fast reconnect
Method Detail

getActiveEndpoint

public final Endpoint getActiveEndpoint()
Gets the active endpoint.

Returns:
active endpoint

setActiveEndpoint

public final void setActiveEndpoint(Endpoint newActiveEndpoint)
Sets the active endpoint.

Parameters:
newActiveEndpoint - active endpoint

getStandbyEndpoint

public final Endpoint getStandbyEndpoint()
Gets the standby endpoint.

Returns:
standby endpoint

setStandbyEndpoint

public final void setStandbyEndpoint(Endpoint newStandbyEndpoint)
Sets the standby endpoint.

Parameters:
newStandbyEndpoint - standby endpoint

getSwitchovers

public final java.lang.Short getSwitchovers()
Gets the number of primary/backup switchovers.

Returns:
the number of primary/backup switchovers

setSwitchovers

public final void setSwitchovers(java.lang.Short switchoversNum)
Sets the number of primary/backup switchovers. If this parameter is not set, or if it is set to null, then an unlimited number of switchovers are allowed. If this parameter is set to 0 then switchover will not happen.

Parameters:
switchoversNum - the number of primary/backup switchovers

getTimeout

public final java.lang.Integer getTimeout()
Gets the timeout (in milliseconds) between the reconnection attempts.

Returns:
the timeout value in milliseconds

setTimeout

public final void setTimeout(java.lang.Integer newTimeout)
Sets the newTimeout (in milliseconds) between the reconnection attempts.

Parameters:
newTimeout - the new timeout value in milliseconds

getAttempts

public final java.lang.Short getAttempts()
Gets the maximum number of reconnection attempts.

Returns:
the number of reconnection attempts

setAttempts

public final void setAttempts(java.lang.Short attemptsNum)
Sets the maximum number of reconnection attempts.

Parameters:
attemptsNum - the number of reconnection attempts

getFirstReconnectTimeout

public java.lang.Integer getFirstReconnectTimeout()
Gets timeout (in milliseconds) of first fast reconnect.

Returns:
timeout (in milliseconds) of first fast reconnect.

setFirstReconnectTimeout

public void setFirstReconnectTimeout(java.lang.Integer firstReconnectTimeout)
Sets timeout of first fast reconnect.

Parameters:
firstReconnectTimeout - timeout of first fast reconnect in milliseconds.

toString

public java.lang.String toString()
Returns a string representation of the object.

Overrides:
toString in class java.lang.Object
Returns:
a string representation of the object

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.