org.mbs.services.cup

Interface RemoteControlUnitAdminApplication

public interface RemoteControlUnitAdminApplication

Interface implemented by the user applications for processing callbacks from cu protocol requests. Methods of this interface are called by the system in result of performing user application remote requests through the ControlunitProxy instance created with this object.

See Also:

ControlUnitProxyFactory#createControlUnitProxy

Method Summary

Modifier and Type	Method and Description
void	processControlUnitEvent(CUEvent cuEvent) This method is called to deliver a control unit event.
void	processControlUnitMetaType(java.lang.String requestId, MetaTypeProvider metaTypeProvider, java.lang.Exception error) This method is called to deliver the control unit metatype provided in the target framework for a particular control unit type.
void	processControlUnitTypes(java.lang.String requestId, java.lang.String[][] types_versions, java.lang.Exception error) This method is called to deliver the control unit types provided in the target framework.
void	processCreateControlUnitReply(java.lang.String requestId, java.lang.String cuId, java.lang.Exception error) This method is called to deliver id of a created control unit.
void	processDestroyControlUnitReply(java.lang.String requestId, java.lang.Exception error) This method is called to denote that a request for destruction of control unit is fulfilled.
void	processEventSubscriptionReply(java.lang.String requestId, java.lang.Exception error) This method is called to denote that a request for event subscription is fulfilled.
void	processGetIcon(java.lang.String requestId, java.io.InputStream icon, java.lang.Exception error) This method is called to deliver an icon accessible from the target framework for a particular object class definition of a control unit type's metadata.
void	processHierarchyChanged(HEvent hEvent) This method is called to deliver a hierarchy changed event.
void	processInvokeActionResult(java.lang.String requestId, java.lang.Object invocationResult, java.lang.Exception error) This method is called to deliver the result of action invocation on a particular control unit.
void	processReceiveControlUnits(java.lang.String requestId, ControlUnitInfo[] cunits, java.lang.Exception error) This method is called to deliver a list of control units provided in the target framework.
void	processStateVariableChanged(SVEvent svEvent) This method is called to deliver a state variable event.
void	setProxy(ControlUnitProxy proxy, java.lang.Exception error) Called to provide the user application with ControlUnitPorxy instance in response of ControlUnitProxyFactory.createControlUnitProxy(Connection, RemoteControlUnitAdminApplication, boolean) invocation.

Method Detail

setProxy

void setProxy(ControlUnitProxy proxy,
              java.lang.Exception error)

Called to provide the user application with ControlUnitPorxy instance in response of ControlUnitProxyFactory.createControlUnitProxy(Connection, RemoteControlUnitAdminApplication, boolean) invocation.

Parameters:

proxy - instance of ControlUnitProxy.

error - a possible error occurred on the target framework while initializing the proxy.

processControlUnitTypes

void processControlUnitTypes(java.lang.String requestId,
                             java.lang.String[][] types_versions,
                             java.lang.Exception error)

This method is called to deliver the control unit types provided in the target framework. This response is in result of invoking the ControlUnitProxy.getControlUnitTypes method.

Parameters:

requestId - id of the request. It holds the same value specified as requestId parameter while initiating the request.

types_versions - array of pairs (String[n][2]) holding the control unit types and their versions respectively.

error - possible error occurred on the target framework while interpreting the request.

processControlUnitMetaType

void processControlUnitMetaType(java.lang.String requestId,
                                MetaTypeProvider metaTypeProvider,
                                java.lang.Exception error)

This method is called to deliver the control unit metatype provided in the target framework for a particular control unit type. This response is in result of invoking the ControlUnitProxy.getMetaType method. This method may deliver the control unit metatype either in the form of a MetaTypeProvider object or in the form of xml configuration file. This depends on the initiating request.

Parameters:

requestId - id of the request. It holds the same value specified as requestId parameter while initiating the request.

metaTypeProvider - a MetaTypeProvider object

error - possible error occurred on the target framework while interpreting the request.

processInvokeActionResult

void processInvokeActionResult(java.lang.String requestId,
                               java.lang.Object invocationResult,
                               java.lang.Exception error)

This method is called to deliver the result of action invocation on a particular control unit. This response is in result of invoking the ControlUnitProxy.invokeAction method.

Parameters:

requestId - id of the request. It holds the same value specified as requestId parameter while initiating the request.

invocationResult -

error - possible error occurred on the target framework while interpreting the request.

processCreateControlUnitReply

void processCreateControlUnitReply(java.lang.String requestId,
                                   java.lang.String cuId,
                                   java.lang.Exception error)

This method is called to deliver id of a created control unit. This response is in result of invoking the ControlUnitProxy.createControlUnit method.

Parameters:

requestId - id of the request. It holds the same value specified as requestId parameter while initiating the request.

cuId - the id of the newly created control unit.

error - possible error occurred on the target framework while interpreting the request.

processDestroyControlUnitReply

void processDestroyControlUnitReply(java.lang.String requestId,
                                    java.lang.Exception error)

This method is called to denote that a request for destruction of control unit is fulfilled. This response is in result of invoking the ControlUnitProxy.destroyControlUnit method.

Parameters:

requestId - id of the request. It holds the same value specified as requestId parameter while initiating the request.

error - possible error occurred on the target framework while interpreting the request.

processReceiveControlUnits

void processReceiveControlUnits(java.lang.String requestId,
                                ControlUnitInfo[] cunits,
                                java.lang.Exception error)

This method is called to deliver a list of control units provided in the target framework.

 This response is in result of invoking one of the following methods:the 
 - ControlUnitProxy.getControlUnits 
 - ControlUnitProxy.getSubControlUnits
 - ControlUnitProxy.findControlUnits 
 

Parameters:

requestId - id of the request. It holds the same value specified as requestId parameter while initiating the request.

cunits - array of ControlUnitInfo objects.

error - possible error occurred on the target framework while interpreting the request.

processEventSubscriptionReply

void processEventSubscriptionReply(java.lang.String requestId,
                                   java.lang.Exception error)

This method is called to denote that a request for event subscription is fulfilled. This response is in result of invoking the ControlUnitProxy.subscribe method.

Parameters:

requestId - id of the request. It holds the same value specified as requestId parameter while initiating the request.

error - possible error occurred on the target framework while interpreting the request.

processControlUnitEvent

void processControlUnitEvent(CUEvent cuEvent)

This method is called to deliver a control unit event.

Parameters:

cuEvent - CUEvent holding the event data.

processStateVariableChanged

void processStateVariableChanged(SVEvent svEvent)

This method is called to deliver a state variable event.

Parameters:

svEvent - event objet holding the even data

processHierarchyChanged

void processHierarchyChanged(HEvent hEvent)

This method is called to deliver a hierarchy changed event.

processGetIcon

void processGetIcon(java.lang.String requestId,
                    java.io.InputStream icon,
                    java.lang.Exception error)

This method is called to deliver an icon accessible from the target framework for a particular object class definition of a control unit type's metadata. This response is in result of invoking the getIcon method.

Parameters:

requestId - id of the request. It holds the same value specified as requestId parameter while initiating the request.

icon - InputStream to the icon or null if icon is not available.

error - possible error occurred on the target framework while interpreting the request.