Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.server
Class UniversalContactServerClientChannelHandler

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.ClientChannelHandler
              extended by com.genesyslab.platform.contacts.protocol.server.UniversalContactServerClientChannelHandler
All Implemented Interfaces:
AsyncChannel, AsyncChannelOperations, AsyncInvokerSupport, Channel, ChannelListenerSupport, ConfigurationSupport, ConnectionInvokerSupport, EndpointSupport, InputChannel, InterceptorSupport, LogMessageFilterSupport, MessageReceiver, MessageReceiverManagement, OutputChannel, ProtocolDescriptionSupport, Receiver, ReceiverManagement, UniversalContactServerProtocolHandshakeOptions

public class UniversalContactServerClientChannelHandler
extends ClientChannelHandler
implements UniversalContactServerProtocolHandshakeOptions

Universal Contact Server protocol internal ClientChannelHandler.
Note: This class is internal and is not supposed for explicit usage by applications.

See Also:
ContactServerProtocolListener

Nested Class Summary
 
Nested classes/interfaces inherited from class com.genesyslab.platform.commons.protocol.AbstractChannel
AbstractChannel.AsyncErrorNotifier
 
Field Summary
 
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
protected UniversalContactServerClientChannelHandler(Connection connection, ConnectionConfiguration config)
           
 
Method Summary
protected  void applyConfiguration()
           
protected  void doSend(Message message)
          Sends the message unconditionally.
 java.lang.String getClientApplicationType()
          Returns client application type for the Universal Contact Server connection.
 java.lang.String getClientName()
          Returns client name for the Universal Contact 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 Universal Contact Server connection.
 void setClientName(java.lang.String clientName)
          Sets the Universal Contact Server client name for connection handshake procedure.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DuplexChannel
addListener, 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
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.Channel
getTimeout, setTimeout
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.AsyncChannel
getState
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ChannelListenerSupport
addChannelListener, removeChannelListener
 

Constructor Detail

UniversalContactServerClientChannelHandler

protected UniversalContactServerClientChannelHandler(Connection connection,
                                                     ConnectionConfiguration config)
Method Detail

getClientName

public java.lang.String getClientName()
Returns client name for the Universal Contact Server connection handshake. Usually it represents application name of this Universal Contact Server client.

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

setClientName

public void setClientName(java.lang.String clientName)
Sets the Universal Contact Server client name for connection handshake procedure. Usually it represents application name of this Universal Contact Server client.

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

getClientApplicationType

public java.lang.String getClientApplicationType()
Returns client application type for the Universal Contact Server connection. Usually it represents application type in Configuration Server.

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

setClientApplicationType

public void setClientApplicationType(java.lang.String clientAppType)
Sets client application type for the Universal Contact Server connection. Usually it represents application type in Configuration Server.

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

getProtocolDescription

public ProtocolDescription getProtocolDescription()
Specified by:
getProtocolDescription in interface ProtocolDescriptionSupport
Overrides:
getProtocolDescription in class DuplexChannel

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.

applyConfiguration

protected void applyConfiguration()
Overrides:
applyConfiguration in class DuplexChannel

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.