info.pppc.base.system

Class Invocation

java.lang.Object

info.pppc.base.system.Invocation

All Implemented Interfaces:

ISerializable

public final class Invocation
extends java.lang.Object
implements ISerializable

Implementation of an invocation that is used for data exchange between local and remote objects. Note that the semantic of the type field of the invocation can be defined by semantic plug-ins. However, note that all types below 1024 are reserved for the broker, values above 1024 can be user defined.

Author:

Marcus Handte

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ABBREVIATION The abbreviation used for this class during serialization.
static short	TYPE_INVOKE Constant value that indicates that the invocation carries a remote call that must be performed.
static short	TYPE_REMOVE Constant value that indicates that the invocation result on the receiver side of an invoke method can be cleared.
static short	TYPE_RESULT Constant value that indicates that the invocation carries a result that must be delivered.
static short	TYPE_UNDEFINED Constant value that indicates the initial type when a invocation is created.

Constructor Summary

Constructors

Constructor and Description
Invocation() Creates a new invocation.
Invocation(ReferenceID source, ReferenceID target, java.lang.String method, java.lang.Object[] args) Creates a new invocation with the specified source, target, method and arguments.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object[]	getArguments() Returns the method's arguments.
java.lang.Throwable	getException() Returns the exception state of this method.
java.lang.Integer	getID() Returns the id of the invocation.
NFCollection	getRequirements() Returns the nonfunctional requirements associated with this invocation.
java.lang.Object	getResult() Returns the return value of the method call.
java.lang.String	getSignature() Returns the signature of the method.
ReferenceID	getSource() Returns the source of the invocation.
ReferenceID	getTarget() Returns the target of the invocation.
short	getType() Returns the message type.
void	readObject(IObjectInput stream) Deserializes the invocation from the given stream.
void	setArguments(java.lang.Object[] arguments) Sets the method arguments of the invocation.
void	setException(java.lang.Throwable exception) Sets the exception of the invocation.
void	setID(java.lang.Integer id) Sets the id of the invocation.
void	setRequirements(NFCollection collection) Associates nonfunctional requirements with this invocation.
void	setResult(java.lang.Object result) Sets the result of the invocation.
void	setSignature(java.lang.String signature) Sets the signature of the method.
void	setSource(ReferenceID source) Sets the invocation's source.
void	setTarget(ReferenceID target) Sets the invocation's target.
void	setType(short type) Sets the type of the invocation.
java.lang.String	toString() Returns a string representation of this invocation.
void	writeObject(IObjectOutput stream) Serializes the invocation to the given stream.

Methods inherited from class java.lang.Object

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

Field Detail

ABBREVIATION

public static final java.lang.String ABBREVIATION

The abbreviation used for this class during serialization.

See Also:

Constant Field Values

TYPE_UNDEFINED

public static final short TYPE_UNDEFINED

Constant value that indicates the initial type when a invocation is created.

See Also:

Constant Field Values

TYPE_INVOKE

public static final short TYPE_INVOKE

Constant value that indicates that the invocation carries a remote call that must be performed.

See Also:

Constant Field Values

TYPE_RESULT

public static final short TYPE_RESULT

Constant value that indicates that the invocation carries a result that must be delivered.

See Also:

Constant Field Values

TYPE_REMOVE

public static final short TYPE_REMOVE

Constant value that indicates that the invocation result on the receiver side of an invoke method can be cleared.

See Also:

Constant Field Values

Constructor Detail

Invocation

public Invocation()

Creates a new invocation. This method should only be used for deserialization purposes.

Invocation

public Invocation(ReferenceID source,
          ReferenceID target,
          java.lang.String method,
          java.lang.Object[] args)

Creates a new invocation with the specified source, target, method and arguments.

Parameters:

source - The source object.

target - The target object.

method - The method signature.

args - The method arguments.

Method Detail

getID

public java.lang.Integer getID()

Returns the id of the invocation. This id is created by the kernel on the source system.

Returns:

The invocation's id.

getArguments

public java.lang.Object[] getArguments()

Returns the method's arguments.

Returns:

The method's arguments.

getResult

public java.lang.Object getResult()

Returns the return value of the method call.

Returns:

The return value of the method call.

getSignature

public java.lang.String getSignature()

Returns the signature of the method.

Returns:

The signature of the method.

getSource

public ReferenceID getSource()

Returns the source of the invocation.

Returns:

The invocation's source.

getTarget

public ReferenceID getTarget()

Returns the target of the invocation.

Returns:

The invocation's target.

getType

public short getType()

Returns the message type.

Returns:

The messages type.

getException

public java.lang.Throwable getException()

Returns the exception state of this method.

Returns:

Null if no exception has been thrown, otherwise the exception.

getRequirements

public NFCollection getRequirements()

Returns the nonfunctional requirements associated with this invocation. The non-functional requirements are used by the selection strategy to determine the plug-in that should be used to perform the next transformation step. It is possible and valid to modify the requirements during the call. I.e. higher layers might remove, add or modify non-functional requirements.

Returns:

The non-functional requirements of the invocation.

setID

public void setID(java.lang.Integer id)

Sets the id of the invocation.

Parameters:

id - The id to set.

setArguments

public void setArguments(java.lang.Object[] arguments)

Sets the method arguments of the invocation.

Parameters:

arguments - The method arguments to set.

setResult

public void setResult(java.lang.Object result)

Sets the result of the invocation.

Parameters:

result - The result to set.

setSignature

public void setSignature(java.lang.String signature)

Sets the signature of the method.

Parameters:

signature - The signature to set.

setTarget

public void setTarget(ReferenceID target)

Sets the invocation's target.

Parameters:

target - The invocation's target.

setSource

public void setSource(ReferenceID source)

Sets the invocation's source.

Parameters:

source - The invocation's source.

setType

public void setType(short type)

Sets the type of the invocation.

Parameters:

type - The type to set.

setException

public void setException(java.lang.Throwable exception)

Sets the exception of the invocation.

Parameters:

exception - The exception to set.

setRequirements

public void setRequirements(NFCollection collection)

Associates nonfunctional requirements with this invocation. The non- functional requirements are typically used to select a plug-in within the plug-in selection strategy.

Parameters:

collection - The new non-functional requirements of the invocation.

readObject

public void readObject(IObjectInput stream)
                throws java.io.IOException

Deserializes the invocation from the given stream.

Specified by:

readObject in interface ISerializable

Parameters:

stream - The stream to read from.

Throws:

java.io.IOException - Thrown if the deserialization fails.

writeObject

public void writeObject(IObjectOutput stream)
                 throws java.io.IOException

Serializes the invocation to the given stream.

Specified by:

writeObject in interface ISerializable

Parameters:

stream - The stream to write to.

Throws:

java.io.IOException - Thrown if the deserialization fails.

toString

public java.lang.String toString()

Returns a string representation of this invocation.

Overrides:

toString in class java.lang.Object

Returns:

A string representation.