NullRmStatePersistence (Apache UIMA DUCC: uima-ducc-common 2.2.1 API)

java.lang.Object
- org.apache.uima.ducc.common.persistence.rm.NullRmStatePersistence

All Implemented Interfaces:

IRmPersistence
```
public class NullRmStatePersistence
extends Object
implements IRmPersistence
```
This class allows a persistence object to be created even if none is configured, without crashes or NPEs.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.apache.uima.ducc.common.persistence.rm.IRmPersistence
  IRmPersistence.RmLoad, IRmPersistence.RmNodes, IRmPersistence.RmShares

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAssignment(String id, DuccId jobid, IDbShare shareid, int quantum, String type)` Assign a share to this machine.
`void`	`addJob(IDbJob j)` A new job arrives (or is recovered after restart).
`void`	`clear()` When RM performs its configuration it must call this to clear the db of existing nodes.
`void`	`close()` Shutdown the connection to the DB;
`void`	`createMachine(String id, Map<IRmPersistence.RmNodes,Object> props)` Write full information about a mach9ne into the DB.
`void`	`deleteJob(IDbJob j)` A job has left the system forever.
`Map<String,Map<String,Object>>`	`getAllMachines()` Fetch all machines in the database.
`Map<String,Map<String,Object>>`	`getAllShares()` Fetch all shares in the database.
`List<Map<String,Object>>`	`getLoad()` Fetch all the load records.
`Properties`	`getMachine(String id)` Fetch a machine by its id.
`void`	`init(DuccLogger logger)` Establish a logger and anything else the persistence may need.
`void`	`removeAssignment(String id, DuccId jobid, IDbShare shareid)` Remove a share from the machine.
`void`	`setEvicted(String node, DuccId shareId, DuccId jobId, boolean val)` Update a share definition to show it is evicted aka preempted by RM.
`void`	`setFixed(String node, DuccId shareId, DuccId jobId, boolean val)` Update a share definition to show it is non-preemptable.
`void`	`setNodeProperties(String id, Object... props)` Set multiple properties in one swell foop.
`void`	`setNodeProperty(String id, IRmPersistence.RmNodes key, Object value)` Set a property on an object.
`void`	`setPurged(String node, DuccId shareId, DuccId jobId, boolean val)` Update a share definition to show it is non-preemptable.
`void`	`updateDemand(IDbJob j)` How many shares to I want from the scheduler?
`void`	`updateShare(String node, DuccId shareid, DuccId jobid, long investment, String state, long init_time, long pid)` Update current information about the share from the current OR publication.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - init
```
public void init(DuccLogger logger)
          throws Exception
```
    Description copied from interface: IRmPersistence
    
    Establish a logger and anything else the persistence may need.
    
    Specified by:
    
    init in interface IRmPersistence
    
    Parameters:
    logger - This is the logger to be used. It is usually the same logger as the client of persistence, e.g. org.apache.uima.ducc.rm. The implementor is required to adjust itself to use this logger to insure messages are logged into the right log.
    
    Throws:
    
    Exception
  - clear
```
public void clear()
```
    Description copied from interface: IRmPersistence
    
    When RM performs its configuration it must call this to clear the db of existing nodes. As nodes rejoin they'll be added back. This is consistent with the RM's internal management, which also drops it's structures and rebuilds them on (re)configuration.
    
    Specified by:
    
    clear in interface IRmPersistence
  - close
```
public void close()
```
    Description copied from interface: IRmPersistence
    
    Shutdown the connection to the DB;
    
    Specified by:
    
    close in interface IRmPersistence
  - setNodeProperty
```
public void setNodeProperty(String id,
                   IRmPersistence.RmNodes key,
                   Object value)
```
    Description copied from interface: IRmPersistence
    
    Set a property on an object. If the property cannot be set the action is rolled back an the underlying store is unchanged.
    
    Specified by:
    
    setNodeProperty in interface IRmPersistence
    
    Parameters:
    id - This is the primary key and is usually the name of a host.
    key - This is the property key.
    value - This is the value to set.
  - setNodeProperties
```
public void setNodeProperties(String id,
                     Object... props)
```
    Description copied from interface: IRmPersistence
    
    Set multiple properties in one swell foop.
    
    Specified by:
    
    setNodeProperties in interface IRmPersistence
    
    Parameters:
    id - This is the primary key, the machine name;
    props - These are the props, must be presented in the form of (String, Object) ...
  - createMachine
```
public void createMachine(String id,
                 Map<IRmPersistence.RmNodes,Object> props)
```
    Description copied from interface: IRmPersistence
    
    Write full information about a mach9ne into the DB. We assume the machine does not exist but in case it does, it is fully deleted first, and then re-saved. If the recored cannot be saved the action is rolled back an the underlying store is unchanged.
    
    Specified by:
    
    createMachine in interface IRmPersistence
    
    Parameters:
    id - This is the primary key and is usually the name of a host.
    props - This is the full set of properties to be set.
  - addAssignment
```
public void addAssignment(String id,
                 DuccId jobid,
                 IDbShare shareid,
                 int quantum,
                 String type)
```
    Description copied from interface: IRmPersistence
    
    Assign a share to this machine.
    
    Specified by:
    
    addAssignment in interface IRmPersistence
    
    Parameters:
    id - The node name
    jobid - The duccid of the job owning the new shoare
    quantum - The scheduling quantum in GB used for this share.
  - removeAssignment
```
public void removeAssignment(String id,
                    DuccId jobid,
                    IDbShare shareid)
```
    Description copied from interface: IRmPersistence
    
    Remove a share from the machine.
    
    Specified by:
    
    removeAssignment in interface IRmPersistence
    
    Parameters:
    id - The node name
    jobid - The duccid of the job owning the new shoare
  - setEvicted
```
public void setEvicted(String node,
              DuccId shareId,
              DuccId jobId,
              boolean val)
```
    Description copied from interface: IRmPersistence
    
    Update a share definition to show it is evicted aka preempted by RM.
    
    Specified by:
    
    setEvicted in interface IRmPersistence
    
    Parameters:
    node - The node where the share resides.
    shareId - The (RM-assigned) DuccId of the share.
    jobId - The OR-assigned DuccId of the job.
    val - True if it is evicted. Once evicted it can not be un-evicted so RM never sets this false. NOTE: The triple (node, shareid, jobid) form the primary key to find the share in the DB
  - setFixed
```
public void setFixed(String node,
            DuccId shareId,
            DuccId jobId,
            boolean val)
```
    Description copied from interface: IRmPersistence
    
    Update a share definition to show it is non-preemptable.
    
    Specified by:
    
    setFixed in interface IRmPersistence
    
    Parameters:
    node - The node where the share resides.
    shareId - The (RM-assigned) DuccId of the share.
    jobId - The OR-assigned DuccId of the job.
    val - True if it is non-preemptable, false otherwise. NOTE: The triple (node, shareid, jobid) form the primary key to find the share in the DB
  - setPurged
```
public void setPurged(String node,
             DuccId shareId,
             DuccId jobId,
             boolean val)
```
    Description copied from interface: IRmPersistence
    
    Update a share definition to show it is non-preemptable.
    
    Specified by:
    
    setPurged in interface IRmPersistence
    
    Parameters:
    node - The node where the share resides.
    shareId - The (RM-assigned) DuccId of the share.
    jobId - The OR-assigned DuccId of the job.
    val - True if it is non-preemptable. RM will never set this false. NOTE: The triple (node, shareid, jobid) form the primary key to find the share in the DB
  - updateShare
```
public void updateShare(String node,
               DuccId shareid,
               DuccId jobid,
               long investment,
               String state,
               long init_time,
               long pid)
```
    Description copied from interface: IRmPersistence
    
    Update current information about the share from the current OR publication.
    
    Specified by:
    
    updateShare in interface IRmPersistence
    
    Parameters:
    node - The node where the share resides.
    investment - The "investment", i.e. amount of CPU expended by the process in the share so far.
    state - The OR-assigned state of the process in the share.
    init_time - The time the process spent in its initialization phase.
    pid - The *ix process id of the process in the share. NOTE: The triple (node, shareid, jobid) form the primary key to find the share in the DB
  - getMachine
```
public Properties getMachine(String id)
```
    Description copied from interface: IRmPersistence
    
    Fetch a machine by its id.
    
    Specified by:
    
    getMachine in interface IRmPersistence
    
    Parameters:
    id - This is the name of a specific machine and must exactly match the name of a machine in the DB.
    
    Returns:
    A properties object containing full details about the machine, or null if no such machine exists.
  - getAllMachines
```
public Map<String,Map<String,Object>> getAllMachines()
```
    Description copied from interface: IRmPersistence
    
    Fetch all machines in the database.
    
    Specified by:
    
    getAllMachines in interface IRmPersistence
    
    Returns:
    A map of map objects containing full details about the machines, keyed on machine name. If there are no machines found in the db, an empty map is returned.
  - getAllShares
```
public Map<String,Map<String,Object>> getAllShares()
```
    Description copied from interface: IRmPersistence
    
    Fetch all shares in the database.
    
    Specified by:
    
    getAllShares in interface IRmPersistence
    
    Returns:
    A map of map objects containing full details about the shares. The key is node:jobid:shareid concatenated as a string, as it takes all of these to uniquely identify a share. If there are no shares found in the db, an empty map is returned.
  - getLoad
```
public List<Map<String,Object>> getLoad()
```
    Description copied from interface: IRmPersistence
    
    Fetch all the load records. These are relatively short, one per job/reservation/etc in the database, summarizing the resources they have vs the resources they want in a perfect world.
    
    Specified by:
    
    getLoad in interface IRmPersistence
    
    Returns:
    A list of map objects containing load information.
  - addJob
```
public void addJob(IDbJob j)
```
    Description copied from interface: IRmPersistence
    
    A new job arrives (or is recovered after restart).
    
    Specified by:
    
    addJob in interface IRmPersistence
  - deleteJob
```
public void deleteJob(IDbJob j)
```
    Description copied from interface: IRmPersistence
    
    A job has left the system forever.
    
    Specified by:
    
    deleteJob in interface IRmPersistence
  - updateDemand
```
public void updateDemand(IDbJob j)
```
    Description copied from interface: IRmPersistence
    
    How many shares to I want from the scheduler?
    
    Specified by:
    
    updateDemand in interface IRmPersistence

Class NullRmStatePersistence

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.uima.ducc.common.persistence.rm.IRmPersistence

Method Summary

Methods inherited from class java.lang.Object

Method Detail

init

clear

close

setNodeProperty

setNodeProperties

createMachine

addAssignment

removeAssignment

setEvicted

setFixed

setPurged

updateShare

getMachine

getAllMachines

getAllShares

getLoad

addJob

deleteJob

updateDemand