oracle.security.jps.service.audit

Interface Auditor

public interface Auditor

Since:

release specific (what release of product did this appear in)

Version:

$Header: jazn/jps/src/jps-api/oracle/security/jps/service/audit/Auditor.java st_j2ee_sregmi_audit_jps_service/3 2008/07/31 14:48:18 sregmi Exp $

Author:

pdatta

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isEnabled() Check if auditing is enabled to this component.
boolean	isEnabled(java.lang.String eventType, boolean eventStatus, java.util.Map<java.lang.String,java.lang.Object> properties) Deprecated. use isEnabled(String categoryName, String eventType, boolean eventStatus, Map<String, Object> properties)
boolean	isEnabled(java.lang.String categoryName, java.lang.String eventType, boolean eventStatus, java.util.Map<java.lang.String,java.lang.Object> properties) This method is used to do a quick check to see if an event with the given cateory name, event type, event status and additional properties would be logged to the audit repository.
boolean	log(AuditEvent ev) Log an audit event.
void	reloadConfiguration() Reload the Auditor to detect Configuration changes
void	shutdown() Shutdown will close the busstop file.

Method Detail

log

boolean log(AuditEvent ev)
            throws AuditException

Log an audit event. This method at first checks if the event is enabled for logging, if it is enabled then it logs it.

Parameters:

ev - the event to be logged

Returns:

Whether the event was really logged.

Throws:

AuditException

isEnabled

boolean isEnabled(java.lang.String eventType,
                boolean eventStatus,
                java.util.Map<java.lang.String,java.lang.Object> properties)
                  throws AuditException

Deprecated. use isEnabled(String categoryName, String eventType, boolean eventStatus, Map<String, Object> properties)

This method is used to do a quick check to see if an event with the given event type, event status and additional properties would be logged to the audit repository. If this method returns false then the clients can safely assume that log() method would not create a log for the event. However if it returns a true that does not mean that log() method will definitely log the event. It is possible that there is a filter expression, so the decision to log or not cannot be solely based on the eventType and eventStatus. In this case specifying these attributes in the properties parameter will help. But note that some attribute like hostId, applicationName etc are autofilled when log() is called, isEnabled() does not autofill them, so if the expression includes any autofilled attributes, isEnabled will not be able to conclusively determine whether the event needs to be logged and will return true to be on the safe side. The return value of log() will indicate whether it got logged or not. the AuditFilterEngine's isEnabled(...) method.

Parameters:

eventType - type of event

eventStatus - status of event - success or failure

properties - additional attributes

Returns:

whether the event is enabled

Throws:

AuditException

Since:

1.0

isEnabled

boolean isEnabled(java.lang.String categoryName,
                java.lang.String eventType,
                boolean eventStatus,
                java.util.Map<java.lang.String,java.lang.Object> properties)
                  throws AuditException

This method is used to do a quick check to see if an event with the given cateory name, event type, event status and additional properties would be logged to the audit repository. If this method returns false then the clients can safely assume that log() method would not create a log for the event. However if it returns a true that does not mean that log() method will definitely log the event. It is possible that there is a filter expression, so the decision to log or not cannot be solely based on the eventType and eventStatus. In this case specifying these attributes in the properties parameter will help. But note that some attribute like hostId, applicationName etc are autofilled when log() is called, isEnabled() does not autofill them, so if the expression includes any autofilled attributes, isEnabled will not be able to conclusively determine whether the event needs to be logged and will return true to be on the safe side. The return value of log() will indicate whether it got logged or not. the AuditFilterEngine's isEnabled(...) method.

Parameters:

categoryName - the name of event category

eventType - type of event

eventStatus - status of event - success or failure

properties - additional attributes

Returns:

whether the event is enabled

Throws:

AuditException

Since:

2.0

isEnabled

boolean isEnabled()

Check if auditing is enabled to this component. Returns false if the filter level is not set or set to None; returns true if otherwise.

Returns:

true if auditing is enabled to this component.

reloadConfiguration

void reloadConfiguration()
                         throws AuditException

Reload the Auditor to detect Configuration changes

Throws:

AuditException

shutdown

void shutdown()
              throws AuditException

Shutdown will close the busstop file.

Throws:

AuditException