uk.ac.ed.epcc.safe.accounting.policy

Class LinkPolicy

java.lang.Object

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

uk.ac.ed.epcc.safe.accounting.policy.BasePolicy

uk.ac.ed.epcc.safe.accounting.policy.BaseUsageRecordPolicy

uk.ac.ed.epcc.safe.accounting.policy.LinkPolicy

All Implemented Interfaces:

SummaryProvider, PropertyContainerPolicy, PropertyContainerUpdater, UsageRecordPolicy, uk.ac.ed.epcc.webapp.jdbc.table.TransitionSource<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>

public class LinkPolicy
extends BaseUsageRecordPolicy
implements SummaryProvider, uk.ac.ed.epcc.webapp.jdbc.table.TransitionSource<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>

LinkPolicy is used to cross link two accounting tables when the raw data is spread across two different sources. For example when using a globus-jobmanager to submit jobs to a batch system. Most of the required data is in the batch accounting log but information about the connection credentials is only available in the job-manager log.

One table is defined as the primary table and data is loaded to this table first. This policy is added to the secondary table. It will generate a SkipRecord exception if a corresponding primary record is not found (This is to protect against the data being loaded out of sequence). This will prevent this policy from working with a IncrementalPropertyContainerParser

Configuration Properties:

• LinkPolicy.target.table-name defines the remote table we are linking to.
• LinkPolicy.link.table-name.local-prop defines a property name in the remote table that has to match local-prop in the local table.
• LinkPolicy.grace.table-name defines a matching threshold (in seconds) for time properties. Properties are taken as matching if they are within the specified threshold. Defaults to 4000 seconds.

If a match is found the ReferenceProperty to the primary table is set in the parse method. Then in the PostCreate method the remote object is updated to set the back-reference (if there is one) and the any common properties (based on simple names) that are not already set.

Note that as the mapping between primary and secondary tables is expected to be one-to-one, at the very least this makes joins inefficient but there may also be serious performance and memory problems if the secondary table is used in code written assuming small classifier tables. Properties that may be used to group queries should therefore be duplicated in the primary table where they can be set by the PostCreate method.

Author:

spb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LinkPolicy.SetRemoteAction
class	LinkPolicy.SetRemoteTransition

Constructor Summary

Constructors

Constructor and Description
LinkPolicy()

Method Summary

Methods

Modifier and Type	Method and Description
void	getTableTransitionSummary(uk.ac.ed.epcc.webapp.content.ContentBuilder hb, uk.ac.ed.epcc.webapp.session.SessionService operator)
java.util.Map<uk.ac.ed.epcc.webapp.model.data.transition.TransitionKey<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>,uk.ac.ed.epcc.webapp.forms.transition.Transition<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>>	getTransitions()
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.
void	parse(PropertyMap rec) Generate additional properties based on properties from the basic parse and previously applied Policies
void	postCreate(PropertyContainer props, UsageRecord r) once record has been committed apply any side effects such as budget charging.

Methods inherited from class uk.ac.ed.epcc.safe.accounting.policy.BaseUsageRecordPolicy

allowReplace, preDelete

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

endParse, getDerivedProperties, modifyDefaultTableSpecification, startParse, unique

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.PropertyContainerUpdater

endParse, getDerivedProperties, modifyDefaultTableSpecification, startParse

Constructor Detail

LinkPolicy

public LinkPolicy()

Method Detail

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

parse

public void parse(PropertyMap rec)
           throws AccountingParseException

Description copied from interface: PropertyContainerPolicy

Generate additional properties based on properties from the basic parse and previously applied Policies

Specified by:

parse in interface PropertyContainerPolicy

Overrides:

parse in class BasePolicy

Throws:

AccountingParseException

Parameters:

rec - PropertyMap being modified

postCreate

public void postCreate(PropertyContainer props,
              UsageRecord r)
                throws java.lang.Exception

Description copied from interface: UsageRecordPolicy

once record has been committed apply any side effects such as budget charging.

Specified by:

postCreate in interface UsageRecordPolicy

Overrides:

postCreate in class BaseUsageRecordPolicy

Throws:

java.lang.Exception

Parameters:

props - Full set of properties from the parse stage

r - The actual committed record

getTableTransitionSummary

public void getTableTransitionSummary(uk.ac.ed.epcc.webapp.content.ContentBuilder hb,
                             uk.ac.ed.epcc.webapp.session.SessionService operator)

Specified by:

getTableTransitionSummary in interface SummaryProvider

getTransitions

public java.util.Map<uk.ac.ed.epcc.webapp.model.data.transition.TransitionKey<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>,uk.ac.ed.epcc.webapp.forms.transition.Transition<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>> getTransitions()

Specified by:

getTransitions in interface uk.ac.ed.epcc.webapp.jdbc.table.TransitionSource<uk.ac.ed.epcc.webapp.jdbc.table.TableTransitionTarget>