Platform SDK Java 8.5 API Reference

com.genesyslab.platform.clusterprotocol
Class ClusterProtocolBuilder<P extends ClientChannel,CP extends ClusterProtocol,PB extends ProtocolBuilder<P,PB>,B extends ClusterProtocolBuilder<P,CP,PB,B>>

java.lang.Object
  extended by com.genesyslab.platform.clusterprotocol.ClusterProtocolBuilder<P,CP,PB,B>
Type Parameters:
P - cluster protocol node protocol type.
CP - cluster protocol type.
PB - cluster protocol node builder type.
B - cluster protocol builder type.
Direct Known Subclasses:
EspClusterProtocolBuilder, EspEmailClusterProtocolBuilder, FlexChatClusterProtocolBuilder, UcsClusterProtocolBuilder

public abstract class ClusterProtocolBuilder<P extends ClientChannel,CP extends ClusterProtocol,PB extends ProtocolBuilder<P,PB>,B extends ClusterProtocolBuilder<P,CP,PB,B>>
extends java.lang.Object

Abstract generic builder base for Cluster Protocols construction.


Field Summary
protected  ClusterProtocolLoadBalancer loadBalancer
           
protected  PB protocolBuilder
           
protected  ClusterProtocolPolicy protocolPolicy
           
 
Constructor Summary
ClusterProtocolBuilder()
           
 
Method Summary
abstract  CP build()
          Creates and returns new instance of Cluster Protocol.
 B withClusterProtocolPolicy(ClusterProtocolPolicy protocolPolicy)
          Initializes cluster protocol builder with custom cluster protocol policy.
 B withLoadBalancer(ClusterProtocolLoadBalancer loadBalancer)
          Initializes cluster protocol builder with custom load balancer.
 B withProtocolBuilder(PB protocolBuilder)
          Initializes cluster protocol builder with custom protocol nodes builder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

protocolBuilder

protected PB extends ProtocolBuilder<P,PB> protocolBuilder

loadBalancer

protected ClusterProtocolLoadBalancer loadBalancer

protocolPolicy

protected ClusterProtocolPolicy protocolPolicy
Constructor Detail

ClusterProtocolBuilder

public ClusterProtocolBuilder()
Method Detail

withProtocolBuilder

public B withProtocolBuilder(PB protocolBuilder)
Initializes cluster protocol builder with custom protocol nodes builder.

Parameters:
protocolBuilder - the protocol cluster nodes builder.
Returns:
self reference to this cluster protocol builder.

withLoadBalancer

public B withLoadBalancer(ClusterProtocolLoadBalancer loadBalancer)
Initializes cluster protocol builder with custom load balancer.

Note: Cluster Protocol Load Balancer component is stateful, so, it is not supposed to share same instance of Load Balancer between different Cluster Protocol instances. I.e. do not build more than one cluster protocol with single instance of load balancer.

Parameters:
loadBalancer - user defined instance of Cluster Protocol Load Balancer.
Returns:
self reference to this cluster protocol builder.

withClusterProtocolPolicy

public B withClusterProtocolPolicy(ClusterProtocolPolicy protocolPolicy)
Initializes cluster protocol builder with custom cluster protocol policy.

Parameters:
protocolPolicy - user defined cluster protocol policy.
Returns:
self reference to this cluster protocol builder.

build

public abstract CP build()
Creates and returns new instance of Cluster Protocol.

Returns:
new instance of Cluster Protocol.

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.