gov.nih.nci.cagrid.data.service.auditing
Class DataServiceAuditor

java.lang.Object
  gov.nih.nci.cagrid.data.service.auditing.DataServiceAuditor

Direct Known Subclasses:

FileDataServiceAuditor

public abstract class DataServiceAuditor
extends java.lang.Object

DataServiceAuditor Base class for all data service auditors

Version:

$Id: DataServiceAuditor.java,v 1.3 2007/05/24 16:11:00 dervin Exp $

Author:

David Ervin

Constructor Summary

DataServiceAuditor()

Method Summary

abstract void	auditQueryBegin(QueryBeginAuditingEvent event)
abstract void	auditQueryProcessingFailed(QueryProcessingFailedAuditingEvent event)
abstract void	auditQueryResults(QueryResultsAuditingEvent event)
abstract void	auditValidation(ValidationAuditingEvent event)
AuditorConfiguration	getAuditorConfiguration()
protected java.util.Properties	getConfiguredProperties() Gets the configuration properties as configured by the user and set at runtime.
java.util.Properties	getDefaultConfigurationProperties() Subclasses should override this method to return a Properties instance populated with keys and values representing the default configuration values for this auditor
java.lang.String	getInstanceName() Returns the configured instance name of this auditor.
void	setAuditorConfiguration(AuditorConfiguration config)

Methods inherited from class java.lang.Object

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

Constructor Detail

DataServiceAuditor

public DataServiceAuditor()

Method Detail

getInstanceName

public java.lang.String getInstanceName()

Returns the configured instance name of this auditor. If the configuration is null, a NullPointerException will probably be thrown here

Returns:

The name of this auditor instance

getAuditorConfiguration

public AuditorConfiguration getAuditorConfiguration()

setAuditorConfiguration

public void setAuditorConfiguration(AuditorConfiguration config)

getDefaultConfigurationProperties

public java.util.Properties getDefaultConfigurationProperties()

Subclasses should override this method to return a Properties instance populated with keys and values representing the default configuration values for this auditor

Returns:

The default configuration properties

getConfiguredProperties

protected java.util.Properties getConfiguredProperties()

Gets the configuration properties as configured by the user and set at runtime.

Returns:

The configured Properties

auditQueryBegin

public abstract void auditQueryBegin(QueryBeginAuditingEvent event)

auditValidation

public abstract void auditValidation(ValidationAuditingEvent event)

auditQueryProcessingFailed

public abstract void auditQueryProcessingFailed(QueryProcessingFailedAuditingEvent event)

auditQueryResults

public abstract void auditQueryResults(QueryResultsAuditingEvent event)