Platform SDK Java 8.5 API Reference

Uses of Interface
com.genesyslab.platform.commons.protocol.Protocol

Packages that use Protocol
com.genesyslab.platform.applicationblocks.com   
com.genesyslab.platform.applicationblocks.commons.protocols   
com.genesyslab.platform.applicationblocks.warmstandby   
com.genesyslab.platform.clusterprotocol Cluster Protocol Application Block 
com.genesyslab.platform.clusterprotocol.chat Cluster Protocol classes for Chat Server protocol. 
com.genesyslab.platform.clusterprotocol.email Cluster Protocol classes for ESP Email Server. 
com.genesyslab.platform.clusterprotocol.esp

External Service Cluster Protocol. 

com.genesyslab.platform.clusterprotocol.lb Load Balancer for Cluster Protocol. 
com.genesyslab.platform.clusterprotocol.ucs Cluster Protocol classes for Universal Contact Server. 
com.genesyslab.platform.commons.protocol Contains classes that support the Protocol objects used by applications developed with the Platform SDKs. 
com.genesyslab.platform.configuration.protocol This package contains the Protocol classes that your applications can use to set up communication with Configuration Server. 
com.genesyslab.platform.contacts.protocol This package contains the Protocol classes that your applications can use to set up communication with Universal Contact Server, including UniversalContactServerProtocol
com.genesyslab.platform.logging   
com.genesyslab.platform.logging.runtime   
com.genesyslab.platform.logging.runtime.targets   
com.genesyslab.platform.management.protocol This package contains the Protocol classes that your applications can use to set up communication with Genesys Solution Control Server, Message Server and Local Control Agents (LCAs). 
com.genesyslab.platform.management.protocol.localcontrolagentheartbeat.runtime This package is used internally by the protocol. 
com.genesyslab.platform.openmedia.protocol This package contains the Protocol classes that your applications can use to set up communication with Interaction Server. 
com.genesyslab.platform.outbound.protocol This package contains the Protocol classes that your applications can use to set up communication with Outbound Contact Server. 
com.genesyslab.platform.reporting.protocol This package contains the StatServerProtocol class that you can use this class to set up communication with Stat Server. 
com.genesyslab.platform.routing.protocol This package contains the UrsCustomProtocol, UrsCustomProtocolListener and RoutingServerProtocol classes. 
com.genesyslab.platform.voice.protocol This package contains the Protocol classes that your applications can use to set up communication with T-Server, such as TServerProtocol
com.genesyslab.platform.webmedia.protocol This package contains the Protocol classes that allow you to create applications that integrate with Genesys non-voice media servers. 
 

Uses of Protocol in com.genesyslab.platform.applicationblocks.com
 

Methods in com.genesyslab.platform.applicationblocks.com that return Protocol
 Protocol IConfService.getProtocol()
          Returns a reference to the protocol connection to Configuration Server.
 Protocol ConfService.getProtocol()
          Returns a reference to the protocol connection to Configuration Server.
 

Methods in com.genesyslab.platform.applicationblocks.com with parameters of type Protocol
static IConfService ConfServiceFactory.createConfService(Protocol protocol)
          This method creates an instance of a Configuration Service based on the specified protocol.
static IConfService ConfServiceFactory.createConfService(Protocol protocol, boolean enableCaching)
          This method creates an instance of a Configuration Service based on the specified protocol.
static IConfService ConfServiceFactory.createConfService(Protocol protocol, IConfServicePolicy confServicePolicy, IConfCache cache)
          Creates a configuration service with the specified policy information.
static IConfService ConfServiceFactory.createConfService(Protocol protocol, IConfServicePolicy confServicePolicy, IConfCachePolicy confCachePolicy)
          Creates a configuration service with the specified policy information.
 ConfService ConfServiceCreator.createInstance(Protocol protocol)
           
static IConfService ConfServiceFactory.retrieveConfService(Protocol protocol)
          Retrieves an instance of the Configuration Service based on the specified protocol.
 

Constructors in com.genesyslab.platform.applicationblocks.com with parameters of type Protocol
ConfService(Protocol protocol)
          Creates a new instance of the class.
 

Uses of Protocol in com.genesyslab.platform.applicationblocks.commons.protocols
 

Methods in com.genesyslab.platform.applicationblocks.commons.protocols that return Protocol
 Protocol ProtocolManagementServiceImpl.getProtocol(java.lang.String name)
          Deprecated.  
 Protocol ProtocolManagementService.getProtocol(java.lang.String s)
          Deprecated.  
 Protocol ProtocolManagementServiceImpl.register(ProtocolConfiguration protocolConfiguration)
          Deprecated.  
 Protocol ProtocolManagementService.register(ProtocolConfiguration protocolconfiguration)
          Deprecated.  
 

Uses of Protocol in com.genesyslab.platform.applicationblocks.warmstandby
 

Methods in com.genesyslab.platform.applicationblocks.warmstandby that return Protocol
 Protocol WarmStandbyService.getChannel()
          Gets the channel the WarmStandbyService is responsible for.
 

Constructors in com.genesyslab.platform.applicationblocks.warmstandby with parameters of type Protocol
WarmStandbyService(Protocol protocolChannel)
          Creates a WarmStandbyService instance.
 

Uses of Protocol in com.genesyslab.platform.clusterprotocol
 

Subinterfaces of Protocol in com.genesyslab.platform.clusterprotocol
 interface ClusterProtocol
          Interface representing a client protocol connection on top of encapsulated multiple protocol connections to a cluster of similarly configured servers.
 

Classes in com.genesyslab.platform.clusterprotocol that implement Protocol
 class ClusterProtocolImpl<P extends ClientChannel,B extends ProtocolBuilder<P,B>>
          Abstract implementation base of Cluster Protocol interface.
It's a common functionality for all specific Cluster Protocols.
 

Methods in com.genesyslab.platform.clusterprotocol that return Protocol
protected  Protocol ClusterProtocolImpl.chooseProtocol(Message request)
           
 Protocol ClusterProtocolImpl.getNextAvailableProtocol()
           
 Protocol ClusterProtocol.getNextAvailableProtocol()
          Returns reference to some opened instance of protocol in the cluster nodes pool in accordance to the LB strategy.
 Protocol ClusterProtocolImpl.getNextAvailableProtocol(Message message)
           
 Protocol ClusterProtocol.getNextAvailableProtocol(Message message)
          Returns reference to some opened instance of protocol in the cluster nodes pool in accordance to the LB strategy for handling of the given request message.
 Protocol ClusterProtocolImpl.getNodeProtocol(int protocolId)
           
 Protocol ClusterProtocol.getNodeProtocol(int protocolId)
          Returns cluster protocol node instance by PSDK Protocol Id.
It may be useful in cases, when it is required to get particular server connection by ProtocolId of specific response, or unsolicited event message.
 Protocol ClusterProtocolImpl.getNodeProtocol(java.lang.String nodeName)
           
 Protocol ClusterProtocol.getNodeProtocol(java.lang.String nodeName)
          Returns cluster protocol node instance by name of configured Endpoint or WSConfig.
 

Methods in com.genesyslab.platform.clusterprotocol that return types with arguments of type Protocol
 java.util.List<Protocol> ClusterProtocolImpl.getAllNodesProtocols()
           
 java.util.List<Protocol> ClusterProtocol.getAllNodesProtocols()
          Returns snapshot list of all cluster protocol nodes.
 java.util.List<Protocol> ClusterProtocolImpl.getOpenedNodesProtocols()
           
 java.util.List<Protocol> ClusterProtocol.getOpenedNodesProtocols()
          Returns snapshot list of cluster protocol nodes, which are tracked as Opened at the moment.
 

Constructors in com.genesyslab.platform.clusterprotocol with parameters of type Protocol
ClusterProtocolImpl.RequestFutureWrapper(RequestFuture rqFuture, Protocol protocol)
           
 

Uses of Protocol in com.genesyslab.platform.clusterprotocol.chat
 

Classes in com.genesyslab.platform.clusterprotocol.chat that implement Protocol
 class FlexChatClusterProtocol
           
 

Uses of Protocol in com.genesyslab.platform.clusterprotocol.email
 

Classes in com.genesyslab.platform.clusterprotocol.email that implement Protocol
 class EspEmailClusterProtocol
           
 

Uses of Protocol in com.genesyslab.platform.clusterprotocol.esp
 

Classes in com.genesyslab.platform.clusterprotocol.esp that implement Protocol
 class EspClusterProtocol
          External Service Cluster Protocol.
 

Uses of Protocol in com.genesyslab.platform.clusterprotocol.lb
 

Methods in com.genesyslab.platform.clusterprotocol.lb that return Protocol
 Protocol DefaultClusterLoadBalancer.chooseNode(Message request)
           
 Protocol ClusterProtocolLoadBalancer.chooseNode(Message message)
          This method is to apply load balancing strategy on available cluster nodes.
 

Methods in com.genesyslab.platform.clusterprotocol.lb with parameters of type Protocol
 void DefaultClusterLoadBalancer.addNode(Protocol item)
           
 void ClusterProtocolLoadBalancer.addNode(Protocol node)
          This method is to add just connected Cluster Protocol Node to load balancing strategy.
 void DefaultClusterLoadBalancer.removeNode(Protocol item)
           
 void ClusterProtocolLoadBalancer.removeNode(Protocol node)
          This method is to remove Cluster Protocol Node from load balancing strategy.
Its called when node is removed from the cluster, or its protocol connection is lost.
 

Uses of Protocol in com.genesyslab.platform.clusterprotocol.ucs
 

Classes in com.genesyslab.platform.clusterprotocol.ucs that implement Protocol
 class UcsClusterProtocol
          Universal Contact Server Cluster Protocol.
 

Uses of Protocol in com.genesyslab.platform.commons.protocol
 

Classes in com.genesyslab.platform.commons.protocol that implement Protocol
 class ClientChannel
          ClientChannel is the parent class of all of the Protocol classes used for client applications in the Platform SDK, such as TServerProtocol and ConfServerProtocol.
 

Uses of Protocol in com.genesyslab.platform.configuration.protocol
 

Classes in com.genesyslab.platform.configuration.protocol that implement Protocol
 class ConfServerProtocol
          Use a ConfServerProtocol object to establish communication between application and Genesys Configuration Server.
 

Uses of Protocol in com.genesyslab.platform.contacts.protocol
 

Classes in com.genesyslab.platform.contacts.protocol that implement Protocol
 class UniversalContactServerProtocol
          Use a UniversalContactServerProtocol object to establish communication between an agent application (or other client application) and Universal Contact Server.
 

Uses of Protocol in com.genesyslab.platform.logging
 

Methods in com.genesyslab.platform.logging that return Protocol
 Protocol LoggerSupport.getNetworkProtocol()
          Please note: The instance of Logger does not control the lifetime or lifecycle of the passed networkProtocol.
 

Methods in com.genesyslab.platform.logging with parameters of type Protocol
 void LoggerSupport.setNetworkProtocol(Protocol protocol)
          Please note: The instance of Logger does not control the lifetime or lifecycle of the passed networkProtocol.
 

Uses of Protocol in com.genesyslab.platform.logging.runtime
 

Methods in com.genesyslab.platform.logging.runtime that return Protocol
 Protocol Logger.getNetworkProtocol()
          Please note: the instance of Logger does not control the lifetime or lifecycle of passed networkProtocol.
 

Methods in com.genesyslab.platform.logging.runtime with parameters of type Protocol
 void Logger.setNetworkProtocol(Protocol value)
           
 

Uses of Protocol in com.genesyslab.platform.logging.runtime.targets
 

Methods in com.genesyslab.platform.logging.runtime.targets with parameters of type Protocol
 SpooledNetworkTarget TargetFactory.createNetworkTarget(LogConfiguration configuration, Protocol networkProtocol)
           
 SpooledNetworkTarget DefaultTargetFactory.createNetworkTarget(LogConfiguration configuration, Protocol networkProtocol)
           
 void SpooledNetworkTarget.replaceCarryingProtocol(Protocol argProt)
           
 void MessageServerTarget.replaceCarryingProtocol(Protocol argProt)
           
 

Constructors in com.genesyslab.platform.logging.runtime.targets with parameters of type Protocol
MessageServerTarget(Protocol theProtocol, VerboseLevel level, boolean shouldBeEnabled)
           
SpooledNetworkTarget(NetworkTargetConfiguration configuration, Protocol protocol)
           
 

Uses of Protocol in com.genesyslab.platform.management.protocol
 

Classes in com.genesyslab.platform.management.protocol that implement Protocol
 class LocalControlAgentProtocol
          Use a LocalControlAgentProtocol object to establish communication between a client application and Genesys Local Control Agent.
 class MessageServerProtocol
          Use a MessageServerProtocol object to establish communication between a client application and Genesys Message Server.
 class SolutionControlServerProtocol
          Use an SolutionControlServerProtocol object to establish communication between an agent application (or other client application) and Solution ControlServer.
 

Uses of Protocol in com.genesyslab.platform.management.protocol.localcontrolagentheartbeat.runtime
 

Classes in com.genesyslab.platform.management.protocol.localcontrolagentheartbeat.runtime that implement Protocol
 class LcaUdpHeartbeatInternalProtocol
           
 

Uses of Protocol in com.genesyslab.platform.openmedia.protocol
 

Classes in com.genesyslab.platform.openmedia.protocol that implement Protocol
 class ExternalServiceProtocol
           
 class InteractionServerProtocol
          Use an InteractionServerProtocol object to establish communication between an agent application (or other client application) and Interaction Server.
 

Uses of Protocol in com.genesyslab.platform.outbound.protocol
 

Classes in com.genesyslab.platform.outbound.protocol that implement Protocol
 class OutboundServerProtocol
          Use an OutboundServerProtocol object to establish communication between a client application and Outbound Server.
 

Uses of Protocol in com.genesyslab.platform.reporting.protocol
 

Classes in com.genesyslab.platform.reporting.protocol that implement Protocol
 class StatServerProtocol
          Use a StatServerProtocol object to establish communication between a client application and Statistics Server.
 

Uses of Protocol in com.genesyslab.platform.routing.protocol
 

Classes in com.genesyslab.platform.routing.protocol that implement Protocol
 class RoutingServerProtocol
          Use a RoutingServerProtocol object to establish communication between a client application and Universal Routing Server.
 class UrsCustomProtocol
           
 

Uses of Protocol in com.genesyslab.platform.voice.protocol
 

Classes in com.genesyslab.platform.voice.protocol that implement Protocol
 class TServerProtocol
          Use a TServerProtocol object to establish communication between a client application and TServer.
 

Uses of Protocol in com.genesyslab.platform.webmedia.protocol
 

Classes in com.genesyslab.platform.webmedia.protocol that implement Protocol
 class BasicChatProtocol
          By default, BasicChatProtocol has enabled AutoRegister mode.
 class CallbackProtocol
           
 class EmailProtocol
          Deprecated.  
 class EspEmailProtocol
          Use an EspEmailProtocol object to establish communication between client application and ESP based Email Server.
 class FlexChatProtocol
          By default, channel has enabled AutoRegister mode.
 class OptionalRegistrationChannel
           
 class WebmediaChannel
          It's an abstract base class for all WebMedia protocols including BasicChat, FlexChat, Callback and XML based Email protocols.
 


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.