AsyncChannel
, AsyncChannelOperations
, AsyncInvokerSupport
, Channel
, ChannelListenerSupport
, ConfigurationSupport
, ConnectionInvokerSupport
, EndpointSupport
, InputChannel
, InterceptorSupport
, LogMessageFilterSupport
, MessageReceiver
, MessageReceiverManagement
, OutputChannel
, Protocol
, ProtocolDescriptionSupport
, Receiver
, ReceiverManagement
, RequestChannel
, OutboundServerProtocolHandshakeOptions
@Tag(sdkName="Outbound", protocolName="OutboundServer") public class OutboundServerProtocol extends ClientChannel implements OutboundServerProtocolHandshakeOptions
OutboundServerProtocol
object to establish
communication between a client application and Outbound Server.
Here is a sample of how to establish communication with Outbound Server:
OutboundServerProtocol outboundServerProtocol =
new OutboundServerProtocol(
new Endpoint(
outboundServerEPName,
host,
port));
outboundServerProtocol.setClientName(clientName);
outboundServerProtocol.setClientPassword(clientPwd);
outboundServerProtocol.setUserName(userName);
outboundServerProtocol.setUserPassword(userPwd);
outboundServerProtocol.open();
When you are finished communicating with the server, you can close the
channel like this:
outboundServerProtocol.close();
Note: Starting from Platform SDK 8.5.0 version, main protocol channel classes
(including OutboundServerProtocol
) are no longer "final
".AbstractChannel.AsyncErrorNotifier
ClientChannel.BasicClientHandshakeStep, ClientChannel.ClientHandshakeStep, ClientChannel.RegistrationHandler, ClientChannel.SimpleRegistrationHandler
DEFAULT_TIMEOUT, INFINITE_TIMEOUT
messageFilter
DEF_INPUT_SIZE
Constructor | Description |
---|---|
OutboundServerProtocol() |
Creates instance of OutboundServerProtocol.
|
OutboundServerProtocol(Endpoint endpoint) |
Creates instance of OutboundServerProtocol.
|
OutboundServerProtocol(Endpoint endpoint,
long timeout) |
Creates instance of OutboundServerProtocol.
|
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getClientName() |
Returns the Outbound Server client name for connection handshake procedure.
|
java.lang.String |
getClientPassword() |
Returns optional client application password.
|
protected com.genesyslab.platform.commons.protocol.runtime.license.LicenseRestriction |
getDefaultRestriction() |
Returns default restriction for protocol.
|
java.lang.String |
getUserName() |
Returns user name property for the Outbound Server connection.
|
java.lang.String |
getUserPassword() |
Returns user password property for the Outbound Server connection.
|
protected void |
onOpen() |
This method is called when channel is opened and just about
to call event handler.
|
void |
setClientName(java.lang.String clientName) |
Sets the Outbound Server client name for connection handshake procedure.
|
void |
setClientPassword(java.lang.String clientPassword) |
Sets optional client application password.
|
void |
setUserName(java.lang.String userName) |
Sets user name property for the Outbound Server connection.
|
void |
setUserPassword(java.lang.String userPassword) |
Sets user password property for the Outbound Server connection.
|
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, onReceiveMessage, 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, doSend, downgradeConnection, getConnectionClosedCause, 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 OutboundServerProtocol()
public OutboundServerProtocol(Endpoint endpoint)
endpoint
- Parameters of the connection to createpublic OutboundServerProtocol(Endpoint endpoint, long timeout)
endpoint
- Parameters of the connection to createtimeout
- Timeout to wait for message (in milliseconds)protected com.genesyslab.platform.commons.protocol.runtime.license.LicenseRestriction getDefaultRestriction()
DuplexChannel
getDefaultRestriction
in class DuplexChannel
public java.lang.String getClientName()
getClientName
in interface OutboundServerProtocolHandshakeOptions
setClientName(String)
public void setClientName(java.lang.String clientName)
setClientName
in interface OutboundServerProtocolHandshakeOptions
clientName
- client namepublic java.lang.String getClientPassword()
getClientPassword
in interface OutboundServerProtocolHandshakeOptions
setClientPassword(String)
public void setClientPassword(java.lang.String clientPassword)
setClientPassword
in interface OutboundServerProtocolHandshakeOptions
clientPassword
- application passwordpublic java.lang.String getUserName()
getUserName
in interface OutboundServerProtocolHandshakeOptions
setUserName(String)
public void setUserName(java.lang.String userName)
setUserName
in interface OutboundServerProtocolHandshakeOptions
userName
- user namepublic java.lang.String getUserPassword()
getUserPassword
in interface OutboundServerProtocolHandshakeOptions
setUserPassword(String)
public void setUserPassword(java.lang.String userPassword)
setUserPassword
in interface OutboundServerProtocolHandshakeOptions
userPassword
- user passwordprotected void onOpen() throws ProtocolException
DuplexChannel
onOpen
in class ClientChannel
ProtocolException
- if there are problems during
post open operations (e.g. registration)Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.