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

All Known Implementing Classes:

NullRmStatePersistence
```
public interface IRmPersistence
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IRmPersistence.RmLoad` This table lists jobs in the system.
`static class`	`IRmPersistence.RmNodes`
`static class`	`IRmPersistence.RmShares`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAssignment(String id, DuccId jobid, IDbShare share, int quantum, String jobtype)` 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 share)` 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... properties)` 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.

- Method Detail
  - init
```
void init(DuccLogger logger)
          throws Exception
```
    Establish a logger and anything else the persistence may need.
    
    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
```
void clear()
           throws Exception
```
    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.
    
    Throws:
    
    Exception
  - setNodeProperties
```
void setNodeProperties(String id,
                     Object... properties)
                       throws Exception
```
    Set multiple properties in one swell foop.
    
    Parameters:
    id - This is the primary key, the machine name;
    properties - These are the props, must be presented in the form of (String, Object) ...
    
    Throws:
    
    Exception
  - setNodeProperty
```
void setNodeProperty(String id,
                   IRmPersistence.RmNodes key,
                   Object value)
                     throws Exception
```
    Set a property on an object. If the property cannot be set the action is rolled back an the underlying store is unchanged.
    
    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.
    
    Throws:
    
    Exception. - Anything that goes wrong throws. Usually the throw will originate in the DB because of some DB issue. An exception causes the action to be rolled back.
    
    Exception
  - createMachine
```
void createMachine(String id,
                 Map<IRmPersistence.RmNodes,Object> props)
                   throws Exception
```
    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.
    
    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.
    
    Throws:
    
    Exception. - Anything that goes wrong throws. Usually the throw will originate in the DB because of some DB issue. An exception causes the action to be rolled back.
    
    Exception
  - addAssignment
```
void addAssignment(String id,
                 DuccId jobid,
                 IDbShare share,
                 int quantum,
                 String jobtype)
                   throws Exception
```
    Assign a share to this machine.
    
    Parameters:
    id - The node name
    jobid - The duccid of the job owning the new shoare
    shareid - The DuccId of the new share.
    quantum - The scheduling quantum in GB used for this share.
    
    Throws:
    
    Exception
  - removeAssignment
```
void removeAssignment(String id,
                    DuccId jobid,
                    IDbShare share)
                      throws Exception
```
    Remove a share from the machine.
    
    Parameters:
    id - The node name
    jobid - The duccid of the job owning the new shoare
    shareid - The DuccId of the new share.
    
    Throws:
    
    Exception
  - setFixed
```
void setFixed(String node,
            DuccId shareId,
            DuccId jobId,
            boolean val)
              throws Exception
```
    Update a share definition to show it is non-preemptable.
    
    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
    
    Throws:
    
    Exception
  - setPurged
```
void setPurged(String node,
             DuccId shareId,
             DuccId jobId,
             boolean val)
               throws Exception
```
    Update a share definition to show it is non-preemptable.
    
    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
    
    Throws:
    
    Exception
  - setEvicted
```
void setEvicted(String node,
              DuccId shareId,
              DuccId jobId,
              boolean val)
                throws Exception
```
    Update a share definition to show it is evicted aka preempted by RM.
    
    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
    
    Throws:
    
    Exception
  - updateShare
```
void updateShare(String node,
               DuccId shareid,
               DuccId jobid,
               long investment,
               String state,
               long init_time,
               long pid)
                 throws Exception
```
    Update current information about the share from the current OR publication.
    
    Parameters:
    node - The node where the share resides.
    shareId - The (RM-assigned) DuccId of the share.
    jobId - The OR-assigned DuccId of the job.
    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
    
    Throws:
    
    Exception
  - getMachine
```
Properties getMachine(String id)
                      throws Exception
```
    Fetch a machine by its id.
    
    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.
    
    Throws:
    
    Exception. - Anything that goes wrong throws. Usually the throw will originate in the DB because of some DB issue.
    
    Exception
  - getAllMachines
```
Map<String,Map<String,Object>> getAllMachines()
                                              throws Exception
```
    Fetch all machines in the database.
    
    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.
    
    Throws:
    
    Exception. - Anything that goes wrong throws. Usually the throw will originate in the DB because of some DB issue.
    
    Exception
  - getAllShares
```
Map<String,Map<String,Object>> getAllShares()
                                            throws Exception
```
    Fetch all shares in the database.
    
    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.
    
    Throws:
    
    Exception. - Anything that goes wrong throws. Usually the throw will originate in the DB because of some DB issue.
    
    Exception
  - getLoad
```
List<Map<String,Object>> getLoad()
                                 throws Exception
```
    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.
    
    Returns:
    A list of map objects containing load information.
    
    Throws:
    
    Exception. - Anything that goes wrong throws. Usually the throw will originate in the DB because of some DB issue.
    
    Exception
  - addJob
```
void addJob(IDbJob j)
            throws Exception
```
    A new job arrives (or is recovered after restart).
    
    Throws:
    
    Exception
  - deleteJob
```
void deleteJob(IDbJob j)
               throws Exception
```
    A job has left the system forever.
    
    Throws:
    
    Exception
  - updateDemand
```
void updateDemand(IDbJob j)
                  throws Exception
```
    How many shares to I want from the scheduler?
    
    Throws:
    
    Exception
  - close
```
void close()
```
    Shutdown the connection to the DB;

Interface IRmPersistence

Nested Class Summary

Method Summary

Method Detail

init

clear

setNodeProperties

setNodeProperty

createMachine

addAssignment

removeAssignment

setFixed

setPurged

setEvicted

updateShare

getMachine

getAllMachines

getAllShares

getLoad

addJob

deleteJob

updateDemand

close