LocalWorkpoolImpl

java.lang.Object
- java.rmi.server.RemoteObject
- - java.rmi.server.RemoteServer
  - - java.rmi.server.UnicastRemoteObject
    - - beehive.workpool.LocalWorkpoolImpl

All Implemented Interfaces:

LocalWorkpoolServer, Serializable, Remote
```
public class LocalWorkpoolImpl
extends UnicastRemoteObject
implements LocalWorkpoolServer
```
Each Beehive Server maintains a local workpool from which its workers deposits and fetches tasks. Each workpool maintains a connection to remote workpools in the same cluster allowing tasks to be distributed across the cluster with a LoadDistributor or LoadDistributorV2. The workpool is also responsible for interfacing with the ValidationService to validate tasks and committing valid tasks.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`Integer`	`abortOnStartCounter`
`static Integer`	`BARRIER_FINISHED`
`static Integer`	`BARRIER_PENDING`
`Config`	`configParams`
`static long`	`GAP_TIME`
`static int`	`INIT`
`static int`	`INIT_PENDING`
`static int`	`JOB_FINISHED`
`static int`	`JOB_STARTED`
`static String`	`LOAD_DISTRIBUTOR_VERSION`
`ConcurrentHashMap<String,LoadInfo>`	`loadInfoTable`
`StatContainer`	`localDepStats`
`StringBuffer`	`logBuffer`
`String`	`modelType`
`String`	`myHost`
`Vector<String>`	`peerList`
`static String`	`RPC_MECHANISM`
`static long`	`SLEEP_TIME`
`static long`	`STS_DELAY`
`ValidationService`	`validationService`
`ConcurrentHashMap<String,LocalWorkpoolServer>`	`wpoolHandles`

Fields inherited from class java.rmi.server.RemoteObject
ref

Constructor Summary

Constructors
Constructor and Description

LocalWorkpoolImpl(String validationHostDetail, int workerCount, int[] partitionedGraphHostNodesTable)

Constructors
Constructor and Description
`LocalWorkpoolImpl(String validationHostDetail, int workerCount, int[] partitionedGraphHostNodesTable)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTask(Task t)` Adds the given task into the workpool depending on its affinity and targetLocation.
`void`	`addTask(Vector<Task> taskVector)` Adds several tasks to the workpool
`void`	`barrierJoin(String remoteHost)` A means workpool servers to synchronize using a barrier.
`void`	`broadcast(Task t)` Broadcasts a task to all of its peers
`boolean`	`checkTermination()` A means to check if there are no tasks left in either workpool, if so, the system is in the termination phase.
`void`	`depositTask(Task t)` An API for remote deposits of a task.
`LoadInfo`	`depositTasks(Vector<Task> taskList)`
`LoadInfo`	`getLoadInfo()`
`int`	`getMyAggregatedLoad()` Called only by `getMyLoad()`
`int`	`getMyLoad()`
`String`	`getNewTID()`
`ProgressStatus`	`getProgressStatus()` Not used
`String`	`getStats()`
`int`	`getStatus()` Not used: Only called from `proceedToClustering()`
`long`	`getSTS()` Synchronizes the local stable timestamp with that of the global timestamp
`WorkStatus`	`getTask()` Attempts to fetch a task from the ready-workpool.
`LoadInfo`	`getTerminationStatus(int oldts, int newts)` Only called by `checkTermination()`.
`void`	`lookupPeers(Vector<String> hostList)` Connects to each `WorkpoolServer` whose hostname is given
`void`	`printProgress()`
`void`	`proceedToClustering()` Not used: Only called in the while-loop from `PageRankTest` to enter clustering
`void`	`removeTask(Task t)` Removes a task from the active workpool.
`void`	`reportAbortOnStart()` A means to report that the execution of a task must be aborted before the execution starts
`void`	`reportCompletion(Task t, HashSet<Task> tasksCreated)` A means to report the completion of the execution of a task.
`void`	`reportInitialization()`
`void`	`reportJobCompletion()` A means to notify each worker that a job has completed.
`void`	`reportStartup()` Not used
`void`	`reportTransactionCompletion(long commitTS)` Allows a task to report the completion of a transaction phase.
`void`	`setStatusInit()` Not used: Only called from `reportInitialization()`
`void`	`updateLoadInfo(Vector<LoadInfo> loadVector)` Each workpool caches the `LoadInfo` of its peers.
`void`	`updateSTS(long sts)` Updates the local stable timestamp of the system.
`ValidateResponse`	`validate(Task t, RWSetInfo rwSetInfo)` Validates the completed task

Methods inherited from class java.rmi.server.UnicastRemoteObject
clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer
getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject
equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - validationService
```
public ValidationService validationService
```
  - wpoolHandles
```
public ConcurrentHashMap<String,LocalWorkpoolServer> wpoolHandles
```
  - loadInfoTable
```
public ConcurrentHashMap<String,LoadInfo> loadInfoTable
```
  - peerList
```
public Vector<String> peerList
```
  - localDepStats
```
public StatContainer localDepStats
```
  - logBuffer
```
public StringBuffer logBuffer
```
  - configParams
```
public Config configParams
```
  - INIT_PENDING
```
public static final int INIT_PENDING
```
    See Also:
    
    Constant Field Values
  - INIT
```
public static final int INIT
```
    See Also:
    
    Constant Field Values
  - JOB_STARTED
```
public static final int JOB_STARTED
```
    See Also:
    
    Constant Field Values
  - JOB_FINISHED
```
public static final int JOB_FINISHED
```
    See Also:
    
    Constant Field Values
  - BARRIER_PENDING
```
public static final Integer BARRIER_PENDING
```
  - BARRIER_FINISHED
```
public static final Integer BARRIER_FINISHED
```
  - SLEEP_TIME
```
public static long SLEEP_TIME
```
  - GAP_TIME
```
public static long GAP_TIME
```
  - STS_DELAY
```
public static long STS_DELAY
```
  - LOAD_DISTRIBUTOR_VERSION
```
public static String LOAD_DISTRIBUTOR_VERSION
```
  - modelType
```
public String modelType
```
  - myHost
```
public String myHost
```
  - abortOnStartCounter
```
public Integer abortOnStartCounter
```
  - RPC_MECHANISM
```
public static String RPC_MECHANISM
```
- Constructor Detail
  - LocalWorkpoolImpl
```
public LocalWorkpoolImpl(String validationHostDetail,
                         int workerCount,
                         int[] partitionedGraphHostNodesTable)
                  throws IOException
```
    Parameters:
    
    validationHostDetail - The hostname of the server running the ValidationService
    
    workerCount - The number of Workers pulling from this workpool
    
    partitionedGraphHostNodesTable -
    
    Throws:
    
    IOException - Thrown if the Validator could not be contacted
- Method Detail
  - depositTasks
```
public LoadInfo depositTasks(Vector<Task> taskList)
                      throws RemoteException
```
    Specified by:
    
    depositTasks in interface LocalWorkpoolServer
    
    Parameters:
    
    taskList - The tasks to deposit into the workpool
    
    Returns:
    
    The LoadInfo after the tasks have been deposited
    
    Throws:
    
    RemoteException
  - depositTask
```
public void depositTask(Task t)
```
    An API for remote deposits of a task.
    
    Parameters:
    
    t - The task to be deposited
  - reportJobCompletion
```
public void reportJobCompletion()
                         throws RemoteException
```
    A means to notify each worker that a job has completed. Any tasks submitted after all Workers have been notified of the job completion will be ignored.
    
    Specified by:
    
    reportJobCompletion in interface LocalWorkpoolServer
    
    Throws:
    
    RemoteException
  - reportAbortOnStart
```
public void reportAbortOnStart()
```
    A means to report that the execution of a task must be aborted before the execution starts
  - getLoadInfo
```
public LoadInfo getLoadInfo()
                     throws RemoteException
```
    Specified by:
    
    getLoadInfo in interface LocalWorkpoolServer
    
    Throws:
    
    RemoteException
  - getTerminationStatus
```
public LoadInfo getTerminationStatus(int oldts,
                                     int newts)
                              throws RemoteException
```
    Only called by checkTermination(). Get's the current state of the system to see if it is in termination.
    
    Specified by:
    
    getTerminationStatus in interface LocalWorkpoolServer
    
    Parameters:
    
    oldts - The last timestamp that termination was checked
    
    newts - The current timestamp that termination is being checked
    
    Returns:
    
    A LoadInfo describing whether or not the system is in termination.
    
    Throws:
    
    RemoteException
  - barrierJoin
```
public void barrierJoin(String remoteHost)
```
    A means workpool servers to synchronize using a barrier. Only invoked if the workpools are configured to use BARRIER_JOIN and when a task has been removed from the workpool.
    
    Specified by:
    
    barrierJoin in interface LocalWorkpoolServer
    
    Parameters:
    
    remoteHost - The hostname of the server that is joining the barrier.
  - getProgressStatus
```
public ProgressStatus getProgressStatus()
```
    Not used
  - lookupPeers
```
public void lookupPeers(Vector<String> hostList)
```
    Connects to each WorkpoolServer whose hostname is given
    
    Parameters:
    
    hostList - A list of hostnames to connect to
  - reportInitialization
```
public void reportInitialization()
                          throws RemoteException
```
    Specified by:
    
    reportInitialization in interface LocalWorkpoolServer
    
    Throws:
    
    RemoteException
  - reportStartup
```
public void reportStartup()
                   throws RemoteException
```
    Not used
    
    Throws:
    
    RemoteException
  - getStatus
```
public int getStatus()
```
    Not used: Only called from proceedToClustering()
  - setStatusInit
```
public void setStatusInit()
```
    Not used: Only called from reportInitialization()
  - proceedToClustering
```
public void proceedToClustering()
```
    Not used: Only called in the while-loop from PageRankTest to enter clustering
  - broadcast
```
public void broadcast(Task t)
               throws RemoteException
```
    Broadcasts a task to all of its peers
    
    Parameters:
    
    t - The task to broadcast
    
    Throws:
    
    RemoteException - Thrown if the task could not be added to its own workpool
    
    See Also:
    
    lookupPeers(Vector), addTask(Task)
  - addTask
```
public void addTask(Task t)
             throws RemoteException
```
    Adds the given task into the workpool depending on its affinity and targetLocation.
    
    Parameters:
    
    t - The task to be added to the workpool
    
    Throws:
    
    RemoteException
  - addTask
```
public void addTask(Vector<Task> taskVector)
             throws RemoteException
```
    Adds several tasks to the workpool
    
    Throws:
    
    RemoteException
    
    See Also:
    
    addTask(Task)
  - getTask
```
public WorkStatus getTask()
                   throws RemoteException
```
    Attempts to fetch a task from the ready-workpool.
    - If no tasks are available, then the caller is blocked until there are tasks
    - If a job has completed, then regardless of whether or not there are tasks in the workpool, no task is picked up
    - If a task is available, then it is picked up and placed into the active-workpool
    Returns:
    A WorkStatus containing either:
    
    A task from the ready-workpool should there be one
    
    No task with a StatusType.WORK_TERMINATED status if the job was completed
    Throws:
    
    RemoteException
    
    See Also:
    
    reportJobCompletion()
  - getNewTID
```
public String getNewTID()
```
    Returns:
    
    A new transaction id for the given workpool.
  - validate
```
public ValidateResponse validate(Task t,
                                 RWSetInfo rwSetInfo)
                          throws RemoteException
```
    Validates the completed task
    
    Parameters:
    
    t - The task that is to be validated
    
    rwSetInfo - The set of Nodes that the task read and updated
    
    Returns:
    
    Information about the validation. Most important is the whether or not the task can be committed.
    
    Throws:
    
    RemoteException
  - getSTS
```
public long getSTS()
            throws RemoteException
```
    Synchronizes the local stable timestamp with that of the global timestamp
    
    Returns:
    
    The current Stable timestamp of the system
    
    Throws:
    
    RemoteException - Thrown if the ValidationService could not be contacted
  - updateSTS
```
public void updateSTS(long sts)
```
    Updates the local stable timestamp of the system. If sts is earlier than the current local stable timestamp, then nothing happens.
    
    Parameters:
    
    sts - The proposed timestamp to update to.
  - updateLoadInfo
```
public void updateLoadInfo(Vector<LoadInfo> loadVector)
```
    Each workpool caches the LoadInfo of its peers. This is a means for this workpool to refresh its cache.
    
    Parameters:
    
    loadVector - The new loads of each workpool.
  - removeTask
```
public void removeTask(Task t)
```
    Removes a task from the active workpool. If the workpools are configured to use BARRIER-JOIN, then if the load becomes 0, then the caller is blocked until all of its peers have joined the barrier.
    
    Parameters:
    
    t - The task that is to be removed.
  - reportTransactionCompletion
```
public void reportTransactionCompletion(long commitTS)
```
    Allows a task to report the completion of a transaction phase. A task may involve multiple phases. This method does not remove the task from the active workpool. reportCompletion(Task, HashSet) also calls this method, but it also removes the task from the workpool
    
    Parameters:
    
    commitTS - The timestamp at which this transaction was reported
  - reportCompletion
```
public void reportCompletion(Task t,
                             HashSet<Task> tasksCreated)
                      throws RemoteException
```
    A means to report the completion of the execution of a task. If the task created additional tasks upon completion, then they will be distributed to all of the workpools in the cluster.
    
    Parameters:
    
    t - The task that is to reported for completion
    
    tasksCreated - Any tasks created by the completed task
    
    Throws:
    
    RemoteException - Thrown if the created tasks could not be distributed
  - printProgress
```
public void printProgress()
```
  - getStats
```
public String getStats()
```
  - getMyLoad
```
public int getMyLoad()
```
    Returns:
    
    The load of this workpool. If the LOAD_DISTRIBUTOR_VERSION is V2, then the load is the sum of the tasks in the ready and active workpool and the number of pending tasks in the load distributor. Otherwise, it is the sum of the tasks in the ready and active workpool.
    
    See Also:
    
    LoadDistributorV2.getPendingTaskCount(), Config
  - getMyAggregatedLoad
```
public int getMyAggregatedLoad()
```
    Called only by getMyLoad()
    
    Returns:
    
    The sum of the tasks in the ready and active workpool and the number of pending tasks in the load distributor
  - checkTermination
```
public boolean checkTermination()
                         throws RemoteException
```
    A means to check if there are no tasks left in either workpool, if so, the system is in the termination phase.
    
    Returns:
    
    True if the system is in termination, false otherwise.
    
    Throws:
    
    RemoteException

Class LocalWorkpoolImpl

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

Constructor Summary

Method Summary

Methods inherited from class java.rmi.server.UnicastRemoteObject

Methods inherited from class java.rmi.server.RemoteServer

Methods inherited from class java.rmi.server.RemoteObject

Methods inherited from class java.lang.Object

Field Detail

validationService

wpoolHandles

loadInfoTable

peerList

localDepStats

logBuffer

configParams

INIT_PENDING

INIT

JOB_STARTED

JOB_FINISHED

BARRIER_PENDING

BARRIER_FINISHED

SLEEP_TIME

GAP_TIME

STS_DELAY

LOAD_DISTRIBUTOR_VERSION

modelType

myHost

abortOnStartCounter

RPC_MECHANISM

Constructor Detail

LocalWorkpoolImpl

Method Detail

depositTasks

depositTask

reportJobCompletion

reportAbortOnStart

getLoadInfo

getTerminationStatus

barrierJoin

getProgressStatus

lookupPeers

reportInitialization

reportStartup

getStatus

setStatusInit

proceedToClustering

broadcast

addTask

addTask

getTask

getNewTID

validate

getSTS

updateSTS

updateLoadInfo

removeTask

reportTransactionCompletion

reportCompletion

printProgress

getStats

getMyLoad

getMyAggregatedLoad

checkTermination