AsyncChannel
, AsyncChannelOperations
, AsyncInvokerSupport
, Channel
, ChannelListenerSupport
, ConfigurationSupport
, ConnectionInvokerSupport
, EndpointSupport
, InputChannel
, InterceptorSupport
, LogMessageFilterSupport
, MessageReceiver
, MessageReceiverManagement
, OutputChannel
, Protocol
, ProtocolDescriptionSupport
, Receiver
, ReceiverManagement
, RequestChannel
, RequestorInfoSupport
, EspEmailProtocolHandshakeOptions
@Tag(sdkName="WebMedia", protocolName="EspEmail") public class EspEmailProtocol extends ExternalServiceProtocol implements EspEmailProtocolHandshakeOptions
EspEmailProtocol
object to establish
communication between client application and ESP based Email Server.AbstractChannel.AsyncErrorNotifier
ClientChannel.BasicClientHandshakeStep, ClientChannel.ClientHandshakeStep, ClientChannel.RegistrationHandler, ClientChannel.SimpleRegistrationHandler
Modifier and Type | Field | Description |
---|---|---|
static ProtocolDescription |
PROTOCOL_DESCRIPTION |
DEFAULT_TIMEOUT, INFINITE_TIMEOUT
messageFilter
USE_UTF_FOR_REQUESTS
DEF_INPUT_SIZE
Constructor | Description |
---|---|
EspEmailProtocol() |
Creates a new instance of the ESP based
Genesys EmailServer protocol client.
|
EspEmailProtocol(Endpoint endpoint) |
Creates a new instance of the ESP based
Genesys EmailServer protocol client.
|
EspEmailProtocol(Endpoint endpoint,
ReferenceBuilder refBuilder) |
Creates a new instance of the ESP based
Genesys EmailServer protocol client.
|
Modifier and Type | Method | Description |
---|---|---|
void |
doSend(Message message) |
Sends the message unconditionally.
|
protected static Message |
fromEsp(DuplexChannel channel,
Message esp) |
|
protected Message |
fromEsp(Message esp) |
|
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 message) |
Gives to subclass a chance to perform some operations on incoming
message arrival before delivering it to connection user code.
|
protected static Message |
processEvent(DuplexChannel channel,
Message msg,
ILogger log) |
|
protected Message |
processEvent(Message msg) |
|
protected static Message |
processSentMesage(DuplexChannel channel,
Message message,
ReferenceBuilder referenceBuilder) |
|
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.
|
protected static Message |
toEsp(DuplexChannel channel,
Message msg) |
|
protected Message |
toEsp(Message msg) |
addChannelListener, configure, connectionContext, copyTLSSettings, fireClosed, fireErrorEvent, fireErrorEvent, generateChannelId, getChannelId, getConfiguration, getDefaultInvoker, getEndpoint, getListenerHelper, getServerContext, getState, getStateMods, getTimeout, getTimer, internal, onSetEndpoint, releaseDefaultInvoker, removeChannelListener, setConfiguration, setInvoker, setServerContext, setState, setTimeout, throwNotClosed, throwNotOpened, throwNotOpenedOnClose, throwNotOpenedOnSend, throwNull, throwNullEndpoint
getState
setInvoker
close, getTimeout, open, setTimeout
addChannelListener, removeChannelListener
beginClose, beginOpen, beginRequest, close, close, closeAsync, closeAsync, disableConnectionOperations, doBeginRequest, doBeginRequest, doRequest, endRequest, endRequest, fireUnsolicitedEvents, getCopyResponse, getInvoker, getOpenTimeoutException, getReferenceBuilder, onOpen, onSend, onUnexpectedHandshakeMessage, open, openAsync, openAsync, request, request, requestAsync, requestAsync, setAddressResolver, setAddressResolverParams, setAddressResolverParams, setCopyResponse, setEndpoint, setHandshakeFinished, setHandshakePhase, setHandshakeUnsolicitedEventsPassLimit, setRegistrationHandler, setState, submitRegMessage, throwOnUnReferenceableRequest
configure, getConfiguration
setConnectionInvoker
addListener, applyConfiguration, cancelCloseTimeout, cancelOpenTimeout, clearInput, close, closeAsync, createChannelClosedEvent, createConnection, createConnectionClosedEvent, doBeginClose, doClose, downgradeConnection, getConnectionClosedCause, getDefaultRestriction, getEnpointPrefixInfo, getInputSize, getInterceptor, getLocalEndPoint, getLocalEndpointInfo, getLogMessageFilter, getProtocolFactory, getProtocolId, getRemoteEndPoint, getTimeoutException, initPackager, isMessageAllowed, notifyWithObject, onClose, onFireClosed, onFireErrorEvent, onFireOpened, open, openAsync, openAsync, processClose, processCloseAll, receive, receive, receivedMessage, releaseReceivers, removeListener, resetReceiver, resumeReading, send, setConnectionInvoker, setExternalTransport, setInputSize, setLogMessageFilter, setMessageHandler, setProtocolData, setReceiver, startUpgradeConnection, stopReading, toString, triggerWithObject, upgradeConnection, waitForObject, wrapInProtocolException
getEndpoint
fromEspRequestorInfo, getRequestorInfo, getTKVPrinter, setRequestorInfo, setTKVPrinter, toEspRequestorInfo
setMessageHandler
getInterceptor
receive, receive
setReceiver
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addListener, removeListener, send
getProtocolId
clearInput, getInputSize, releaseReceivers, setInputSize
resetReceiver
public static final ProtocolDescription PROTOCOL_DESCRIPTION
public EspEmailProtocol()
public EspEmailProtocol(Endpoint endpoint)
endpoint
- the server endpoint you wish to connect to.public EspEmailProtocol(Endpoint endpoint, ReferenceBuilder refBuilder)
endpoint
- the server endpoint you wish to connect to.refBuilder
- external reference builder instance.public ProtocolDescription getProtocolDescription()
getProtocolDescription
in interface ProtocolDescriptionSupport
getProtocolDescription
in class DuplexChannel
protected static Message processSentMesage(DuplexChannel channel, Message message, ReferenceBuilder referenceBuilder) throws ProtocolException
ProtocolException
public void doSend(Message message) throws ProtocolException
DuplexChannel
doSend
in class ExternalServiceProtocol
message
- message to sendProtocolException
- 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.protected static Message processEvent(DuplexChannel channel, Message msg, ILogger log)
protected void onReceiveMessage(Message message)
DuplexChannel
onReceiveMessage
in class ExternalServiceProtocol
message
- received messagepublic void setClientName(java.lang.String clientName)
setClientName
in interface EspEmailProtocolHandshakeOptions
clientName
- client namepublic java.lang.String getClientName()
getClientName
in interface EspEmailProtocolHandshakeOptions
setClientName(String)
public java.lang.String getClientApplicationType()
getClientApplicationType
in interface EspEmailProtocolHandshakeOptions
setClientApplicationType(String)
public void setClientApplicationType(java.lang.String clientAppType)
setClientApplicationType
in interface EspEmailProtocolHandshakeOptions
clientAppType
- client application typeprotected static Message fromEsp(DuplexChannel channel, Message esp)
protected static Message toEsp(DuplexChannel channel, Message msg)
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.