org.eclipse.higgins.audit.api
Interface AuditRecord

All Superinterfaces:

org.eclipse.higgins.configuration.api.IConfigurableComponent

public interface AuditRecord

extends org.eclipse.higgins.configuration.api.IConfigurableComponent

Method Summary

void	addEventInfo(String strInfoName, String strInfoValue) Add the event information to the audit record.
void	clearRecord() Clear all information in the audit record.
String	formatRecord() Format an audit record for output to the audit log.
void	setEventNumber(int iEventNumber) Set the event number for an audit record.
void	setInitiatorInfo(String strAuthAuthority, String strDomainSpecificName, String strDomainSpecificId) Set the initiator information in the audit record.
void	setOriginatorInfo(String strOriginatorLocationName, String strOriginatorLocationAddress, String strOriginatorServiceType, String strOriginatorAuthAuthority, String strOriginatorPrincipalName, String strOriginatorPrincipalIdentity) Set the originator information for the record.
void	setOutcome(int iOutcome) Set the outcome in the audit record.
void	setTargetInfo(String strTargetLocationName, String strTargetLocationAddress, String strTargetServiceType, String strTargetAuthAuthority, String strTargetPrincipalName, String strTargetPrincipalIdentity) Set the target information in the audit record.
void	setTimeStamp() Set a timestamp for the audit record to current time.

Methods inherited from interface org.eclipse.higgins.configuration.api.IConfigurableComponent

configure, getComponentDescriptor

Method Detail

setOriginatorInfo

public void setOriginatorInfo(String strOriginatorLocationName,
                              String strOriginatorLocationAddress,
                              String strOriginatorServiceType,
                              String strOriginatorAuthAuthority,
                              String strOriginatorPrincipalName,
                              String strOriginatorPrincipalIdentity)
                       throws AuditException

Set the originator information for the record.

Parameters:

strOriginatorLocationName - Location name component of the originator information.

strOriginatorLocationAddress - Location address component of the originator information.

strOriginatorServiceType - Service type component of the originator information.

strOriginatorAuthAuthority - Authorization authority component of the originator information.

strOriginatorPrincipalName - Principal name component of the originator information.

strOriginatorPrincipalIdentity - Principal identity component of the originator information.

Throws:

AuditException

setEventNumber

public void setEventNumber(int iEventNumber)
                    throws AuditException

Set the event number for an audit record.

Parameters:

iEventNumber - The event number of the detected event. Only event numbers defined in AuditEvents are valid. Any other event number will result in an exception being thrown.

Throws:

AuditException

setOutcome

public void setOutcome(int iOutcome)
                throws AuditException

Set the outcome in the audit record.

Parameters:

iOutcome - The outcome of the event determined by the caller. Only the outcome codes defined in AuditOutcomes are valid. Use AuditOutcomes.AUDIT_OUT_NOT_SPECIFIED for unspecified.

Throws:

AuditException

setInitiatorInfo

public void setInitiatorInfo(String strAuthAuthority,
                             String strDomainSpecificName,
                             String strDomainSpecificId)
                      throws AuditException

Set the initiator information in the audit record.

Parameters:

strAuthAuthority - The authorization authority component of the initiator information.

strDomainSpecificName - The domain specific name component of the initiator information.

strDomainSpecificId - The domain specific ID component of the initiator information.

Throws:

AuditException

setTargetInfo

public void setTargetInfo(String strTargetLocationName,
                          String strTargetLocationAddress,
                          String strTargetServiceType,
                          String strTargetAuthAuthority,
                          String strTargetPrincipalName,
                          String strTargetPrincipalIdentity)
                   throws AuditException

Set the target information in the audit record.

Parameters:

strTargetLocationName - The location name component of the target information.

strTargetLocationAddress - The location address component of the target information.

strTargetServiceType - The service type component of the target information.

strTargetAuthAuthority - The authorization authority component of the target information.

strTargetPrincipalName - The principal name component of the target information.

strTargetPrincipalIdentity - The principal identity component of the target information.

Throws:

AuditException

addEventInfo

public void addEventInfo(String strInfoName,
                         String strInfoValue)
                  throws AuditException

Add the event information to the audit record.

Parameters:

strInfoName - The name of the event information.

strInfoValue - The value for the event information.

Throws:

AuditException

formatRecord

public String formatRecord()
                    throws AuditException

Format an audit record for output to the audit log.

This method formats the audit record for the audit stream. If no prior call to the setTimeStamp method has been made, this method will also set the timestamp for the record.

Throws:

AuditException

clearRecord

public void clearRecord()

Clear all information in the audit record.

setTimeStamp

public void setTimeStamp()

Set a timestamp for the audit record to current time.