ch.icosys.popjava.core.service.jobmanager

Class POPJavaJobManager

java.lang.Object

ch.icosys.popjava.core.base.POPObject

ch.icosys.popjava.core.serviceadapter.POPServiceBase

ch.icosys.popjava.core.serviceadapter.POPJobService

ch.icosys.popjava.core.service.jobmanager.POPJavaJobManager

All Implemented Interfaces:

IPOPBase

@POPClass
public class POPJavaJobManager
extends POPJobService

Field Summary

Fields

Modifier and Type	Field and Description
protected Resource	available Currently used resources of a node
protected java.io.File	configurationFile The configuration file location
protected java.lang.String	defaultNetwork Default network UUID
protected Resource	jobLimit Total resources a job can have
protected java.util.Map<java.lang.Integer,AppResource>	jobs Number of job alive, mapped by AppResource.id
protected int	maxJobs Max number of jobs
protected java.util.concurrent.locks.ReentrantLock	mutex Mutex for some operations
protected java.util.Map<java.lang.String,POPNetwork>	networks Networks saved in this JobManager
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	nodeExtra Node extra information, value as List if multiple are supplied
protected java.lang.String	nodeId JobManager unique ID
protected java.util.concurrent.atomic.AtomicInteger	requestCounter Total number of requests received
protected Resource	total Max available resources of the node

Fields inherited from class ch.icosys.popjava.core.base.POPObject

definedMethodId, generateClassId, od, refCount

Constructor Summary

Constructors

Constructor and Description
POPJavaJobManager() Do not call this directly, way too many methods to this so no init was added.
POPJavaJobManager(java.lang.String url)
POPJavaJobManager(java.lang.String url, java.lang.String conf)
POPJavaJobManager(java.lang.String url, java.lang.String[] protocols)
POPJavaJobManager(java.lang.String url, java.lang.String[] protocols, java.lang.String conf)
POPJavaJobManager(java.lang.String url, java.lang.String[] protocols, java.lang.String conf, boolean localJVM, boolean upnp)

Method Summary

Modifier and Type	Method and Description
void	applicationEnd(int popAppId, boolean initiator) Propagate application end at the end of an application NOTE May not the necessary or useful, POP-Java already kill unused objects
void	askResourcesDiscovery(SNRequest request, POPAccessPoint sender) Recursive part of the Search Node, propagate request and answer if possible
void	callbackResult(SNResponse response) Add a node to the response list
void	cancelReservation(int[] req, int howmany) NOTE: same as POPC signature
void	changeAvailableBandwidth(float limit)
void	changeAvailableMemory(float limit)
void	changeAvailablePower(float limit)
void	changeMaxJobBandwidth(float limit)
void	changeMaxJobLimit(int limit)
void	changeMaxJobMemory(float limit)
void	changeMaxJobPower(float limit)
protected void	cleanup() Dead AppResources are handled here, cleaning them up.
POPJavaJobManager	connectToJobmanager(POPAccessPoint ap, java.lang.String network)
POPNetworkDetails	createNetwork(java.lang.String friendlyName) Create a new network and write the Job Manager configuration file anew
POPNetworkDetails	createNetwork(java.lang.String networkUUID, java.lang.String friendlyName) Create a new network and write the Job Manager configuration file anew.
int	createObject(POPAccessPoint localservice, java.lang.String objname, ObjectDescription od, int howmany, POPAccessPoint[] objcontacts, int howmany2, POPAccessPoint[] remotejobcontacts) Local request to create an object
void	dump() Dump of JobManager information
int	execObj(POPString objname, int howmany, int[] reserveIDs, java.lang.String localservice, POPAccessPoint[] objcontacts) Execute an object locally
protected void	finalize() Release waiting processes
POPNetworkDetails[]	getAvailableNetworks() The available networks in the current Job Manager
Resource	getAvailableResources() A copy of the current available resources
Resource	getInitialAvailableResources() The initial capacity of the node
Resource	getJobResourcesLimit() The upper limit for each job
int	getMaxJobs() The maximum number of simultaneous object available on the JM machine
java.lang.String[][]	getNetworkNodes(java.lang.String networkUUID) All the nodes in a network
java.lang.String	getNodeId() Unique ID for this node execution
SNNodesInfo	launchDiscovery(SNRequest request, int timeout) Start a discovery in a POP Network
POPAccessPoint[]	localTFCSearch(java.lang.String networkUUID, java.lang.String objectName) Looks for live TFC objects in a POP Network on this node.
POPAccessPoint[]	newTFCSearchOn(POPAccessPoint ap, java.lang.String network, java.lang.String objectName)
boolean	query(java.lang.String type, POPString value) Query something and return a formatted string
void	registerNeighbourJobmanager(POPAccessPoint ap, java.lang.String network, POPJavaJobManager jm)
void	registerNode(java.lang.String... params) Register a node in the default POP network
void	registerNode(java.lang.String networkUUID, java.lang.String... params) Register node to a network by supplying an array of string matching the format in the configuration file
void	registerPermanentNode(java.lang.String networkUUID, byte[] certificate, java.lang.String... params) Register a new node and add its certificate to the Key Store
void	registerPermanentNode(java.lang.String networkUUID, java.lang.String... params) Register a node and write it in the configuration file
boolean	registerTFCObject(java.lang.String networkUUID, java.lang.String objectName, POPAccessPoint accessPoint, java.lang.String secret) Register a new object that will be available for connection over TFC
void	removeNetwork(java.lang.String networkUUID) Remove a network and write the Job Manager configuration file anew
void	rerouteResponse(SNResponse response, SNWayback wayback) If we aren't the original node we transport the request back the way it came from
int	reserve(ObjectDescription od, POPMutableFloat iofitness, java.lang.String popAppId, java.lang.String reqID) NOTE: not in parent class, same signature as POPC w/ POPFloat for float transfer Add a resource reservation Reserve a resource and return a corresponding ID to send in execObj(ch.icosys.popjava.core.dataswaper.POPString, int, int[], java.lang.String, ch.icosys.popjava.core.baseobject.POPAccessPoint[])
protected void	selfRegister() Contact neighbors and tell them we are alive
protected void	selfUnregister() Contact neighbors and tell them we are shutting down
void	setConfigurationFile(java.lang.String configurationFile) Change configuration file location.
void	start() Start object and parallel thread check for resources death and other timed tasks.
void	stayAlive() Blocking method until death of this object.
void	unlockDiscovery(java.lang.String requid) Release the dispatching thread if necessary
void	unregisterNode(java.lang.String... params) Unregister a node from the default POP network
void	unregisterNode(java.lang.String networkUUID, java.lang.String... params) Remove a node from a network
void	unregisterPermanentNode(java.lang.String networkUUID, java.lang.String... params) Unregister a node and write it in the configuration file
void	unregisterTFCObject(java.lang.String networkUUID, java.lang.String objectName, POPAccessPoint accessPoint, java.lang.String secret) Register a new object that will be available for connection over TFC
void	update() Check and remove finished or timed out resources.

Methods inherited from class ch.icosys.popjava.core.serviceadapter.POPServiceBase

start, stop

Methods inherited from class ch.icosys.popjava.core.base.POPObject

addSemantic, addSemantic, canKill, defineConstructor, defineMethod, deserialize, deserialize, exit, getAccessPoint, getBroker, getClassId, getClassName, getConstructorByInfo, getMethodByInfo, getMethodInfo, getMethodInfo, getOd, getPOPCReference, getSemantic, getSemantic, getThis, getThis, getTracked, getTracked, getTrackedUsers, hasDestructor, hasDestructor, initializeConstructorInfo, initializeMethodInfo, initializePOPObject, isDaemon, isTemporary, isTracking, loadPOPAnnotations, makePermanent, makeTemporary, PopRegisterFutureConnectorCertificate, printMethodInfo, serialize, setBroker, setClassId, setClassName, setOd

Methods inherited from class java.lang.Object

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

Field Detail

configurationFile

protected java.io.File configurationFile

The configuration file location

available

protected final Resource available

Currently used resources of a node

total

protected final Resource total

Max available resources of the node

jobLimit

protected final Resource jobLimit

Total resources a job can have

requestCounter

protected final java.util.concurrent.atomic.AtomicInteger requestCounter

Total number of requests received

jobs

protected final java.util.Map<java.lang.Integer,AppResource> jobs

Number of job alive, mapped by AppResource.id

networks

protected final java.util.Map<java.lang.String,POPNetwork> networks

Networks saved in this JobManager

defaultNetwork

protected java.lang.String defaultNetwork

Default network UUID

maxJobs

protected int maxJobs

Max number of jobs

nodeExtra

protected final java.util.Map<java.lang.String,java.util.List<java.lang.String>> nodeExtra

Node extra information, value as List if multiple are supplied

mutex

protected final java.util.concurrent.locks.ReentrantLock mutex

Mutex for some operations

nodeId

protected final java.lang.String nodeId

JobManager unique ID

Constructor Detail

POPJavaJobManager

public POPJavaJobManager()

Do not call this directly, way too many methods to this so no init was added.

POPJavaJobManager

public POPJavaJobManager(java.lang.String url)

POPJavaJobManager

public POPJavaJobManager(java.lang.String url,
                         java.lang.String[] protocols)

POPJavaJobManager

public POPJavaJobManager(java.lang.String url,
                         java.lang.String[] protocols,
                         java.lang.String conf)

POPJavaJobManager

public POPJavaJobManager(java.lang.String url,
                         java.lang.String[] protocols,
                         java.lang.String conf,
                         boolean localJVM,
                         boolean upnp)

POPJavaJobManager

public POPJavaJobManager(java.lang.String url,
                         java.lang.String conf)

Method Detail

createObject

public int createObject(POPAccessPoint localservice,
                        java.lang.String objname,
                        ObjectDescription od,
                        int howmany,
                        POPAccessPoint[] objcontacts,
                        int howmany2,
                        POPAccessPoint[] remotejobcontacts)

Local request to create an object

Overrides:

createObject in class POPJobService

Parameters:

localservice - The AppService of the application

objname - Which object we have to create

od - The OD of the request

howmany - The size of objcontacts

objcontacts - How many instances we seek

howmany2 - number of remote access points (we think)

remotejobcontacts - actual access points (we think)

Returns:

0 or an exception, normally

execObj

public int execObj(POPString objname,
                   int howmany,
                   int[] reserveIDs,
                   java.lang.String localservice,
                   POPAccessPoint[] objcontacts)

Execute an object locally

Parameters:

objname - The object to execute

howmany - How many object will be executed

reserveIDs - IDs received from reserve(ch.icosys.popjava.core.baseobject.ObjectDescription, ch.icosys.popjava.core.dataswaper.POPMutableFloat, java.lang.String, java.lang.String)

localservice - Application AppService

objcontacts - Where to answer when the object is created

Returns:

0 when successful, any other number when not

reserve

public int reserve(ObjectDescription od,
                   POPMutableFloat iofitness,
                   java.lang.String popAppId,
                   java.lang.String reqID)

NOTE: not in parent class, same signature as POPC w/ POPFloat for float transfer Add a resource reservation Reserve a resource and return a corresponding ID to send in execObj(ch.icosys.popjava.core.dataswaper.POPString, int, int[], java.lang.String, ch.icosys.popjava.core.baseobject.POPAccessPoint[])

Parameters:

od - The request OD

iofitness - [output] The fitness, compatibility of the request with this node

popAppId - the application id

reqID - the request id

Returns:

the reservation ID for this request used in the other methods

cancelReservation

public void cancelReservation(int[] req,
                              int howmany)

NOTE: same as POPC signature

Parameters:

req - An array of AppResource.id

howmany - Redundant for Java, number of element in array

dump

public void dump()

Dump of JobManager information

start

public void start()

Start object and parallel thread check for resources death and other timed tasks.

Overrides:

start in class POPServiceBase

query

public boolean query(java.lang.String type,
                     POPString value)

Query something and return a formatted string

Parameters:

type - What to query

value - A formatted String with some data in it

Returns:

true if the query is successful, false otherwise

changeAvailablePower

public void changeAvailablePower(float limit)

changeAvailableMemory

public void changeAvailableMemory(float limit)

changeAvailableBandwidth

public void changeAvailableBandwidth(float limit)

changeMaxJobLimit

public void changeMaxJobLimit(int limit)

changeMaxJobPower

public void changeMaxJobPower(float limit)

changeMaxJobMemory

public void changeMaxJobMemory(float limit)

changeMaxJobBandwidth

public void changeMaxJobBandwidth(float limit)

selfRegister

protected void selfRegister()

Contact neighbors and tell them we are alive

selfUnregister

protected void selfUnregister()

Contact neighbors and tell them we are shutting down

createNetwork

public POPNetworkDetails createNetwork(java.lang.String friendlyName)

Create a new network and write the Job Manager configuration file anew

Parameters:

friendlyName - A name for this network

Returns:

true if created or already exists, false if already exists but use a different protocol

createNetwork

public POPNetworkDetails createNetwork(java.lang.String networkUUID,
                                       java.lang.String friendlyName)

Create a new network and write the Job Manager configuration file anew. The network is create with the specified UUID.

Parameters:

networkUUID - A machine unique identifier for this network

friendlyName - A name for this network

Returns:

true if created or already exists, false if already exists but use a different protocol

removeNetwork

public void removeNetwork(java.lang.String networkUUID)

Remove a network and write the Job Manager configuration file anew

Parameters:

networkUUID - The unique name of the network

registerNode

public void registerNode(java.lang.String networkUUID,
                         java.lang.String... params)

Register node to a network by supplying an array of string matching the format in the configuration file

Parameters:

networkUUID - The name of an existing network in this JM

params - An array of String that will be processed by POPNetworkDescriptor.createNode(java.util.List<java.lang.String>)

unregisterNode

public void unregisterNode(java.lang.String networkUUID,
                           java.lang.String... params)

Remove a node from a network

Parameters:

networkUUID - The name of an existing network in this JM

params - An array of String that will be processed to POPNetworkDescriptor.createNode(java.util.List<java.lang.String>)

registerNode

public void registerNode(java.lang.String... params)

Register a node in the default POP network

Parameters:

params - the parameters needed to create a new node, via POPNode.getCreationParams()

unregisterNode

public void unregisterNode(java.lang.String... params)

Unregister a node from the default POP network

Parameters:

params - the parameters needed to create a new node, via POPNode.getCreationParams()

registerPermanentNode

public void registerPermanentNode(java.lang.String networkUUID,
                                  java.lang.String... params)

Register a node and write it in the configuration file

Parameters:

networkUUID - the network id

params - the parameters needed to create a new node, via POPNode.getCreationParams()

registerPermanentNode

public void registerPermanentNode(java.lang.String networkUUID,
                                  byte[] certificate,
                                  java.lang.String... params)

Register a new node and add its certificate to the Key Store

Parameters:

networkUUID - the network id

certificate - the certificate associated with the node

params - the parameters needed to create a new node, via POPNode.getCreationParams()

unregisterPermanentNode

public void unregisterPermanentNode(java.lang.String networkUUID,
                                    java.lang.String... params)

Unregister a node and write it in the configuration file

Parameters:

networkUUID - the network id

params - the parameters needed to create a new node, via POPNode.getCreationParams()

update

public void update()

Check and remove finished or timed out resources. NOTE: With a lot of job this method need jobs.size connections to be made before continuing

getAvailableResources

public Resource getAvailableResources()

A copy of the current available resources

Returns:

A copy Resource object

getInitialAvailableResources

public Resource getInitialAvailableResources()

The initial capacity of the node

Returns:

the current available resources

getJobResourcesLimit

public Resource getJobResourcesLimit()

The upper limit for each job

Returns:

a single job's available resource

getMaxJobs

public int getMaxJobs()

The maximum number of simultaneous object available on the JM machine

Returns:

the maximum number of resources available on the machine

getNodeId

public java.lang.String getNodeId()

Unique ID for this node execution

Returns:

the UUID of the node

applicationEnd

public void applicationEnd(int popAppId,
                           boolean initiator)

Propagate application end at the end of an application NOTE May not the necessary or useful, POP-Java already kill unused objects

Parameters:

popAppId - the application id

initiator - who started the application end request

cleanup

protected void cleanup()

Dead AppResources are handled here, cleaning them up.

setConfigurationFile

public void setConfigurationFile(java.lang.String configurationFile)

Change configuration file location. This method will only change the location and try to write in it, it will not delete the old file. This method is not meant to be used to load a new configuration file.

Parameters:

configurationFile - the job manager configuration file

getAvailableNetworks

public POPNetworkDetails[] getAvailableNetworks()

The available networks in the current Job Manager

Returns:

all the available locally on this machine (job manager)

getNetworkNodes

public java.lang.String[][] getNetworkNodes(java.lang.String networkUUID)

All the nodes in a network

Parameters:

networkUUID - the network id

Returns:

the parameters needed to create multiple new nodes, via POPNode.getCreationParams()

stayAlive

public void stayAlive()

Blocking method until death of this object.

finalize

protected void finalize()
                 throws java.lang.Throwable

Release waiting processes

Overrides:

finalize in class POPObject

Throws:

java.lang.Throwable - anything

registerTFCObject

public boolean registerTFCObject(java.lang.String networkUUID,
                                 java.lang.String objectName,
                                 POPAccessPoint accessPoint,
                                 java.lang.String secret)

Register a new object that will be available for connection over TFC

Parameters:

networkUUID - The network that will contain the object

objectName - The class of the object

accessPoint - Where to find the object on the machine

secret - A secret to remove the object

Returns:

true if we could add the object successfully

unregisterTFCObject

public void unregisterTFCObject(java.lang.String networkUUID,
                                java.lang.String objectName,
                                POPAccessPoint accessPoint,
                                java.lang.String secret)

Register a new object that will be available for connection over TFC

Parameters:

networkUUID - The network that will contain the object

objectName - The class of the object

accessPoint - Where to find the object on the machine

secret - A secret to remove the object

localTFCSearch

public POPAccessPoint[] localTFCSearch(java.lang.String networkUUID,
                                       java.lang.String objectName)

Looks for live TFC objects in a POP Network on this node.

Parameters:

networkUUID - the network id

objectName - the kind of object we are looking for

Returns:

The POPAccessPoint(s) of lives TFC Objects registered on this Job Manager.

launchDiscovery

public SNNodesInfo launchDiscovery(SNRequest request,
                                   int timeout)

Start a discovery in a POP Network

Parameters:

request - The request generated by POPConnector.createObject(ch.icosys.popjava.core.baseobject.POPAccessPoint, java.lang.String, ch.icosys.popjava.core.baseobject.ObjectDescription, int, ch.icosys.popjava.core.baseobject.POPAccessPoint[], int, ch.icosys.popjava.core.baseobject.POPAccessPoint[])

timeout - How much time do we wait before proceeding, in case of 0 the first answer is the one we use

Returns:

All the nodes that answered our request

askResourcesDiscovery

public void askResourcesDiscovery(SNRequest request,
                                  POPAccessPoint sender)

Recursive part of the Search Node, propagate request and answer if possible

Parameters:

request - The propagating request

sender - Unused, send empty POPAccessPoint

callbackResult

public void callbackResult(SNResponse response)

Add a node to the response list

Parameters:

response - the response from the remote node

rerouteResponse

public void rerouteResponse(SNResponse response,
                            SNWayback wayback)

If we aren't the original node we transport the request back the way it came from

Parameters:

response - Answer to the request

wayback - The route to go back to the origin

unlockDiscovery

public void unlockDiscovery(java.lang.String requid)

Release the dispatching thread if necessary

Parameters:

requid - the request id to unlock a potential semaphore

connectToJobmanager

public POPJavaJobManager connectToJobmanager(POPAccessPoint ap,
                                             java.lang.String network)

newTFCSearchOn

public POPAccessPoint[] newTFCSearchOn(POPAccessPoint ap,
                                       java.lang.String network,
                                       java.lang.String objectName)

registerNeighbourJobmanager

public void registerNeighbourJobmanager(POPAccessPoint ap,
                                        java.lang.String network,
                                        POPJavaJobManager jm)