org.instrumentmiddleware.cima.extension.operation.example
Class ExampleOperationPlugin

java.lang.Object
  org.instrumentmiddleware.cima.plugin.impl.AbstractPlugin
      org.instrumentmiddleware.cima.extension.operation.example.ExampleOperationPlugin

All Implemented Interfaces:

ICommandEnable, IPluginOperationExtension, ICIMAPlugin, IPlugin

public class ExampleOperationPlugin
extends AbstractPlugin
implements ICommandEnable, IPluginOperationExtension

An example of plugin that implements IPluginOperationExtension and ICommandEnable

Author:

Romain

Field Summary

protected static java.lang.String

message

Fields inherited from class org.instrumentmiddleware.cima.plugin.impl.AbstractPlugin

startOnLoad, stopped, subscriptions

Constructor Summary

ExampleOperationPlugin(java.lang.String id)

Method Summary

org.w3c.dom.Node	getInformation() Provide access to this plugins information.
org.instrumentmiddleware.cima.parcel.CommandOperationResponseType	processCommandOperation(org.instrumentmiddleware.cima.parcel.CommandType operation, java.util.Calendar creationTime, ISession session, org.instrumentmiddleware.cima.parcel.CommandOperationResponseType response) Process the command.
org.instrumentmiddleware.cima.parcel.PluginOperationResponseType	processGetOperation(org.instrumentmiddleware.cima.parcel.VariableType[] variables, java.util.Calendar creationTime, ISession session, org.instrumentmiddleware.cima.parcel.PluginOperationResponseType response) Gets the given variables value.
org.instrumentmiddleware.cima.parcel.PluginOperationResponseType	processSetOperation(org.instrumentmiddleware.cima.parcel.VariableType[] variables, java.util.Calendar creationTime, ISession session, org.instrumentmiddleware.cima.parcel.PluginOperationResponseType response) Sets the given variables value.

Methods inherited from class org.instrumentmiddleware.cima.plugin.impl.AbstractPlugin

doSubscribe, doSubscribe, getBodyHandler, getId, getSequenceNumber, internalProcessParcel, processParcel, processSubscribeResponse, setStartOnLoad, setSubscriptions, start, startOnLoad, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.instrumentmiddleware.cima.plugin.IPlugin

doSubscribe, getId, getSequenceNumber, processParcel, setStartOnLoad, start, startOnLoad, stop

Methods inherited from interface org.instrumentmiddleware.cima.plugin.IPlugin

doSubscribe, getId, getSequenceNumber, processParcel, setStartOnLoad, start, startOnLoad, stop

Field Detail

message

protected static final java.lang.String message

See Also:

Constant Field Values

Constructor Detail

ExampleOperationPlugin

public ExampleOperationPlugin(java.lang.String id)
                       throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

processCommandOperation

public org.instrumentmiddleware.cima.parcel.CommandOperationResponseType processCommandOperation(org.instrumentmiddleware.cima.parcel.CommandType operation,
                                                                                                 java.util.Calendar creationTime,
                                                                                                 ISession session,
                                                                                                 org.instrumentmiddleware.cima.parcel.CommandOperationResponseType response)

Description copied from interface: ICommandEnable

Process the command. The response returned is a parcel containing the result of the command execution.

Specified by:

processCommandOperation in interface ICommandEnable

Parameters:

operation - The command to process and execute

session - The session this communication belongs to

response - The partly built response

Returns:

a parcel containing the result of the command execution

processGetOperation

public org.instrumentmiddleware.cima.parcel.PluginOperationResponseType processGetOperation(org.instrumentmiddleware.cima.parcel.VariableType[] variables,
                                                                                            java.util.Calendar creationTime,
                                                                                            ISession session,
                                                                                            org.instrumentmiddleware.cima.parcel.PluginOperationResponseType response)

Description copied from interface: IPluginOperationExtension

Gets the given variables value. The result is a parcel containing the value of given variables

Specified by:

processGetOperation in interface IPluginOperationExtension

Parameters:

variables - The variables to get the value from

session - The session this communication belongs to

response - response the partly built response

Returns:

a parcel containing the value of given variables

processSetOperation

public org.instrumentmiddleware.cima.parcel.PluginOperationResponseType processSetOperation(org.instrumentmiddleware.cima.parcel.VariableType[] variables,
                                                                                            java.util.Calendar creationTime,
                                                                                            ISession session,
                                                                                            org.instrumentmiddleware.cima.parcel.PluginOperationResponseType response)

Description copied from interface: IPluginOperationExtension

Sets the given variables value.

Specified by:

processSetOperation in interface IPluginOperationExtension

Parameters:

variables - The variables to be set

session - The session this communication belongs to

response - The partly built response

Returns:

a parcel containing the result of set execution

getInformation

public org.w3c.dom.Node getInformation()

Description copied from interface: IPlugin

Provide access to this plugins information. This is currently represented as a DOM node to allow any XML to be returned to describe the plugin. In practice plugins may choose some well known vocabulary to describe themselves, such as SensorML.

Specified by:

getInformation in interface IPlugin

Overrides:

getInformation in class AbstractPlugin

Returns:

Some XML containing the information for this plugin