com.genesyslab.platform.webmedia.protocol.server
Class EspEmailClientChannelHandler
java.lang.Object
com.genesyslab.platform.commons.protocol.AbstractChannel
com.genesyslab.platform.commons.protocol.DuplexChannel
com.genesyslab.platform.commons.protocol.ClientChannelHandler
com.genesyslab.platform.webmedia.protocol.server.EspEmailClientChannelHandler
- All Implemented Interfaces:
- AsyncChannel, AsyncChannelOperations, AsyncInvokerSupport, Channel, ChannelListenerSupport, ConfigurationSupport, ConnectionInvokerSupport, EndpointSupport, InputChannel, InterceptorSupport, LogMessageFilterSupport, MessageReceiver, MessageReceiverManagement, OutputChannel, ProtocolDescriptionSupport, Receiver, ReceiverManagement, EspEmailProtocolHandshakeOptions
public class EspEmailClientChannelHandler
- extends ClientChannelHandler
- implements EspEmailProtocolHandshakeOptions
Created by vgarmash on 23.11.2016.
Method Summary |
protected void |
doSend(Message message)
Sends the message unconditionally. |
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. |
ProtocolDescription |
getProtocolDescription()
|
protected void |
onReceiveMessage(Message incom)
Gives to subclass a chance to perform some operations on incoming
message arrival before delivering it to connection user code. |
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.commons.protocol.DuplexChannel |
addListener, applyConfiguration, beginClose, beginOpen, cancelCloseTimeout, cancelOpenTimeout, clearInput, close, close, close, closeAsync, closeAsync, closeAsync, createChannelClosedEvent, createConnection, createConnectionClosedEvent, doBeginClose, doClose, downgradeConnection, getDefaultRestriction, getEnpointPrefixInfo, getInputSize, getInterceptor, getLocalEndPoint, getLocalEndpointInfo, getLogMessageFilter, getOpenTimeoutException, getProtocolFactory, getProtocolId, getRemoteEndPoint, getTimeoutException, initPackager, isMessageAllowed, notifyWithObject, onClose, onFireClosed, onFireErrorEvent, onFireOpened, onOpen, onSend, open, open, openAsync, openAsync, openAsync, openAsync, processClose, processCloseAll, receive, receive, receivedMessage, releaseReceivers, removeListener, resetReceiver, resumeReading, send, setConnectionInvoker, setExternalTransport, setInputSize, setLogMessageFilter, setMessageHandler, setProtocolData, setReceiver, setState, startUpgradeConnection, stopReading, toString, triggerWithObject, upgradeConnection, waitForObject |
Methods inherited from class com.genesyslab.platform.commons.protocol.AbstractChannel |
addChannelListener, configure, connectionContext, copyTLSSettings, fireClosed, fireErrorEvent, fireErrorEvent, generateChannelId, getChannelId, getConfiguration, getDefaultInvoker, getEndpoint, getInvoker, getListenerHelper, getServerContext, getState, getStateMods, getTimeout, internal, onSetEndpoint, releaseDefaultInvoker, removeChannelListener, setConfiguration, setEndpoint, setInvoker, setServerContext, setState, setTimeout, throwNotClosed, throwNotOpened, throwNotOpenedOnClose, throwNotOpenedOnSend, throwNull, throwNullEndpoint |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
EspEmailClientChannelHandler
public EspEmailClientChannelHandler(Connection connection,
ConnectionConfiguration config)
getProtocolDescription
public ProtocolDescription getProtocolDescription()
- Specified by:
getProtocolDescription
in interface ProtocolDescriptionSupport
- Overrides:
getProtocolDescription
in class DuplexChannel
setClientName
public void setClientName(java.lang.String clientName)
- 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()
- 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:
setClientName(String)
getClientApplicationType
public java.lang.String getClientApplicationType()
- 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:
setClientApplicationType(String)
setClientApplicationType
public void setClientApplicationType(java.lang.String clientAppType)
- 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
onReceiveMessage
protected void onReceiveMessage(Message incom)
- Description copied from class:
DuplexChannel
- Gives to subclass a chance to perform some operations on incoming
message arrival before delivering it to connection user code.
We don't use AsyncInvoker here, because the message handling
in this class probably doesn't worth it - this method is quick and
shouldn't load connection thread too much. But if this method is
overridden in some classes and contains some long-running logic,
consider using AsyncInvoker
- Overrides:
onReceiveMessage
in class DuplexChannel
- Parameters:
incom
- received message
doSend
protected void doSend(Message message)
throws ProtocolException
- Description copied from class:
DuplexChannel
- Sends the message unconditionally. Doesn't check channel state.
Use with caution. Intended for using in registration process.
- Overrides:
doSend
in class DuplexChannel
- Parameters:
message
- message to send
- Throws:
ProtocolException
- In the case of an unrecoverable protocol error. Client applications should not
try to deal with these exceptions, except for logging or displaying to users or technical administrators.
Check the exception cause for more details.
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.