ch.icosys.popjava.core.base

Class POPObject

java.lang.Object

ch.icosys.popjava.core.base.POPObject

All Implemented Interfaces:

IPOPBase

Direct Known Subclasses:

POPJavaAppService, POPServiceBase

public class POPObject
extends java.lang.Object
implements IPOPBase

This class is the base class of all POP-Java parallel classes. Every POP-Java parallel classes must inherit from this one.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	definedMethodId
protected boolean	generateClassId
protected ObjectDescription	od
protected int	refCount

Constructor Summary

Constructors

Constructor and Description
POPObject() Creates a new instance of POPObject

Method Summary

Modifier and Type	Method and Description
void	addSemantic(java.lang.Class<?> c, java.lang.String methodName, int semantic) Set an invocation semantic to a specific method.
void	addSemantic(java.lang.Class<?> c, java.lang.String methodName, int semantic, java.lang.Class<?>... parameterTypes) Set an invocation semantic to a specific method that is overloaded
boolean	canKill() Ask if the object can be killed
protected void	defineConstructor(java.lang.Class<?> c, int constructorId, java.lang.Class<?>... paramTypes) Define information about a constructor
protected void	defineMethod(java.lang.Class<?> c, java.lang.String methodName, int methodId, int semanticId, java.lang.Class<?>... paramTypes) Define informations about a method
boolean	deserialize(Combox<?> sourceCombox, POPBuffer buffer)
boolean	deserialize(POPBuffer buffer) Deserialize the object from the buffer
void	exit() Exit method
protected void	finalize()
POPAccessPoint	getAccessPoint() Retrieve the access point of the parallel object
Broker	getBroker()
int	getClassId() Get the class unique identifier
java.lang.String	getClassName() Retrieve the class name of the parallel object
java.lang.reflect.Constructor<?>	getConstructorByInfo(MethodInfo info) Retrieve a constructor by its informations
java.lang.reflect.Method	getMethodByInfo(MethodInfo info) Retrieve a specific method in the parallel class with some information
MethodInfo	getMethodInfo(java.lang.reflect.Constructor<?> constructor) Retrieve a specific method by its constructor informations
MethodInfo	getMethodInfo(java.lang.reflect.Method method) Retrieve a method by its informations
ObjectDescription	getOd() Get the object description of the POPObject
java.lang.String	getPOPCReference() Return the reference of this object with a POP-C++ format
int	getSemantic(java.lang.reflect.Method method) Retrieve the invocation semantic of a specific method
int	getSemantic(MethodInfo methodInfo) Retrieve the invocation semantic of a specific method
<T> T	getThis()
<T> T	getThis(java.lang.Class<T> myClass)
POPTracking	getTracked() Get the resources used until now by caller.
POPTracking	getTracked(POPRemoteCaller caller) Get the resources used by an user.
POPRemoteCaller[]	getTrackedUsers() Get the tracked user list.
protected boolean	hasDestructor() Return the value of the hasDestrcutor variable
protected void	hasDestructor(boolean hasDestructor) Set the destructor value.
protected void	initializeConstructorInfo(java.lang.Class<?> c) Initialize the constructor identifier and the semantic
protected void	initializeMethodInfo(java.lang.Class<?> c) Initialize the method identifier for all the methods in a class
protected void	initializePOPObject() Initialize the method identifiers of a POPObject
boolean	isDaemon() Specify if the parallel object is running like a deamon
boolean	isTemporary()
boolean	isTracking() Is tracking enabled on the remote object.
void	loadPOPAnnotations(java.lang.reflect.Constructor<?> constructor, java.lang.Object... argvs)
<T extends POPObject> T	makePermanent()
void	makeTemporary()
void	PopRegisterFutureConnectorCertificate(byte[] cert) Register a certificate on the node TODO Handle this method for other kind of Combox (only SSL ATM)
void	printMethodInfo() Print object information on the standard output
boolean	serialize(POPBuffer buffer) Serialize the object into the buffer
void	setBroker(Broker broker)
protected void	setClassId(int classId) Set the class unique identifier
protected void	setClassName(java.lang.String className) Set the class name
void	setOd(ObjectDescription od) Set a new object description to the POPObject

Methods inherited from class java.lang.Object

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

Field Detail

refCount

protected int refCount

generateClassId

protected boolean generateClassId

definedMethodId

protected boolean definedMethodId

od

protected ObjectDescription od

Constructor Detail

POPObject

public POPObject()

Creates a new instance of POPObject

Method Detail

loadPOPAnnotations

public void loadPOPAnnotations(java.lang.reflect.Constructor<?> constructor,
                               java.lang.Object... argvs)

initializePOPObject

protected final void initializePOPObject()

Initialize the method identifiers of a POPObject

isDaemon

public boolean isDaemon()

Specify if the parallel object is running like a deamon

Returns:

true if it's a deamon

canKill

public final boolean canKill()

Ask if the object can be killed

Returns:

true if the object can be killed

getOd

public final ObjectDescription getOd()

Get the object description of the POPObject

Returns:

the object description of the POPObject

setOd

public final void setOd(ObjectDescription od)

Set a new object description to the POPObject

Parameters:

od - the new object description

getAccessPoint

public POPAccessPoint getAccessPoint()

Retrieve the access point of the parallel object

Returns:

POPAccessPoint object containing all access points to the parallel object

getBroker

public Broker getBroker()

getClassName

public final java.lang.String getClassName()

Retrieve the class name of the parallel object

Returns:

class name as a String value

setClassName

protected final void setClassName(java.lang.String className)

Set the class name

Parameters:

className - the class name

hasDestructor

protected final boolean hasDestructor()

Return the value of the hasDestrcutor variable

Returns:

true if the parclass has a destrcutor

hasDestructor

protected final void hasDestructor(boolean hasDestructor)

Set the destructor value. Must be set to true if the parclass has a destructor

Parameters:

hasDestructor - set to true if the parclass has a destructor

getClassId

public final int getClassId()

Get the class unique identifier

Returns:

the class unique identifier

setClassId

protected final void setClassId(int classId)

Set the class unique identifier

Parameters:

classId - the class unique identifier

getMethodByInfo

public java.lang.reflect.Method getMethodByInfo(MethodInfo info)
                                         throws java.lang.NoSuchMethodException

Retrieve a specific method in the parallel class with some information

Parameters:

info - informations about the method to retrieve

Returns:

A method object that represent the method found in the parallel class

Throws:

java.lang.NoSuchMethodException - thrown is the method is not found

getConstructorByInfo

public java.lang.reflect.Constructor<?> getConstructorByInfo(MethodInfo info)
                                                      throws java.lang.NoSuchMethodException

Retrieve a constructor by its informations

Parameters:

info - Informations about the constructor to retrieve

Returns:

The constructor found

Throws:

java.lang.NoSuchMethodException - thrown if no constrcutor is found

getMethodInfo

public MethodInfo getMethodInfo(java.lang.reflect.Method method)

Retrieve a method by its informations

Parameters:

method - Informations about the method to retrieve

Returns:

The method found

getMethodInfo

public MethodInfo getMethodInfo(java.lang.reflect.Constructor<?> constructor)

Retrieve a specific method by its constructor informations

Parameters:

constructor - Informations about the constructor

Returns:

The method found

getSemantic

public int getSemantic(MethodInfo methodInfo)

Retrieve the invocation semantic of a specific method

Parameters:

methodInfo - informations about the specific method

Returns:

int value representing the semantics of the method

getSemantic

public int getSemantic(java.lang.reflect.Method method)

Retrieve the invocation semantic of a specific method

Parameters:

method - method to look at

Returns:

int value representing the semantics of the method

addSemantic

public final void addSemantic(java.lang.Class<?> c,
                              java.lang.String methodName,
                              int semantic)

Set an invocation semantic to a specific method.

Parameters:

c - class of the method

methodName - method to modify

semantic - semantic to set on the method

addSemantic

public final void addSemantic(java.lang.Class<?> c,
                              java.lang.String methodName,
                              int semantic,
                              java.lang.Class<?>... parameterTypes)
                       throws java.lang.NoSuchMethodException

Set an invocation semantic to a specific method that is overloaded

Parameters:

c - class of the method

methodName - method to modify

semantic - semantic to set on the method

parameterTypes - parameters types of the method

Throws:

java.lang.NoSuchMethodException - if the method name is not found

initializeMethodInfo

protected void initializeMethodInfo(java.lang.Class<?> c)

Initialize the method identifier for all the methods in a class

Parameters:

c - class to initialize

initializeConstructorInfo

protected void initializeConstructorInfo(java.lang.Class<?> c)

Initialize the constructor identifier and the semantic

Parameters:

c - class to initialize

defineMethod

protected void defineMethod(java.lang.Class<?> c,
                            java.lang.String methodName,
                            int methodId,
                            int semanticId,
                            java.lang.Class<?>... paramTypes)

Define informations about a method

Parameters:

c - Class of the method

methodName - Name of the method

methodId - Unique identifier of the method

semanticId - Semantic applied to the method

paramTypes - Parameters of the method

defineConstructor

protected void defineConstructor(java.lang.Class<?> c,
                                 int constructorId,
                                 java.lang.Class<?>... paramTypes)

Define information about a constructor

Parameters:

c - Class of the constructor

constructorId - Unique identifier of the constructor

paramTypes - Parameters of the constructor

deserialize

public boolean deserialize(POPBuffer buffer)

Deserialize the object from the buffer

Specified by:

deserialize in interface IPOPBase

Parameters:

buffer - The buffer to deserialize from

Returns:

true if the deserialization process succeed

deserialize

public boolean deserialize(Combox<?> sourceCombox,
                           POPBuffer buffer)

serialize

public boolean serialize(POPBuffer buffer)

Serialize the object into the buffer

Specified by:

serialize in interface IPOPBase

Parameters:

buffer - The buffer to serialize in

Returns:

true if the serialization process succeed

exit

public void exit()

Exit method

printMethodInfo

public void printMethodInfo()

Print object information on the standard output

getPOPCReference

public java.lang.String getPOPCReference()

Return the reference of this object with a POP-C++ format

Returns:

access point of the object as a formatted string

isTemporary

public boolean isTemporary()

makeTemporary

public void makeTemporary()

makePermanent

public <T extends POPObject> T makePermanent()

setBroker

public void setBroker(Broker broker)

getThis

public <T> T getThis(java.lang.Class<T> myClass)

getThis

public <T> T getThis()

PopRegisterFutureConnectorCertificate

public void PopRegisterFutureConnectorCertificate(byte[] cert)

Register a certificate on the node TODO Handle this method for other kind of Combox (only SSL ATM)

Parameters:

cert - the certificate to save locally

getTrackedUsers

public POPRemoteCaller[] getTrackedUsers()

Get the tracked user list.

Returns:

a callerID array of strings.

getTracked

public POPTracking getTracked(POPRemoteCaller caller)

Get the resources used by an user.

Parameters:

caller - the identifier we want connection details of

Returns:

the details on the user use of the object

getTracked

public POPTracking getTracked()

Get the resources used until now by caller.

Returns:

my own usage of the object

isTracking

public boolean isTracking()

Is tracking enabled on the remote object.

Returns:

true if object's tracking is turned on

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable