uk.ac.soton.itinnovation.grid.service.utils.reportapi
Class ReportAPIHelper

java.lang.Object
  uk.ac.soton.itinnovation.grid.service.utils.reportapi.ReportAPIHelper

public class ReportAPIHelper
extends Object

Constructor Summary

ReportAPIHelper()

Method Summary

void	addAtomEvents(Document doc, URL serviceAddress, String serviceBase) If there is a problem with the queue, add a message for the service administrator to the Atom document.
void	addCumulativeUsageReport(org.apache.axis.message.addressing.EndpointReferenceType EPR, Metric metric, double amount) Cumulative usage report with one time creation helper method.
void	addCumulativeUsageReport(org.apache.axis.message.addressing.EndpointReferenceType EPR, Metric metric, double amount, GregorianCalendar startTime) Add a cumulative usage report between the given time and now.
void	addInstantaneousUsageReport(org.apache.axis.message.addressing.EndpointReferenceType EPR, Metric metric, double amount) Add an instantaneous usage report for usage at the current time.
void	addUsageReport(org.apache.axis.message.addressing.EndpointReferenceType EPR, UsageReport message) Deprecated. See addUsageReports(org.apache.axis.message.addressing.EndpointReferenceType, uk.ac.soton.itinnovation.grid.service.types.UsageReport...).
void	addUsageReports(org.apache.axis.message.addressing.EndpointReferenceType EPR, UsageReport... messages) Add messages to the queue.
NotificationMessage[]	getMessages()
NotificationMessage[]	getMessagesN(int MaximumNumber) Returns MaximumNumber usage messages

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportAPIHelper

public ReportAPIHelper()

Method Detail

addUsageReport

public void addUsageReport(org.apache.axis.message.addressing.EndpointReferenceType EPR,
                           UsageReport message)

Deprecated. See addUsageReports(org.apache.axis.message.addressing.EndpointReferenceType, uk.ac.soton.itinnovation.grid.service.types.UsageReport...).

addUsageReports

public void addUsageReports(org.apache.axis.message.addressing.EndpointReferenceType EPR,
                            UsageReport... messages)

Add messages to the queue. It wraps the messages in a notification message first.

Parameters:

EPR - activity generating the reports

messages - usage messages

addCumulativeUsageReport

public void addCumulativeUsageReport(org.apache.axis.message.addressing.EndpointReferenceType EPR,
                                     Metric metric,
                                     double amount)

Cumulative usage report with one time creation helper method. This method also feeds the queue.

addInstantaneousUsageReport

public void addInstantaneousUsageReport(org.apache.axis.message.addressing.EndpointReferenceType EPR,
                                        Metric metric,
                                        double amount)

Add an instantaneous usage report for usage at the current time.

addCumulativeUsageReport

public void addCumulativeUsageReport(org.apache.axis.message.addressing.EndpointReferenceType EPR,
                                     Metric metric,
                                     double amount,
                                     GregorianCalendar startTime)

Add a cumulative usage report between the given time and now.

getMessagesN

public NotificationMessage[] getMessagesN(int MaximumNumber)

Returns MaximumNumber usage messages

Returns:

an array containing MaximumNumber Usage messages.

getMessages

public NotificationMessage[] getMessages()

addAtomEvents

public void addAtomEvents(Document doc,
                          URL serviceAddress,
                          String serviceBase)

If there is a problem with the queue, add a message for the service administrator to the Atom document.

Parameters:

doc - Atom feed being constructed

serviceBase - URL of a web page for service administration