cisco.uc.cuae
Class RemoteEtchBridgeServer

java.lang.Object
  etch.bindings.java.support.RemoteBase
      cisco.uc.cuae.RemoteEtchBridge
          cisco.uc.cuae.RemoteEtchBridgeServer

All Implemented Interfaces:

EtchBridge, EtchBridgeServer

public final class RemoteEtchBridgeServer
extends RemoteEtchBridge
implements EtchBridgeServer

Call to message translator for EtchBridgeServer.

Nested Class Summary

class

RemoteEtchBridgeServer._Async Asynchronous implementation of service methods.

Nested classes/interfaces inherited from interface cisco.uc.cuae.EtchBridge

EtchBridge.BridgeException, EtchBridge.ConfigEntry, EtchBridge.EventMessage, EtchBridge.LogLevel, EtchBridge.PluginStatus

Field Summary

RemoteEtchBridgeServer._Async	_async RemoteEtchBridgeServer._Async class instance used to hide asynchronous message implementation.
RemoteEtchBridgeServer._Async	_inner Deprecated.

Constructor Summary

RemoteEtchBridgeServer(etch.bindings.java.support.DeliveryService svc, etch.bindings.java.msg.ValueFactory vf)
Constructs the RemoteEtchBridgeServer.

Method Summary

java.lang.String	addCuaeSession(java.lang.String registrationKey)
EtchBridge.ConfigEntry[]	getConfig(java.lang.String partition) Query application partition configuration items
java.lang.String[]	getPartitions() Query application partitions
void	logWrite(EtchBridge.LogLevel level, java.lang.String msg) CUAE Etch Bridge notify Etch application has been triggered
java.lang.String	registerApplication(java.lang.String appName, java.lang.String partition, java.lang.String userName, java.lang.String password) Register Etch application to CUAE Etch Bridge
java.lang.String	registerPlugin(java.lang.String pluginName, java.lang.String nameSpace, java.lang.String uri, java.lang.String userName, java.lang.String password) Register Etch plugin to CUAE Etch Bridge
void	removeCuaeSession(java.lang.String sessionId) Etch application notify a session instance terminated from the application logic.
void	unregisterApplication(java.lang.String regKey, java.lang.String userName, java.lang.String password) Unregister Etch application from CUAE Etch Bridge
void	unregisterPlugin(java.lang.String regKey, java.lang.String userName, java.lang.String password) Unregister Etch plugin from CUAE Etch Bridge

Methods inherited from class etch.bindings.java.support.RemoteBase

_begincall, _endcall, _newMessage, _send, _start, _startAndWaitUp, _stop, _stopAndWaitDown, _transportControl, _transportNotify, _transportQuery, _waitDown, _waitUp, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_async

public final RemoteEtchBridgeServer._Async _async

RemoteEtchBridgeServer._Async class instance used to hide asynchronous message implementation. Use this to invoke the asynchronous message implementations.

_inner

@Deprecated
public final RemoteEtchBridgeServer._Async _inner

Deprecated.

RemoteEtchBridgeServer._Async class instance used to hide asynchronous message implementation. This is here for backwards compatibility only, use _async instead.

Constructor Detail

RemoteEtchBridgeServer

public RemoteEtchBridgeServer(etch.bindings.java.support.DeliveryService svc,
                              etch.bindings.java.msg.ValueFactory vf)

Constructs the RemoteEtchBridgeServer.

Parameters:

svc -

vf -

Method Detail

logWrite

public final void logWrite(EtchBridge.LogLevel level,
                           java.lang.String msg)

Description copied from interface: EtchBridgeServer

CUAE Etch Bridge notify Etch application has been triggered

Specified by:

logWrite in interface EtchBridgeServer

Parameters:

level - Log level of this logging statement

msg - Log message to write

registerApplication

public final java.lang.String registerApplication(java.lang.String appName,
                                                  java.lang.String partition,
                                                  java.lang.String userName,
                                                  java.lang.String password)
                                           throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Register Etch application to CUAE Etch Bridge

Specified by:

registerApplication in interface EtchBridgeServer

Parameters:

appName - Application name

partition - Application partition name

userName - User name

password - Password

Returns:

unique registration key

Throws:

EtchBridge.BridgeException

unregisterApplication

public final void unregisterApplication(java.lang.String regKey,
                                        java.lang.String userName,
                                        java.lang.String password)
                                 throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Unregister Etch application from CUAE Etch Bridge

Specified by:

unregisterApplication in interface EtchBridgeServer

Parameters:

regKey - Key returned from registerApplication

userName - User name

password - Password

Throws:

EtchBridge.BridgeException

addCuaeSession

public final java.lang.String addCuaeSession(java.lang.String registrationKey)
                                      throws EtchBridge.BridgeException

Specified by:

addCuaeSession in interface EtchBridgeServer

Throws:

EtchBridge.BridgeException

removeCuaeSession

public final void removeCuaeSession(java.lang.String sessionId)

Description copied from interface: EtchBridgeServer

Etch application notify a session instance terminated from the application logic. This is similar to the legacy EndScript action in CUAE.

Specified by:

removeCuaeSession in interface EtchBridgeServer

Parameters:

sessionId - Session identifier, similar to RoutingGuid in CUAE

getPartitions

public final java.lang.String[] getPartitions()
                                       throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Query application partitions

Specified by:

getPartitions in interface EtchBridgeServer

Returns:

array of partition names of this application

Throws:

EtchBridge.BridgeException

getConfig

public final EtchBridge.ConfigEntry[] getConfig(java.lang.String partition)
                                         throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Query application partition configuration items

Specified by:

getConfig in interface EtchBridgeServer

Parameters:

partition - name

Returns:

array of configuration items for this partition

Throws:

EtchBridge.BridgeException

registerPlugin

public final java.lang.String registerPlugin(java.lang.String pluginName,
                                             java.lang.String nameSpace,
                                             java.lang.String uri,
                                             java.lang.String userName,
                                             java.lang.String password)
                                      throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Register Etch plugin to CUAE Etch Bridge

Specified by:

registerPlugin in interface EtchBridgeServer

Parameters:

pluginName - Friendly plugin name

nameSpace - The full namespace which combines module name and service name defined in Etch IDL

uri - The listener uri for client to connect to

userName - User Name

password - Password

Returns:

unique registration key

Throws:

EtchBridge.BridgeException

unregisterPlugin

public final void unregisterPlugin(java.lang.String regKey,
                                   java.lang.String userName,
                                   java.lang.String password)
                            throws EtchBridge.BridgeException

Description copied from interface: EtchBridgeServer

Unregister Etch plugin from CUAE Etch Bridge

Specified by:

unregisterPlugin in interface EtchBridgeServer

Parameters:

regKey - Key returned from registerPlugin

userName - User name

password - Password

Throws:

EtchBridge.BridgeException