Platform SDK Java 8.5 API Reference

com.genesyslab.platform.clusterprotocol
Class DefaultClusterProtocolPolicy

java.lang.Object
  extended by com.genesyslab.platform.clusterprotocol.DefaultClusterProtocolPolicy
All Implemented Interfaces:
ClusterProtocolPolicy

public class DefaultClusterProtocolPolicy
extends java.lang.Object
implements ClusterProtocolPolicy

Default implementation of Cluster Protocol policy.

See Also:
ClusterProtocolBuilder.withClusterProtocolPolicy(ClusterProtocolPolicy)

Constructor Summary
DefaultClusterProtocolPolicy()
           
 
Method Summary
 boolean useRequestProtocolId()
          Reserved for future use.
 DefaultClusterProtocolPolicy useRequestProtocolId(boolean useRequestProtocolId)
          Reserved for future use.
 boolean waitOnChannelOpening()
          This option indicates that the Cluster Protocol should hold on user thread on messages sending to wait for connection restoration.
 DefaultClusterProtocolPolicy waitOnChannelOpening(boolean waitOnChannelOpening)
          This option indicates that the Cluster Protocol should hold on user thread on messages sending to wait for connection restoration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultClusterProtocolPolicy

public DefaultClusterProtocolPolicy()
Method Detail

waitOnChannelOpening

public boolean waitOnChannelOpening()
This option indicates that the Cluster Protocol should hold on user thread on messages sending to wait for connection restoration.

If protocol is Opening and this option is true, the Cluster Protocol will hold user thread on send()/request()/beginRequest()/requestAsync() calls instead of throwing immediate exception.
It will use the protocol timeout value as maximum wait time.

If Cluster Protocol is Opening, and it got no opened connections in the timeout frame, ChannelClosedOnSendException will be thrown.
If this option is false, the exception will be thrown immediately.

Specified by:
waitOnChannelOpening in interface ClusterProtocolPolicy
Returns:
true - if the hold on feature is enabled, false - if it's not.

waitOnChannelOpening

public DefaultClusterProtocolPolicy waitOnChannelOpening(boolean waitOnChannelOpening)
This option indicates that the Cluster Protocol should hold on user thread on messages sending to wait for connection restoration.

If protocol is Opening and this option is true, the Cluster Protocol will hold user thread on send()/request()/beginRequest()/requestAsync() calls instead of throwing immediate exception.
It will use the protocol timeout value as maximum wait time.

If Cluster Protocol is Opening, and it got no opened connections in the timeout frame, ChannelClosedOnSendException will be thrown.
If this option is false, the exception will be thrown immediately.

Parameters:
waitOnChannelOpening - the "hold on" feature enabling option.

useRequestProtocolId

public boolean useRequestProtocolId()
Reserved for future use.

Specified by:
useRequestProtocolId in interface ClusterProtocolPolicy

useRequestProtocolId

public DefaultClusterProtocolPolicy useRequestProtocolId(boolean useRequestProtocolId)
Reserved for future use.


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.