Platform SDK Java 8.5 API Reference

com.genesyslab.platform.clusterprotocol.email
Class EspEmailClusterProtocol

java.lang.Object
  extended by com.genesyslab.platform.clusterprotocol.AbstractClusterChannel<P>
      extended by com.genesyslab.platform.clusterprotocol.ClusterProtocolImpl<EspEmailProtocol,EspEmailProtocolBuilder>
          extended by com.genesyslab.platform.clusterprotocol.email.EspEmailClusterProtocol
All Implemented Interfaces:
ClusterProtocol, AsyncChannel, AsyncInvokerSupport, Channel, ChannelListenerSupport, ConfigurationSupport, ConnectionInvokerSupport, EndpointSupport, InputChannel, InterceptorSupport, MessageReceiver, MessageReceiverManagement, OutputChannel, Protocol, ProtocolDescriptionSupport, Receiver, ReceiverManagement, RequestChannel, EspEmailProtocolHandshakeOptions

public class EspEmailClusterProtocol
extends ClusterProtocolImpl<EspEmailProtocol,EspEmailProtocolBuilder>
implements EspEmailProtocolHandshakeOptions


Nested Class Summary
 
Nested classes/interfaces inherited from class com.genesyslab.platform.clusterprotocol.ClusterProtocolImpl
ClusterProtocolImpl.CompletionHelper<V,A>, ClusterProtocolImpl.RequestFutureWrapper
 
Nested classes/interfaces inherited from class com.genesyslab.platform.clusterprotocol.AbstractClusterChannel
AbstractClusterChannel.AsyncVisitor, AbstractClusterChannel.ChanelErrorVisitor, AbstractClusterChannel.ChannelClosedVisitor, AbstractClusterChannel.ChannelOpenVisitor, AbstractClusterChannel.IncomingMessageVisitor, AbstractClusterChannel.IntChannelListener, AbstractClusterChannel.InternalChannelCloseVisitor, AbstractClusterChannel.InternalChannelOpenVisitor, AbstractClusterChannel.IntMessageHandler, AbstractClusterChannel.IntOutputChannelListener, AbstractClusterChannel.IntWsHandler, AbstractClusterChannel.OutgoingMessageVisitor
 
Field Summary
 
Fields inherited from class com.genesyslab.platform.clusterprotocol.ClusterProtocolImpl
loadBalancer, protocolPolicy
 
Fields inherited from class com.genesyslab.platform.clusterprotocol.AbstractClusterChannel
endpoint, execService
 
Fields inherited from interface com.genesyslab.platform.commons.protocol.Receiver
DEF_INPUT_SIZE
 
Fields inherited from interface com.genesyslab.platform.commons.protocol.Channel
DEFAULT_TIMEOUT, INFINITE_TIMEOUT
 
Method Summary
protected  EspEmailProtocol createProtocol()
           
 java.lang.String getClientApplicationType()
          Returns client application type for the Genesys EMail Server connection.
 java.lang.String getClientName()
          Returns client name for the Email Server connection handshake.
 void setClientApplicationType(java.lang.String clientAppType)
          Sets client application type for the Genesys EMail Server connection.
 void setClientName(java.lang.String clientName)
          Sets the Email Server client name for connection handshake procedure.
 
Methods inherited from class com.genesyslab.platform.clusterprotocol.ClusterProtocolImpl
addNodes, addNodes, addNodesEndpoints, addNodesEndpoints, addNodesImpl, beginClose, beginOpen, beginRequest, beginRequest, chooseProtocol, close, closeAsync, configure, createProtocolNode, endRequest, endRequest, getAllNodesProtocols, getConfiguration, getEndpoint, getNextAvailableProtocol, getNextAvailableProtocol, getNodeProtocol, getNodeProtocol, getNodesConfig, getOpenedNodesProtocols, getProtocolDescription, getProtocolId, getReferenceBuilder, getState, onChannelDisconnected, onChannelFailure, onChannelOpened, open, openAsync, policy, removeNodes, removeNodes, request, request, requestAsync, requestAsync, send, setConnectionInvoker, setEndpoint, setInvoker, setNodes, setNodes, setNodesEndpoints, setNodesEndpoints, setNodesImpl, setState, setTimeout, validateEndpoints, validateWSConfigs
 
Methods inherited from class com.genesyslab.platform.clusterprotocol.AbstractClusterChannel
addChannelListener, addListener, clearInput, close, fireClosedEvent, fireClosedInternalChannelEvent, fireErrorEvent, fireErrorEvent, fireOnMessageRecv, fireOnMessageSend, fireOpenedEvent, fireOpenedInternalChannelEvent, getCopyResponse, getInputSize, getInterceptor, getTimeout, open, receive, receive, releaseReceivers, removeChannelListener, removeListener, resetReceiver, setCopyResponse, setInputSize, setMessageHandler, setReceiver, setupProtocolNode, throwNotClosed, throwNotOpened, throwNull, throwOnClosed
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.InputChannel
setMessageHandler
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.MessageReceiver
receive, receive
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.Receiver
clearInput, getInputSize, releaseReceivers, setInputSize
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.OutputChannel
addListener, removeListener
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.RequestChannel
getCopyResponse, setCopyResponse
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.Channel
close, getTimeout, open
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ChannelListenerSupport
addChannelListener, removeChannelListener
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.InterceptorSupport
getInterceptor
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.MessageReceiverManagement
setReceiver
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ReceiverManagement
resetReceiver
 

Method Detail

setClientName

public void setClientName(java.lang.String clientName)
Description copied from interface: EspEmailProtocolHandshakeOptions
Sets the Email Server client name for connection handshake procedure. Usually it represents application name of this Email Server client.

Specified by:
setClientName in interface EspEmailProtocolHandshakeOptions
Parameters:
clientName - client name

getClientName

public java.lang.String getClientName()
Description copied from interface: EspEmailProtocolHandshakeOptions
Returns client name for the Email Server connection handshake. Usually it represents application name of this Email Server client.

Specified by:
getClientName in interface EspEmailProtocolHandshakeOptions
Returns:
client name
See Also:
EspEmailProtocolHandshakeOptions.setClientName(String)

setClientApplicationType

public void setClientApplicationType(java.lang.String clientAppType)
Description copied from interface: EspEmailProtocolHandshakeOptions
Sets client application type for the Genesys EMail Server connection. Usually it represents application type in Configuration Server.

Specified by:
setClientApplicationType in interface EspEmailProtocolHandshakeOptions
Parameters:
clientAppType - client application type

getClientApplicationType

public java.lang.String getClientApplicationType()
Description copied from interface: EspEmailProtocolHandshakeOptions
Returns client application type for the Genesys EMail Server connection. Usually it represents application type in Configuration Server.

Specified by:
getClientApplicationType in interface EspEmailProtocolHandshakeOptions
Returns:
client application type
See Also:
EspEmailProtocolHandshakeOptions.setClientApplicationType(String)

createProtocol

protected EspEmailProtocol createProtocol()
Overrides:
createProtocol in class ClusterProtocolImpl<EspEmailProtocol,EspEmailProtocolBuilder>

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.