ch.icosys.popjava.core

Class PopJava

java.lang.Object

ch.icosys.popjava.core.PopJava

public class PopJava
extends java.lang.Object

This class is used to create parallel object. All the methods from this class are static so no instantiation is needed.

Method Summary

Modifier and Type	Method and Description
static <T> T	connect(java.lang.Object parentObject, java.lang.Class<T> targetClass, java.lang.String networkUUID, POPAccessPoint accessPoint) Static method used to connect to an already existing parallel object with a custom network
static void	destroy(java.lang.Object object) Destroys a POP object.
static void	disconnect(java.lang.Object object) Disconnects the POP object without destroying the remove object.
static POPAccessPoint	getAccessPoint(java.lang.Object object)
static POPRemoteCaller	getRemote(java.lang.Object object) Given a Proxy Object (Client) connected to a POP Object (Server) we get the identifier of the server.
static POPRemoteCaller	getRemoteCaller() Return the remote source for the call to this method.
static <T> T	getThis(T object)
static boolean	isPOPJavaActive() Returns true if POP-Java is loaded and enabled
static <T> T	newActive(java.lang.Class<T> targetClass, ObjectDescription objectDescription, java.lang.Object... argvs) Static method used to create a new parallel object by passing an object description
static <T> T	newActive(java.lang.Object parentObject, java.lang.Class<T> targetClass, java.lang.Object... argvs) Static method used to create a new parallel object
static <T> T	newActive(java.lang.Object parentObject, java.lang.Class<T> targetClass, POPAccessPoint accessPoint) Static method used to connect to an already existing parallel object TODO rename as connect?
static <T> T	newActive(java.lang.Object parentObject, java.lang.Class<T> targetClass, POPAccessPoint accessPoint, java.lang.String networkUUID) Static method used to connect to an already existing parallel object TODO rename as connect?
static <T> T	newActiveConnect(java.lang.Object parentObject, java.lang.Class<T> targetClass, POPAccessPoint accessPoint)
static <T> T	newActiveFromBuffer(Combox<?> sourceCombox, java.lang.Class<T> targetClass, POPBuffer buffer) Static method used to create a parallel object from the buffer
static java.lang.Object	newActiveFromName(java.lang.String targetClass, java.lang.Object... argvs)
static POPAccessPoint[]	newTFCSearch(java.lang.Class<?> targetClass, int maxInstances, ObjectDescription od) Search a live object in the network.
static POPAccessPoint[]	newTFCSearchOn(java.lang.Class<?> targetClass, java.lang.String networkUUID, POPNode node) Make a TFC research on a specific POPNode, the node should be of type POPNodeAJobManager.

Methods inherited from class java.lang.Object

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

Method Detail

newActive

public static <T> T newActive(java.lang.Class<T> targetClass,
                              ObjectDescription objectDescription,
                              java.lang.Object... argvs)
                       throws POPException

Static method used to create a new parallel object by passing an object description

Parameters:

targetClass - the parallel class to be created

objectDescription - the object description for the resource requirements

argvs - arguments of the constructor (may be empty)

Returns:

references to the parallel object created

Throws:

POPException - a remote exception, check caused by

newActiveFromName

public static java.lang.Object newActiveFromName(java.lang.String targetClass,
                                                 java.lang.Object... argvs)
                                          throws POPException,
                                                 java.lang.ClassNotFoundException

Throws:

POPException

java.lang.ClassNotFoundException

newActive

public static <T> T newActive(java.lang.Object parentObject,
                              java.lang.Class<T> targetClass,
                              java.lang.Object... argvs)
                       throws POPException

Static method used to create a new parallel object

Parameters:

targetClass - the parallel class to be created

argvs - arguments of the constructor (may be empty)

Returns:

references to the parallel object created

Throws:

POPException - a remote exception, check caused by

newActive

public static <T> T newActive(java.lang.Object parentObject,
                              java.lang.Class<T> targetClass,
                              POPAccessPoint accessPoint,
                              java.lang.String networkUUID)
                       throws POPException

Static method used to connect to an already existing parallel object TODO rename as connect?

Parameters:

targetClass - the parallel class to be created

accessPoint - access point of the living object

Returns:

references to the parallel object

Throws:

POPException - a remote exception, check caused by

newActive

public static <T> T newActive(java.lang.Object parentObject,
                              java.lang.Class<T> targetClass,
                              POPAccessPoint accessPoint)
                       throws POPException

Static method used to connect to an already existing parallel object TODO rename as connect?

Parameters:

targetClass - the parallel class to be created

accessPoint - access point of the living object

Returns:

references to the parallel object

Throws:

POPException - a remote exception, check caused by

newActiveConnect

public static <T> T newActiveConnect(java.lang.Object parentObject,
                                     java.lang.Class<T> targetClass,
                                     POPAccessPoint accessPoint)
                              throws POPException

Throws:

POPException

connect

public static <T> T connect(java.lang.Object parentObject,
                            java.lang.Class<T> targetClass,
                            java.lang.String networkUUID,
                            POPAccessPoint accessPoint)

Static method used to connect to an already existing parallel object with a custom network

Parameters:

targetClass - the parallel class to be created

networkUUID - the network that we will try to connect to

accessPoint - access point of the living object

Returns:

references to the parallel object

Throws:

POPException - a remote exception, check caused by

newActiveFromBuffer

public static <T> T newActiveFromBuffer(Combox<?> sourceCombox,
                                        java.lang.Class<T> targetClass,
                                        POPBuffer buffer)
                                 throws POPException

Static method used to create a parallel object from the buffer

Parameters:

targetClass - the parallel class to be recovered

buffer - buffer from which the object must be recovered

Returns:

references to the parallel object

Throws:

POPException - a remote exception, check caused by

newTFCSearch

public static POPAccessPoint[] newTFCSearch(java.lang.Class<?> targetClass,
                                            int maxInstances,
                                            ObjectDescription od)

Search a live object in the network. A research should look something like this:

 ObjectDescription od = new ObjectDescription();
 od.setNetwork(publishNetworkUUID);
 POPAccessPoint[] liveObjects = PopJava.newTFCSearch(TFCObject.class, maxNumInstances, od);
 for (POPAccessPoint ap : liveObjects) {
        // choose or connect
        ...
 }
 
 TFCObject remote = PopJava.connect(TFCObject.class, publishNetworkUUID, choosenAccessPoint);
 

Parameters:

targetClass - The class we are looking for remotely

maxInstances - The maximal number of instances we would like

od - Parameters for the research, mainly the network we want to look into

Returns:

An array with all the

newTFCSearchOn

public static POPAccessPoint[] newTFCSearchOn(java.lang.Class<?> targetClass,
                                              java.lang.String networkUUID,
                                              POPNode node)

Make a TFC research on a specific POPNode, the node should be of type POPNodeAJobManager.

Parameters:

targetClass - the class we are looking for

networkUUID - in which network we should look for

node - the node we want to make the research on

Returns:

the access points of the found objects

getAccessPoint

public static POPAccessPoint getAccessPoint(java.lang.Object object)

getThis

public static <T> T getThis(T object)

destroy

public static void destroy(java.lang.Object object)

Destroys a POP object.

Parameters:

object - the object to destroy

disconnect

public static void disconnect(java.lang.Object object)

Disconnects the POP object without destroying the remove object. The remote object will close if it has no connections left.

Parameters:

object - the locally connected object we want to disconnect

isPOPJavaActive

public static boolean isPOPJavaActive()

Returns true if POP-Java is loaded and enabled

Returns:

true if active, false otherwise

getRemoteCaller

public static POPRemoteCaller getRemoteCaller()

Return the remote source for the call to this method. Used inside a POP object.

Returns:

who is calling this object

getRemote

public static POPRemoteCaller getRemote(java.lang.Object object)

Given a Proxy Object (Client) connected to a POP Object (Server) we get the identifier of the server.

Parameters:

object - the object we want to know the location of

Returns:

the remote connection details or an exception

Throws:

java.lang.IllegalArgumentException - if the given object is not a POP Object