Interface ISecurityAuditInfo

public interface ISecurityAuditInfo
{
  // Methods
  String[] getAuditDetails ();
  String getAuditIdentifier ();
}

This interface provides information to a security auditor about an audited security request. It is implemented by request objects that are passed to any of the parameterized security checks of com.ms.security.PolicyEngine. If the system is configured to audit the request, the auditor uses the information from this interface to determine how to display the request.

Methods

getAuditDetails

String[] getAuditDetails ();

Retrieves strings that describe the parameters of the request. If a localized message for the request is available, the retrieved strings will be used to fill in any placeholders in the message.

Return Value:

Returns an array of strings that describe the request. If there are no parameters to describe, this method returns null.

getAuditIdentifier

String getAuditIdentifier ();

Retrieves a string that identifies the type of the audit event.

Return Value:

Returns a string that identifies the audit event.

Remarks:

The string retrieved will have property or package-like conventions. For example, "com.xyz.database.query.invalid" is a valid return string for this method. An auditor could use the returned string to select a localized format string for displaying the event or for determining types of events to log.