com.plumtree.server
Interface IPTAuditManager

All Superinterfaces:

IPTUnknown

public interface IPTAuditManager
extends IPTUnknown

This interface is used to manage the audit trail for changes to Plumtree objects. For instance, it's used to query existing audit messages, to delete defunct messages, and to control the level of auditing that Plumtree will perform.

Author:

michaels

Method Summary

int	DiscardOldAuditMsgs(int lAuditTypeMask, com.plumtree.openfoundation.util.XPDateTime dtCutoffMsgTime, com.plumtree.openfoundation.util.XPDateTime dtCutoffMsgTimeLog) Delete audit messages from the database and from archive files that meet the specified criteria
java.lang.String	GetArchivePath() Returns the path to the archive files
int	GetAuditingState() Returns the current auditing settings (i.e.
int	GetDaysInArchive() Returns the number of days that an audit message will be stored in an archive file before the archive file is deleted
int	GetDaysInDB() Returns the number of days that an audit message will be stored in the database before it's archived to an archive file
IPTQueryResult	QueryAuditMsgs(int lPropIDMask, int lAuditTypeMask, int lSkipMsgs, int lNumMsgs, java.lang.Object[][] vQueryFilter, int sortVal) Used to retrieve all of the audit messages that are in the database which correspond to the indicated constraints
IPTQueryResult	QueryChangedHistory(int lPropIDMask, int lAuditTypeMask, int lClassID, int[] vsaObjectIDs, int lSkipMsgs, int lNumMsgs) QueryChangedHistory is similar to QueryAuditMsgs, but is intended to return information about which users made modifications to which objects.
void	SetArchivePath(java.lang.String pbstrArchivePath) Sets the folder path into which archive files will be written
void	SetDaysInArchive(int lDaysInArchive) Sets the number of days that an audit message will be stored in an archive file before the archive file is deleted
void	SetDaysInDB(int lDaysInDB) Sets the number of days that an audit message will be stored in the database before it's archived to an archive file
void	TurnOffAuditing() Disable all auditing (equivalent to TurnOnAuditing(0)) for THIS SESSION only
void	TurnOffGlobalAuditing() Disable all auditing (equivalent to TurnOnGlobalAuditing(0))
void	TurnOnAuditing(int lAuditMask) Enable specific types of auditing for THIS SESSION only
void	TurnOnGlobalAuditing(int lAuditMask) Enable specific types of auditing

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

QueryAuditMsgs

IPTQueryResult QueryAuditMsgs(int lPropIDMask,
                              int lAuditTypeMask,
                              int lSkipMsgs,
                              int lNumMsgs,
                              java.lang.Object[][] vQueryFilter,
                              int sortVal)

Used to retrieve all of the audit messages that are in the database which correspond to the indicated constraints

Parameters:

lPropIDMask - a bitmask of values from PT_PROPIDS used to indicate the output data desired

lAuditTypeMask - a bitmask of values from PT_AUDIT_TYPES used to indicate which types of audit messages should be included in the result, or -1 for all.

lSkipMsgs - the number of messages to skip. This is used for pagination (e.g. to show messages 101-200, this value would be 101.)

lNumMsgs - the number of messages to return. This is used for pagination (e.g. to show messages 101-200, this value would be 100.)

vQueryFilter - a query filter, in the same format as the vQueryFilter argument to IPTObjectManager.Query

sortVal - a value from com.plumtree.server.PT_ORDERBY_SETTINGS indicating the sort order for the result set. The results are always sorted by PT_PROPIDS.PT_PROPID_AUDIT_MSGTIME.

Returns:

an IPTQueryResult containing the requested audit messages

See Also:

IPTQueryResult, PT_PROPIDS, PT_AUDIT_TYPES, PT_ORDERBY_SETTINGS, IPTObjectManager.Query(int, int, int [][], int, int, Object[][])

DiscardOldAuditMsgs

int DiscardOldAuditMsgs(int lAuditTypeMask,
                        com.plumtree.openfoundation.util.XPDateTime dtCutoffMsgTime,
                        com.plumtree.openfoundation.util.XPDateTime dtCutoffMsgTimeLog)

Delete audit messages from the database and from archive files that meet the specified criteria

Parameters:

lAuditTypeMask - a bitmask of the types of audit messages to be deleted, as specified in PT_AUDIT_TYPES. NOTE: This argument applies ONLY to audit messages in the database, NOT to audit messages in archive files.

dtCutoffMsgTime - audit messages in the database that are older than this time and that have a type specified by lAuditTypeMask, will be deleted

dtCutoffMsgTimeLog - audit message archive files that are older than this time will be deleted. Note that all messages in a file are guaranteed to be older than the file itself.

Returns:

the number of database rows affected by the deletion

QueryChangedHistory

IPTQueryResult QueryChangedHistory(int lPropIDMask,
                                   int lAuditTypeMask,
                                   int lClassID,
                                   int[] vsaObjectIDs,
                                   int lSkipMsgs,
                                   int lNumMsgs)

QueryChangedHistory is similar to QueryAuditMsgs, but is intended to return information about which users made modifications to which objects. The return Query Result can return information like PT_PROPID_AUDIT_USERID and PT_PROPID_AUDIT_USERNAME.

Parameters:

lPropIDMask - a bitmask of values from PT_PROPIDS used to indicate the output data desired

lAuditTypeMask - a bitmask of values from PT_AUDIT_TYPES used to indicate which types of audit messages should be included in the result, or -1 for all.

lClassID - the class ID of the object or objects of interest, from PT_CLASSIDS

vsaObjectIDs - an array of the Object IDs of the objects of interest

lSkipMsgs - the number of messages to skip. This is used for pagination (e.g. to show messages 101-200, this value would be 101.)

lNumMsgs - the number of messages to return. This is used for pagination (e.g. to show messages 101-200, this value would be 100.)

Returns:

an IPTQueryResult containing the requested audit messages

See Also:

IPTQueryResult, PT_PROPIDS, PT_AUDIT_TYPES

TurnOffAuditing

void TurnOffAuditing()

Disable all auditing (equivalent to TurnOnAuditing(0)) for THIS SESSION only

TurnOnAuditing

void TurnOnAuditing(int lAuditMask)

Enable specific types of auditing for THIS SESSION only

Parameters:

lAuditTypeMask - a bitmask of values from PT_AUDIT_TYPES used to indicate which types of auditing should be enabled

See Also:

PT_AUDIT_TYPES

TurnOffGlobalAuditing

void TurnOffGlobalAuditing()

Disable all auditing (equivalent to TurnOnGlobalAuditing(0))

TurnOnGlobalAuditing

void TurnOnGlobalAuditing(int lAuditMask)

Enable specific types of auditing

Parameters:

lAuditTypeMask - a bitmask of values from PT_AUDIT_TYPES used to indicate which types of auditing should be enabled

See Also:

PT_AUDIT_TYPES

GetAuditingState

int GetAuditingState()

Returns the current auditing settings (i.e. the value that was last passed to TurnOnGlobalAuditing or TurnOnAuditing)

Returns:

a bitmask of PT_AUDIT_TYPE values

See Also:

PT_AUDIT_TYPES

GetArchivePath

java.lang.String GetArchivePath()

Returns the path to the archive files

Returns:

the path to the archive files

GetDaysInDB

int GetDaysInDB()

Returns the number of days that an audit message will be stored in the database before it's archived to an archive file

Returns:

the number of days that an audit message will be stored in the database before it's archived to an archive file

GetDaysInArchive

int GetDaysInArchive()

Returns the number of days that an audit message will be stored in an archive file before the archive file is deleted

Returns:

the number of days that an audit message will be stored in an archive file before the archive file is deleted

SetArchivePath

void SetArchivePath(java.lang.String pbstrArchivePath)

Sets the folder path into which archive files will be written

Parameters:

pbstrArchivePath - the folder path into which archive files will be written

SetDaysInDB

void SetDaysInDB(int lDaysInDB)

Sets the number of days that an audit message will be stored in the database before it's archived to an archive file

Parameters:

lDaysInDB - the number of days that an audit message will be stored in the database before it's archived to an archive file

SetDaysInArchive

void SetDaysInArchive(int lDaysInArchive)

Sets the number of days that an audit message will be stored in an archive file before the archive file is deleted

Parameters:

lDaysInArchive - the number of days that an audit message will be stored in an archive file before the archive file is deleted