Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol
Class ExternalServiceProtocol

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.AbstractChannel
      extended by com.genesyslab.platform.commons.protocol.DuplexChannel
          extended by com.genesyslab.platform.commons.protocol.ClientChannel
              extended by com.genesyslab.platform.openmedia.protocol.ExternalServiceProtocol
All Implemented Interfaces:
AsyncChannel, AsyncChannelOperations, AsyncInvokerSupport, Channel, ChannelListenerSupport, ConfigurationSupport, ConnectionInvokerSupport, EndpointSupport, InputChannel, InterceptorSupport, LogMessageFilterSupport, MessageReceiver, MessageReceiverManagement, OutputChannel, Protocol, ProtocolDescriptionSupport, Receiver, ReceiverManagement, RequestChannel, RequestorInfoSupport
Direct Known Subclasses:
EspEmailProtocol, UniversalContactServerProtocol

@ProtocolDescription.Tag(sdkName="OpenMedia",
                         protocolName="ExternalService")
public class ExternalServiceProtocol
extends ClientChannel
implements RequestorInfoSupport


Nested Class Summary
 
Nested classes/interfaces inherited from class com.genesyslab.platform.commons.protocol.ClientChannel
ClientChannel.BasicClientHandshakeStep, ClientChannel.ClientHandshakeStep, ClientChannel.RegistrationHandler, ClientChannel.SimpleRegistrationHandler
 
Nested classes/interfaces inherited from class com.genesyslab.platform.commons.protocol.AbstractChannel
AbstractChannel.AsyncErrorNotifier
 
Field Summary
static ProtocolDescription PROTOCOL_DESCRIPTION
          Protocol signature (sdk and name) for this Channel.
protected static java.lang.String USE_UTF_FOR_REQUESTS
           
 
Fields inherited from class com.genesyslab.platform.commons.protocol.DuplexChannel
messageFilter
 
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
 
Constructor Summary
ExternalServiceProtocol()
          Creates a new ExternalServiceProtocol object.
ExternalServiceProtocol(Endpoint endpoint)
          Creates a new ExternalServiceProtocol object.
ExternalServiceProtocol(Endpoint endpoint, ReferenceBuilder refBuilder)
          Creates a new ExternalServiceProtocol object.
 
Method Summary
protected static void fromEspRequestorInfo(KeyValueCollection kvList, Message message)
           
 RequestorInfo getRequestorInfo()
          Returns requestor information
 KeyValuePrinter getTKVPrinter()
           
 void setRequestorInfo(RequestorInfo requestorInfo)
          Sets requestor information
 void setTKVPrinter(KeyValuePrinter printer)
           
protected static void toEspRequestorInfo(Message message, DuplexChannel protocol, KeyValueCollection kvList)
           
 
Methods inherited from class com.genesyslab.platform.commons.protocol.ClientChannel
beginClose, beginOpen, beginRequest, close, close, closeAsync, closeAsync, disableConnectionOperations, doBeginRequest, doBeginRequest, doRequest, endRequest, endRequest, fireUnsolicitedEvents, getCopyResponse, getInvoker, getOpenTimeoutException, getReferenceBuilder, onOpen, onReceiveMessage, onSend, onUnexpectedHandshakeMessage, open, openAsync, openAsync, request, request, requestAsync, requestAsync, setAddressResolver, setAddressResolverParams, setAddressResolverParams, setCopyResponse, setEndpoint, setHandshakeFinished, setHandshakePhase, setHandshakeUnsolicitedEventsPassLimit, setRegistrationHandler, setState, submitRegMessage, throwOnUnReferenceableRequest
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DuplexChannel
addListener, applyConfiguration, cancelCloseTimeout, cancelOpenTimeout, clearInput, close, closeAsync, createChannelClosedEvent, createConnection, createConnectionClosedEvent, doBeginClose, doClose, doSend, downgradeConnection, 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
 
Methods inherited from class com.genesyslab.platform.commons.protocol.AbstractChannel
addChannelListener, configure, connectionContext, copyTLSSettings, fireClosed, fireErrorEvent, fireErrorEvent, generateChannelId, getChannelId, getConfiguration, getDefaultInvoker, getEndpoint, getListenerHelper, getServerContext, getState, getStateMods, getTimeout, internal, onSetEndpoint, releaseDefaultInvoker, removeChannelListener, setConfiguration, 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
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.Protocol
getProtocolId
 
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, send
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.Channel
close, getTimeout, open, setTimeout
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.AsyncChannel
getState
 
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
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ConfigurationSupport
configure, getConfiguration
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.EndpointSupport
getEndpoint
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport
getProtocolDescription
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.AsyncInvokerSupport
setInvoker
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ConnectionInvokerSupport
setConnectionInvoker
 

Field Detail

PROTOCOL_DESCRIPTION

public static final ProtocolDescription PROTOCOL_DESCRIPTION
Protocol signature (sdk and name) for this Channel.


USE_UTF_FOR_REQUESTS

protected static final java.lang.String USE_UTF_FOR_REQUESTS
See Also:
Constant Field Values
Constructor Detail

ExternalServiceProtocol

public ExternalServiceProtocol()
Creates a new ExternalServiceProtocol object.


ExternalServiceProtocol

public ExternalServiceProtocol(Endpoint endpoint)
Creates a new ExternalServiceProtocol object.

Parameters:
endpoint - The endpoint (server) you wish to connect to.

ExternalServiceProtocol

public ExternalServiceProtocol(Endpoint endpoint,
                               ReferenceBuilder refBuilder)
Creates a new ExternalServiceProtocol object.

Parameters:
endpoint - The endpoint (server) you wish to connect to.
refBuilder - External instance of reference builder to be used.
Method Detail

setTKVPrinter

public void setTKVPrinter(KeyValuePrinter printer)

getTKVPrinter

public KeyValuePrinter getTKVPrinter()

getRequestorInfo

public RequestorInfo getRequestorInfo()
Description copied from interface: RequestorInfoSupport
Returns requestor information

Specified by:
getRequestorInfo in interface RequestorInfoSupport

setRequestorInfo

public void setRequestorInfo(RequestorInfo requestorInfo)
Description copied from interface: RequestorInfoSupport
Sets requestor information

Specified by:
setRequestorInfo in interface RequestorInfoSupport

toEspRequestorInfo

protected static void toEspRequestorInfo(Message message,
                                         DuplexChannel protocol,
                                         KeyValueCollection kvList)

fromEspRequestorInfo

protected static void fromEspRequestorInfo(KeyValueCollection kvList,
                                           Message message)

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.