Audit Manager

Modules
	Audit Manager Errors

Macros
#define	AUDITDEF_class_name_c   "AuditDefinition"

Functions
SA_API int	AUDITMGR__init_classes ()
SA_API int	AUDITMGR_add_audit_properties (tag_t auditDefTag, int propCount, char **propertiesNames)
SA_API int	AUDITMGR_create_audit_definition (tag_t objectType, tag_t eventType, int propCount, char **propertiesNames, int maxDaysKept, tag_t archiveMedia, tag_t userDefinedLogHandler, tag_t *auditDefTag)
SA_API int	AUDITMGR_find_audit_definition (tag_t objectType, tag_t eventType, int *nFound, tag_t **auditDefTags)
SA_API int	AUDITMGR_get_archive_media (tag_t auditDefTag, tag_t *archiveMedia)
SA_API int	AUDITMGR_get_audit_properties (tag_t auditDefTag, int *propCount, char ***propertiesNames)
SA_API int	AUDITMGR_get_auditable_type_names (int *count, char ***typeNames)
SA_API int	AUDITMGR_get_auditable_types (int *count, tag_t **tags)
SA_API int	AUDITMGR_get_event_type (tag_t auditDefTag, tag_t *eventType)
SA_API int	AUDITMGR_get_log_handler (tag_t auditDefTag, tag_t *logHandler)
SA_API int	AUDITMGR_get_max_days_kept (tag_t auditDefTag, int *daysCount)
SA_API int	AUDITMGR_get_object_type (tag_t auditDefTag, tag_t *objectType)
SA_API int	AUDITMGR_get_storage_type (tag_t auditDefTag, int *storageType)
SA_API int	AUDITMGR_remove_audit_properties (tag_t auditDefTag, int propCount, char **propsNames)
SA_API int	AUDITMGR_set_archive_media (tag_t auditDefTag, tag_t archiveMedia)
SA_API int	AUDITMGR_set_log_handler (tag_t auditDefTag, tag_t logHandler)
SA_API int	AUDITMGR_set_max_days_kept (tag_t auditDefTag, int daysCount)
SA_API int	AUDITMGR_set_storage_type (tag_t auditDefTag, int storageType)

Detailed Description

Macro Definition Documentation

#define AUDITDEF_class_name_c   "AuditDefinition"

Definition at line 30 of file auditmgr.h.

Function Documentation

SA_API int AUDITMGR__init_classes

(

)

This function initializes the auditmanager module

SA_API int AUDITMGR_add_audit_properties	(	tag_t	auditDefTag,
		int	propCount,
		char **	propertiesNames
	)

Parameters

auditDefTag	(I)
propCount	(I)
propertiesNames	(I)

SA_API int AUDITMGR_create_audit_definition	(	tag_t	objectType,
		tag_t	eventType,
		int	propCount,
		char **	propertiesNames,
		int	maxDaysKept,
		tag_t	archiveMedia,
		tag_t	userDefinedLogHandler,
		tag_t *	auditDefTag
	)

This function will be used for defining an object type and event type to be audited.

Parameters

objectType	(I) The tag of object type to be audited
eventType	(I) The tag of event type to be audited
propCount	(I) The number of properties that a user wants to be audited. Beside the default info such as object name/id, user, event, and time, these are additional properties defined by the user.
propertiesNames	(I) The list of properties to be audited
maxDaysKept	(I) The maximum number of days that audit logs to be kept on line. Once the defined time is expired, the audit log will be archived and purged from the storage.
archiveMedia	(I) The tag of storage media to be used for archiving older audit logs. If none is defined, the older audit logs will be purged from audit log storage.
userDefinedLogHandler	(I) The tag of a handler for creating additional log data
auditDefTag	(O) The tag of the created audit definition

SA_API int AUDITMGR_find_audit_definition	(	tag_t	objectType,
		tag_t	eventType,
		int *	nFound,
		tag_t **	auditDefTags
	)

This function is used to locate an audit definition.

Parameters

objectType	(I) The tag of object type defined in the audit definition
eventType	(I) The tag of event type defined in the audit definition
nFound	(O) The number of audit definitions found
auditDefTags	(OF) nFound The tags of the found audit definitions

SA_API int AUDITMGR_get_archive_media	(	tag_t	auditDefTag,
		tag_t *	archiveMedia
	)

Parameters

auditDefTag	(I)
archiveMedia	(O)

SA_API int AUDITMGR_get_audit_properties	(	tag_t	auditDefTag,
		int *	propCount,
		char ***	propertiesNames
	)

Parameters

auditDefTag	(I)
propCount	(O)
propertiesNames	(OF) propCount

SA_API int AUDITMGR_get_auditable_type_names	(	int *	count,
		char ***	typeNames
	)

Parameters

count	(O)
typeNames	(OF) count

SA_API int AUDITMGR_get_auditable_types	(	int *	count,
		tag_t **	tags
	)

Parameters

count	(O)
tags	(OF) count

SA_API int AUDITMGR_get_event_type	(	tag_t	auditDefTag,
		tag_t *	eventType
	)

Parameters

auditDefTag	(I)
eventType	(O)

SA_API int AUDITMGR_get_log_handler	(	tag_t	auditDefTag,
		tag_t *	logHandler
	)

Parameters

auditDefTag	(I)
logHandler	(O)

SA_API int AUDITMGR_get_max_days_kept	(	tag_t	auditDefTag,
		int *	daysCount
	)

Parameters

auditDefTag	(I)
daysCount	(O)

SA_API int AUDITMGR_get_object_type	(	tag_t	auditDefTag,
		tag_t *	objectType
	)

Parameters

auditDefTag	(I)
objectType	(O)

SA_API int AUDITMGR_get_storage_type	(	tag_t	auditDefTag,
		int *	storageType
	)

This function is used to get the storage type of an audit definition object.

Parameters

auditDefTag	(I) Tag of the audit definition object
storageType	(O) Integer indicating the storage type. 0 or 1 means the audit records are stored in the database. 2 means the audit records are written to the external files. 0 is the default storage type value. 0 will be returned for all audit definition objects that were created prior to V8.0.

SA_API int AUDITMGR_remove_audit_properties	(	tag_t	auditDefTag,
		int	propCount,
		char **	propsNames
	)

Parameters

auditDefTag	(I)
propCount	(I)
propsNames	(I)

SA_API int AUDITMGR_set_archive_media	(	tag_t	auditDefTag,
		tag_t	archiveMedia
	)

Parameters

auditDefTag	(I)
archiveMedia	(I)

SA_API int AUDITMGR_set_log_handler	(	tag_t	auditDefTag,
		tag_t	logHandler
	)

Parameters

auditDefTag	(I)
logHandler	(I)

SA_API int AUDITMGR_set_max_days_kept	(	tag_t	auditDefTag,
		int	daysCount
	)

Parameters

auditDefTag	(I)
daysCount	(I)

SA_API int AUDITMGR_set_storage_type	(	tag_t	auditDefTag,
		int	storageType
	)

This function is used to set the storage type of an audit definition object.

Restrictions:

AUDITMGR_set_storage_type() should be called after creating an audit definition object by calling AUDITMGR_create_audit_definition(). If you don�t call AUDITMGR_set_storage_type(), the default storage type 0 is assumed (i.e., stored in the database).

Parameters

auditDefTag	(I) Tag of the audit definition object
storageType	(I) Integer indicating the storage type. 1 means the audit records are stored in the database. 2 means the audit records are written to the external files.