Audit

Data Structures
struct	AUDIT_log_query_s
struct	AUDIT_record_s

Macros
#define	AUDIT_equal   0
#define	AUDIT_greater_than   4
#define	AUDIT_greater_than_or_equal   5
#define	AUDIT_in   7
#define	AUDIT_less_than   2
#define	AUDIT_less_than_or_equal   3
#define	AUDIT_like   6
#define	AUDIT_not_equal   1

Typedefs
typedef struct AUDIT_log_query_s	AUDIT_log_query_t
typedef struct AUDIT_record_s	AUDIT_record_t

Functions
SA_API int	AUDIT_delete_records (AUDIT_log_query_t logQuery)
SA_API int	AUDIT_delete_specified_records (int logCount, char **logUidis)
SA_API int	AUDIT_get_records (AUDIT_log_query_t logQuery, int nConditions, char **conditionValues, int *resColCount, char ***resColNames, QRY_user_query_row_t **resRows)
SA_API int	AUDIT_get_records_with_specified_col (AUDIT_log_query_t logQuery, int nConditions, char **conditionValues, int resColCount, char **resColNames, QRY_user_query_row_t **resRows)
SA_API int	AUDIT_get_records_with_specified_col2 (AUDIT_log_query_t logQuery, int nConditions, char **conditionPropNames, char **conditionValues, int resColCount, char **resColNames, QRY_user_query_row_t **resRows)
SA_API void	AUDIT_initialize_log_query (AUDIT_log_query_t *logQuery)
SA_API int	AUDIT_insert_record (AUDIT_record_t logInfo)
SA_API int	AUDIT_log_event (tag_t targetObject, tag_t objectType, tag_t eventType, const char *objectId, const char *objectName, const char *rev)
SA_API int	AUDIT_log_event2 (tag_t targetObject, tag_t objectType, tag_t eventType, tag_t subEventType, const char *objectId, const char *objectName, const char *rev)
SA_API int	AUDIT_log_event3 (tag_t targetObject, tag_t objectType, tag_t eventType, tag_t subEventType, const char *objectId, const char *objectName, const char *rev, int objectSeq, tag_t secondaryObject, int paramCount, const char **paramNames, const char **paramValues, int errorCode, const char *errorMsg)
SA_API int	AUDIT_log_event4 (tag_t targetObject, tag_t objectType, tag_t eventType, tag_t subEventType, const char *objectId, const char *objectName, const char *rev, int objectSeq, int secondaryObjectTagCount, tag_t *secondaryObjectTags, const char **secondaryObjectQualifiers, int paramCount, const char **paramNames, const char **paramValues, int errorCode, const char *errorMsg)

Detailed Description

Macro Definition Documentation

#define AUDIT_equal   0

Definition at line 33 of file audit.h.

#define AUDIT_greater_than   4

Definition at line 37 of file audit.h.

#define AUDIT_greater_than_or_equal   5

Definition at line 38 of file audit.h.

#define AUDIT_in   7

Definition at line 40 of file audit.h.

#define AUDIT_less_than   2

Definition at line 35 of file audit.h.

#define AUDIT_less_than_or_equal   3

Definition at line 36 of file audit.h.

#define AUDIT_like   6

Definition at line 39 of file audit.h.

#define AUDIT_not_equal   1

Definition at line 34 of file audit.h.

Typedef Documentation

typedef struct AUDIT_log_query_s AUDIT_log_query_t

The following are the field names to be used in constructing the search clause:

1. objectTag
2. eventTypeTag
3. id
4. name
5. rev
6. userId
7. beforeDate
8. afterDate
9. eventTypeName
10. eventTypeName

typedef struct AUDIT_record_s AUDIT_record_t

Function Documentation

SA_API int AUDIT_delete_records

(

AUDIT_log_query_t

logQuery

)

This function is used to delete audit records.

Parameters

logQuery

(I) The criteria of audit records to be deleted

SA_API int AUDIT_delete_specified_records	(	int	logCount,
		char **	logUidis
	)

Parameters

logCount	(I)
logUidis	(I) logCount

SA_API int AUDIT_get_records	(	AUDIT_log_query_t	logQuery,
		int	nConditions,
		char **	conditionValues,
		int *	resColCount,
		char ***	resColNames,
		QRY_user_query_row_t **	resRows
	)

This function is used to find audit logs with a specified search conditions.

Parameters

logQuery	(I) The search conditions such as user, object name/id, event type, and date.
nConditions	(I) The number of search conditions for user defined properties
conditionValues	(I) nConditions The search conditions for user defined properties
resColCount	(O) The number of result columns
resColNames	(OF) resColCount The list of column names
resRows	(OF)

SA_API int AUDIT_get_records_with_specified_col	(	AUDIT_log_query_t	logQuery,
		int	nConditions,
		char **	conditionValues,
		int	resColCount,
		char **	resColNames,
		QRY_user_query_row_t **	resRows
	)

Parameters

logQuery	(I)
nConditions	(I)
conditionValues	(I) nConditions
resColCount	(I)
resColNames	(I)
resRows	(OF)

SA_API int AUDIT_get_records_with_specified_col2	(	AUDIT_log_query_t	logQuery,
		int	nConditions,
		char **	conditionPropNames,
		char **	conditionValues,
		int	resColCount,
		char **	resColNames,
		QRY_user_query_row_t **	resRows
	)

Parameters

logQuery	(I)
nConditions	(I)
conditionPropNames	(I)
conditionValues	(I) nConditions
resColCount	(I)
resColNames	(I)
resRows	(OF)

SA_API void AUDIT_initialize_log_query

(

AUDIT_log_query_t *

logQuery

)

Parameters

logQuery

(O)

SA_API int AUDIT_insert_record

(

AUDIT_record_t

logInfo

)

This function is used to create an audit log for an existing audit log data. This function should be used mainly for migrating the older audit log into the new format.

Parameters

logInfo

(I) The audit log record to be stored in the audit log storage

SA_API int AUDIT_log_event	(	tag_t	targetObject,
		tag_t	objectType,
		tag_t	eventType,
		const char *	objectId,
		const char *	objectName,
		const char *	rev
	)

This function is used to create an audit log for an event.

Parameters

targetObject	(I)
objectType	(I)
eventType	(I)
objectId	(I)
objectName	(I)
rev	(I)

SA_API int AUDIT_log_event2	(	tag_t	targetObject,
		tag_t	objectType,
		tag_t	eventType,
		tag_t	subEventType,
		const char *	objectId,
		const char *	objectName,
		const char *	rev
	)

This function is used to create an audit log for an events type including __Email_Send, __Email_Not_Send.

Parameters

targetObject	(I)
objectType	(I)
eventType	(I)
subEventType	(I) - optional, this is only used for auditing notification email history. In that case, eventType will be __Email_Send or __Email_Not_send, and subEventType field stores the subscribed event name which triggers the notification email send event.
objectId	(I)
objectName	(I)
rev	(I)

SA_API int AUDIT_log_event3	(	tag_t	targetObject,
		tag_t	objectType,
		tag_t	eventType,
		tag_t	subEventType,
		const char *	objectId,
		const char *	objectName,
		const char *	rev,
		int	objectSeq,
		tag_t	secondaryObject,
		int	paramCount,
		const char **	paramNames,
		const char **	paramValues,
		int	errorCode,
		const char *	errorMsg
	)

This function is used to create an audit log for an events type including __Email_Send, __Email_Not_Send. This supports specifying secondary object, optional parameters to be recorded, along with any error code and error message. All these fields are optional.

Parameters

targetObject	(I)
objectType	(I)
eventType	(I)
subEventType	(I) - optional, this is only used for auditing notification email history. In that case, eventType will be __Email_Send or __Email_Not_send, and subEventType field stores the subscribed event name which triggers the notification email send event.
objectId	(I)
objectName	(I)
rev	(I)
objectSeq	(I)
secondaryObject	(I) - optional. Secondary object involved with the event
paramCount	(I) - optional. Count of optional parameters to be recorded
paramNames	(I) - optional. Optional parameters to be recorded in audit log
paramValues	(I) - optional. Optional parameter values to be recorded in audit log
errorCode	(I) - optional. Error code in case of a failure event
errorMsg	(I) - optional. Error message in case of a failure event

SA_API int AUDIT_log_event4	(	tag_t	targetObject,
		tag_t	objectType,
		tag_t	eventType,
		tag_t	subEventType,
		const char *	objectId,
		const char *	objectName,
		const char *	rev,
		int	objectSeq,
		int	secondaryObjectTagCount,
		tag_t *	secondaryObjectTags,
		const char **	secondaryObjectQualifiers,
		int	paramCount,
		const char **	paramNames,
		const char **	paramValues,
		int	errorCode,
		const char *	errorMsg
	)

Parameters

targetObject	(I)
objectType	(I)
eventType	(I)
subEventType	(I) - optional, this is only used for auditing notification email history. In that case, eventType will be __Email_Send or __Email_Not_send, and subEventType field stores the subscribed event name which triggers the notification email send event.
objectId	(I)
objectName	(I)
rev	(I)
objectSeq	(I)
secondaryObjectTagCount	(I)
secondaryObjectTags	(I)
secondaryObjectQualifiers	(I)
paramCount	(I) - optional. Count of optional parameters to be recorded
paramNames	(I) - optional. Optional parameters to be recorded in audit log
paramValues	(I) - optional. Optional parameter values to be recorded in audit log
errorCode	(I) - optional. Error code in case of a failure event
errorMsg	(I) - optional. Error message in case of a failure event