uk.ac.ed.epcc.safe.accounting.parsers

Class GlobusJobManagerParser

java.lang.Object

uk.ac.ed.epcc.safe.accounting.update.AbstractPropertyContainerUpdater

uk.ac.ed.epcc.safe.accounting.update.AbstractPropertyContainerParser

uk.ac.ed.epcc.safe.accounting.parsers.GlobusJobManagerParser

All Implemented Interfaces:

IncrementalPropertyContainerParser, PropertyContainerParser, PropertyContainerUpdater

public class GlobusJobManagerParser
extends AbstractPropertyContainerParser
implements IncrementalPropertyContainerParser

Parser for Globus JobManager records. As these are event logs we need to use an incremental parser. Optionally other accounting records can be linked to the entries of this table in a manner similar to LinkPolicy. The remote table is identified based on the jobmanager type. If the property; GlobusJobManagerParser.table.jobmanager-type is set then this is used as the table name of master table (Assumed to support the batch:JobID and batch:SubmittedTimestamp and batch:JobId properties). When a remote table is configured the record will not evaluate as complete until the master record has been located.

Author:

spb

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyTag<java.lang.String>	GLOBUS_DN
static PropertyTag<java.util.Date>	GLOBUS_END_DATE
static PropertyTag<java.util.Date>	GLOBUS_EXEC_DATE
static PropertyTag<java.lang.String>	GLOBUS_JOBID
static PropertyTag<java.lang.String>	GLOBUS_JOBTYPE
static PropertyTag<java.lang.String>	GLOBUS_JOBTYPEID
static PropertyTag<java.lang.String>	GLOBUS_MANAGER
static PropertyTag<java.lang.Integer>	GLOBUS_PARENT_ID Id of parent record.
static PropertyTag<java.util.Date>	GLOBUS_START_DATE
static PropertyTag<java.lang.String>	GLOBUS_SUBMIT_HOST
static PropertyTag<java.lang.String>	GLOBUS_USERNAME

Fields inherited from class uk.ac.ed.epcc.safe.accounting.update.AbstractPropertyContainerParser

DUPLICATE_KEY

Constructor Summary

Constructors

Constructor and Description
GlobusJobManagerParser()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	endParse() End a batch parse this de-allocates any temporary storage and and perform any final operations.
PropertyFinder	initFinder(uk.ac.ed.epcc.webapp.AppContext ctx, PropertyFinder prev, java.lang.String table) Generate a PropertyFinder that will find any PropertyTag generated by this class.
boolean	isComplete(UsageRecord record) Are all the necessary properties present in the record.
boolean	parse(PropertyMap map, java.lang.String record) Parse a String representation of the UsageRecord.
void	postComplete(UsageRecord record) Once record has been marked as complete apply any side effects.
void	startParse(PropertyContainer staticProps) Start a batch parse.

Methods inherited from class uk.ac.ed.epcc.safe.accounting.update.AbstractPropertyContainerParser

getDefaultUniqueProperties, modifyDefaultTableSpecification, splitRecords, unique

Methods inherited from class uk.ac.ed.epcc.safe.accounting.update.AbstractPropertyContainerUpdater

getDerivedProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.update.PropertyContainerParser

getDefaultUniqueProperties, splitRecords

Methods inherited from interface uk.ac.ed.epcc.safe.accounting.update.PropertyContainerUpdater

getDerivedProperties, modifyDefaultTableSpecification

Field Detail

GLOBUS_USERNAME

@AutoTable(target=java.lang.String.class)
public static final PropertyTag<java.lang.String> GLOBUS_USERNAME

GLOBUS_DN

@AutoTable(target=java.lang.String.class,
           length=128)
public static final PropertyTag<java.lang.String> GLOBUS_DN

GLOBUS_SUBMIT_HOST

@AutoTable(target=java.lang.String.class,
           length=512)
public static final PropertyTag<java.lang.String> GLOBUS_SUBMIT_HOST

GLOBUS_MANAGER

@AutoTable(target=java.lang.String.class)
public static final PropertyTag<java.lang.String> GLOBUS_MANAGER

GLOBUS_JOBID

@AutoTable(target=java.lang.String.class)
public static final PropertyTag<java.lang.String> GLOBUS_JOBID

GLOBUS_JOBTYPEID

@AutoTable(target=java.lang.String.class,
           unique=true,
           length=128)
public static final PropertyTag<java.lang.String> GLOBUS_JOBTYPEID

GLOBUS_JOBTYPE

@OptionalTable
public static final PropertyTag<java.lang.String> GLOBUS_JOBTYPE

GLOBUS_START_DATE

@AutoTable(target=java.util.Date.class)
public static final PropertyTag<java.util.Date> GLOBUS_START_DATE

GLOBUS_END_DATE

@AutoTable(target=java.util.Date.class)
public static final PropertyTag<java.util.Date> GLOBUS_END_DATE

GLOBUS_EXEC_DATE

@AutoTable(target=java.util.Date.class)
public static final PropertyTag<java.util.Date> GLOBUS_EXEC_DATE

GLOBUS_PARENT_ID

@AutoTable(target=java.lang.Integer.class)
public static final PropertyTag<java.lang.Integer> GLOBUS_PARENT_ID

Id of parent record. This can't be a reference tag as there may be multiple parent tables. This field is needed in order to identify complete records/

Constructor Detail

GlobusJobManagerParser

public GlobusJobManagerParser()

Method Detail

parse

public boolean parse(PropertyMap map,
            java.lang.String record)
              throws AccountingParseException

Description copied from interface: PropertyContainerParser

Parse a String representation of the UsageRecord. If the parse needs to be aborted throw and AccountingParseException. If the parse cannot succeed but no error needs to be reported (e.g. an empty or comment line) this method can return false

Specified by:

parse in interface PropertyContainerParser

Throws:

AccountingParseException

Parameters:

map - PropertyMap to add quantities

Returns:

true if parse ok

initFinder

public PropertyFinder initFinder(uk.ac.ed.epcc.webapp.AppContext ctx,
                        PropertyFinder prev,
                        java.lang.String table)

Description copied from interface: PropertyContainerUpdater

Generate a PropertyFinder that will find any PropertyTag generated by this class. This call should be treated as a secondary constructor and should be called before any other method from this interface.

All properties defined at run-time should have their PropertyTag objects constructed by the time the first call to this method returns. As some parsers properties will generate different things depending on the other properties already in scope this method is passed a PropertyFinder for any properties that may already be in scope. This will include any default parameters specified when the data was uploaded and any properties generated from the database meta-data. Though it is perfectly legal to return a PropertyFinder that returns a superset of the generated properties the only requirement is that the returned finder can find any property that this classes parse method may actually generate values for. So Normally the contents of the super-finder are not included in the result unless these values are actually generated by the parse. If values are generated then a MultiFinder can be populated with the PropertyRegistrys from the generated properties

Specified by:

initFinder in interface PropertyContainerUpdater

prev - PropertyFinder for the higher levels in the call chain.

table - String name of the destination table in case per-table customisation is needed

Returns:

PropertyFinder or null

isComplete

public boolean isComplete(UsageRecord record)

Description copied from interface: IncrementalPropertyContainerParser

Are all the necessary properties present in the record. Once this method resolves as true the parse process will assume the record is complete and not update again. Note that the properties checked for in this method MUST be persisted in the database.

Specified by:

isComplete in interface IncrementalPropertyContainerParser

Returns:

boolean true if record is complete

endParse

public java.lang.String endParse()

Description copied from interface: PropertyContainerUpdater

End a batch parse this de-allocates any temporary storage and and perform any final operations.

Specified by:

endParse in interface PropertyContainerUpdater

Overrides:

endParse in class AbstractPropertyContainerUpdater

Returns:

Error string if any

startParse

public void startParse(PropertyContainer staticProps)
                throws java.lang.Exception

Description copied from interface: PropertyContainerUpdater

Start a batch parse. This allocates any temporary state appropriate to the policy. Some properties may be set globally for all records in the parse rather than provided record by record. The startParse method is passed all known properties of this type as they may be useful in setting up the parse. There is no requirement to process these in any way.

Specified by:

startParse in interface PropertyContainerUpdater

Overrides:

startParse in class AbstractPropertyContainerUpdater

Throws:

java.lang.Exception

Parameters:

staticProps - properties constant for this accounting run.

postComplete

public void postComplete(UsageRecord record)
                  throws java.lang.Exception

Description copied from interface: IncrementalPropertyContainerParser

Once record has been marked as complete apply any side effects. This occurs immediately before the policy postComplete

Specified by:

postComplete in interface IncrementalPropertyContainerParser

Throws:

java.lang.Exception