AsyncChannel
, AsyncChannelOperations
, AsyncInvokerSupport
, Channel
, ChannelListenerSupport
, ConfigurationSupport
, ConnectionInvokerSupport
, EndpointSupport
, InputChannel
, InterceptorSupport
, LogMessageFilterSupport
, MessageReceiver
, MessageReceiverManagement
, OutputChannel
, Protocol
, ProtocolDescriptionSupport
, Receiver
, ReceiverManagement
, RequestChannel
, RequestorInfoSupport
EspEmailProtocol
, UniversalContactServerProtocol
@Tag(sdkName="OpenMedia", protocolName="ExternalService") public class ExternalServiceProtocol extends ClientChannel implements RequestorInfoSupport
AbstractChannel.AsyncErrorNotifier
ClientChannel.BasicClientHandshakeStep, ClientChannel.ClientHandshakeStep, ClientChannel.RegistrationHandler, ClientChannel.SimpleRegistrationHandler
Modifier and Type | Field | Description |
---|---|---|
static ProtocolDescription |
PROTOCOL_DESCRIPTION |
Protocol signature (sdk and name) for this Channel.
|
protected static java.lang.String |
USE_UTF_FOR_REQUESTS |
DEFAULT_TIMEOUT, INFINITE_TIMEOUT
messageFilter
DEF_INPUT_SIZE
Constructor | Description |
---|---|
ExternalServiceProtocol() |
Creates a new
ExternalServiceProtocol object. |
ExternalServiceProtocol(Endpoint endpoint) |
Creates a new
ExternalServiceProtocol object. |
ExternalServiceProtocol(Endpoint endpoint,
ReferenceBuilder refBuilder) |
Creates a new
ExternalServiceProtocol object. |
Modifier and Type | Method | Description |
---|---|---|
protected void |
doSend(Message message) |
Sends the message unconditionally.
|
protected static void |
fromEspRequestorInfo(KeyValueCollection kvList,
Message message) |
|
RequestorInfo |
getRequestorInfo() |
Returns requestor information
|
KeyValuePrinter |
getTKVPrinter() |
|
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 |
setRequestorInfo(RequestorInfo requestorInfo) |
Sets requestor information
|
void |
setTKVPrinter(KeyValuePrinter printer) |
|
protected static boolean |
toEspRequestorInfo(Message message,
DuplexChannel protocol,
KeyValueCollection kvList) |
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, getProtocolDescription, 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
setMessageHandler
getInterceptor
receive, receive
setReceiver
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addListener, removeListener, send
getProtocolId
getProtocolDescription
clearInput, getInputSize, releaseReceivers, setInputSize
resetReceiver
public static final ProtocolDescription PROTOCOL_DESCRIPTION
protected static final java.lang.String USE_UTF_FOR_REQUESTS
public ExternalServiceProtocol()
ExternalServiceProtocol
object.public ExternalServiceProtocol(Endpoint endpoint)
ExternalServiceProtocol
object.endpoint
- The endpoint (server) you wish to connect to.public ExternalServiceProtocol(Endpoint endpoint, ReferenceBuilder refBuilder)
ExternalServiceProtocol
object.endpoint
- The endpoint (server) you wish to connect to.refBuilder
- External instance of reference builder to be used.public void setTKVPrinter(KeyValuePrinter printer)
public KeyValuePrinter getTKVPrinter()
public RequestorInfo getRequestorInfo()
RequestorInfoSupport
getRequestorInfo
in interface RequestorInfoSupport
public void setRequestorInfo(RequestorInfo requestorInfo)
RequestorInfoSupport
setRequestorInfo
in interface RequestorInfoSupport
protected static boolean toEspRequestorInfo(Message message, DuplexChannel protocol, KeyValueCollection kvList)
protected static void fromEspRequestorInfo(KeyValueCollection kvList, Message message)
protected void doSend(Message message) throws ProtocolException
DuplexChannel
doSend
in class DuplexChannel
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 void onReceiveMessage(Message incom)
DuplexChannel
onReceiveMessage
in class ClientChannel
incom
- received messageSend comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.