si.ijs.acs.objectexplorer.engine

Class Invocation

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

si.ijs.acs.objectexplorer.OETreeNode

si.ijs.acs.objectexplorer.engine.Invocation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode, SimpleIntrospectable

Direct Known Subclasses:

BACIInvocation

public abstract class Invocation
extends OETreeNode
implements SimpleIntrospectable

This type denotes a transient process that has been created as a side-effect of the remote call on the remote machine. Usually Invocations are created when asynchronous methods are called (ie. methods that take callback parameters, or methods that implement the publisher / subscriber pattern). Invocation is a transient tree node object. It is contained by the object that owned the operation which created the invocation. Invocations must be destroyed as a side-effect of the container destruction. If the method isControllable() returns false the GUI need not add the node to the tree and must not use this object as an Introspectable - i.e. must not query for operations, attributes, invoke operations etc.

See Also:

Serialized Form

Field Summary

Fields inherited from class si.ijs.acs.objectexplorer.OETreeNode

childrenHolder

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

Constructors

Constructor and Description
Invocation(short type, java.lang.String name, RemoteCall data, RemoteResponseCallback cb, OETree tree) Constructs a new instance of invocation object.

Method Summary

Modifier and Type	Method and Description
void	destroy() If the invocation is controllable, this method is called after the node representing the invocation is removed from the tree.
RemoteResponseCallback	getCallback() Returns a callback object associated with this invocation.
RemoteCall	getInvocationRequest() Returns the remote call data structure which identifies the asynchronous remote call that caused this invocation to start on the remote machine.
abstract boolean	isControllable() Returns true iff this invocation instance represents a remote process that is controllable through a remote object (such as a subscription or monitor object).
boolean	isDestroyed() Returns true if this controllable invocation has already been destroyed.
boolean	isDestroyRequested() Request destruction.
void	requestDestroy() Request destruction.

Methods inherited from class si.ijs.acs.objectexplorer.OETreeNode

areChildrenDefined, compareTo, getChildCount, getIcon, getName, getNodeType, getParentTree, isIntrospectable, isLeaf, setChildrenDefined, setParentTree, toString

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface si.ijs.acs.objectexplorer.engine.SimpleIntrospectable

getAttributes, getName, getOperations

Constructor Detail

Invocation

public Invocation(short type,
                  java.lang.String name,
                  RemoteCall data,
                  RemoteResponseCallback cb,
                  OETree tree)

Constructs a new instance of invocation object.

Parameters:

type - used internally by OE and engine to specify node types. Types are defined by the engine and left unchanged by OE.

name - name of the invocation transient object, used by GUI display

data - data determined by the engine that is stored in the invocation node, can be null at construction time if the value is provided later

cb - RemoteResponseCallback object associated with this invocation. This object will deliver asynchronous responses to the GUI.

tree - tree that will be the node container

Method Detail

destroy

public void destroy()

If the invocation is controllable, this method is called after the node representing the invocation is removed from the tree. Sets the destroyed flag to true.

requestDestroy

public void requestDestroy()

Request destruction.

isDestroyRequested

public boolean isDestroyRequested()

Request destruction.

getCallback

public RemoteResponseCallback getCallback()

Returns a callback object associated with this invocation. Callback is the object which receives asynchronous responses for the server. GUI is responsible for instantiating callbacks and passing them to the invokeAsync() method of the Operation instance, which, in response, instantiates this invocation object.

Returns:

callback that delivers data for this invocation

getInvocationRequest

public RemoteCall getInvocationRequest()

Returns the remote call data structure which identifies the asynchronous remote call that caused this invocation to start on the remote machine.

Returns:

call that initiated this invocation

isControllable

public abstract boolean isControllable()

Returns true iff this invocation instance represents a remote process that is controllable through a remote object (such as a subscription or monitor object). Only if this method returns true, can invocation be used as introspectable, i.e. can have its methods queried, invoked etc. Otherwise the GUI should not interpret this invocation as a tree node and need not display it at all.

Returns:

boolean true if the remote process can be controlled through a remote object, represented by the SimpleIntrospectable interface which this invocation implements

isDestroyed

public boolean isDestroyed()

Returns true if this controllable invocation has already been destroyed.

Returns:

boolean destroy flag