The Audit API provides a way to create special logs that contain permanent records of activity in a Rapture system. Internally Rapture uses a system audit log for recording important events that take place in a Rapture environment. Users (or applications) can create their own custom audit logs for the same purpose.

The API provides a way of creating and removing these logs, along with a simple way of recording log entries. A final API call gives the caller the ability to retrieve log entries.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.setup(force);

retVal = baseAPI.doAudit_Setup(force);

Entitlement: /audit/admin

Sets up anything needed for audit to run properly. This should be called from the _startup.rfx script. This call is used internally by Rapture on startup, and is normally called only for debugging purposes.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.createAuditLog(name, config);

retVal = baseAPI.doAudit_CreateAuditLog(name, config);

Entitlement: /audit/admin

This method creates a new audit log, given a name and a config string. The config string defines the implementation to be used to store the audit entries.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
boolean retVal = auditApi.doesAuditLogExist(logURI);

retVal = baseAPI.doAudit_DoesAuditLogExist(logURI);

Entitlement: /audit/main

This method checks whether an audit log exists at the specified URI. The log must have been created using createAuditLog.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
List<RaptureFolderInfo> retVal = auditApi.getChildren(prefix);

retVal = baseAPI.doAudit_GetChildren(prefix);

Entitlement: /audit/main

This method searches for audit logs whose name follows the pattern prefix/anything_else/under/here, where prefix is the argument that is passed in.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.deleteAuditLog(logURI);

retVal = baseAPI.doAudit_DeleteAuditLog(logURI);

Entitlement: /audit/admin

This method removes a previously created audit log.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
AuditLogConfig retVal = auditApi.getAuditLog(logURI);

retVal = baseAPI.doAudit_GetAuditLog(logURI);

Entitlement: /audit/admin

This method retrieves the config information for a previously created audit log.

Stores the config information for an audit log.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.writeAuditEntry(logURI, category, level, message);

retVal = baseAPI.doAudit_WriteAuditEntry(logURI, category, level, message);

Entitlement: /audit/admin

This method writes an audit entry to the audit log specified by the URI parameter.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
void retVal = auditApi.writeAuditEntryData(logURI, category, level, message, data);

retVal = baseAPI.doAudit_WriteAuditEntryData(logURI, category, level, message, data);

Entitlement: /audit/admin

This method writes an audit entry to an audit log.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
List<AuditLogEntry> retVal = auditApi.getRecentLogEntries(logURI, count);

retVal = baseAPI.doAudit_GetRecentLogEntries(logURI, count);

Entitlement: /audit/admin

This method retrieves previously registered log entries, given a maximum number of entries to return.

HttpAuditApi auditApi = new HttpAuditApi(loginApi);
List<AuditLogEntry> retVal = auditApi.getEntriesSince(logURI, when);

retVal = baseAPI.doAudit_GetEntriesSince(logURI, when);

Entitlement: /audit/main

This method retrieves any entries since a given entry was retrieved. The date of this audit entry is used to determine the start point of the query.

Defines an audit result to be logged.