cisco.uc.cuae
Class BaseEtchBridgeServer

java.lang.Object
  cisco.uc.cuae.BaseEtchBridgeServer

All Implemented Interfaces:

EtchBridge, EtchBridgeServer, etch.bindings.java.support.ObjSession

public class BaseEtchBridgeServer
extends java.lang.Object
implements EtchBridgeServer, etch.bindings.java.support.ObjSession

Base implementation of EtchBridgeServer, with default method implementations which throw UnsupportedOperationException. Extend this class to provide implementations of messages from the client.

See Also:

ImplEtchBridgeServer

Nested Class Summary

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

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

Constructor Summary

BaseEtchBridgeServer()

Method Summary

void	_sessionControl(java.lang.Object control, java.lang.Object value)
void	_sessionNotify(java.lang.Object event)
java.lang.Object	_sessionQuery(java.lang.Object query)
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 java.lang.Object

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

Constructor Detail

BaseEtchBridgeServer

public BaseEtchBridgeServer()

Method Detail

_sessionQuery

public java.lang.Object _sessionQuery(java.lang.Object query)
                               throws java.lang.Exception

Specified by:

_sessionQuery in interface etch.bindings.java.support.ObjSession

Throws:

java.lang.Exception

_sessionControl

public void _sessionControl(java.lang.Object control,
                            java.lang.Object value)
                     throws java.lang.Exception

Specified by:

_sessionControl in interface etch.bindings.java.support.ObjSession

Throws:

java.lang.Exception

_sessionNotify

public void _sessionNotify(java.lang.Object event)
                    throws java.lang.Exception

Specified by:

_sessionNotify in interface etch.bindings.java.support.ObjSession

Throws:

java.lang.Exception

logWrite

public 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 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 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 java.lang.String addCuaeSession(java.lang.String registrationKey)
                                throws EtchBridge.BridgeException

Specified by:

addCuaeSession in interface EtchBridgeServer

Throws:

EtchBridge.BridgeException

removeCuaeSession

public 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 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 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 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 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