|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTAuditManager
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.
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 |
---|
IPTQueryResult QueryAuditMsgs(int lPropIDMask, int lAuditTypeMask, int lSkipMsgs, int lNumMsgs, java.lang.Object[][] vQueryFilter, int sortVal)
lPropIDMask
- a bitmask of values from PT_PROPIDS used to indicate
the output data desiredlAuditTypeMask
- 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.QuerysortVal
- 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.
IPTQueryResult
,
PT_PROPIDS
,
PT_AUDIT_TYPES
,
PT_ORDERBY_SETTINGS
,
IPTObjectManager.Query(int, int, int [][], int,
int, Object[][])
int DiscardOldAuditMsgs(int lAuditTypeMask, com.plumtree.openfoundation.util.XPDateTime dtCutoffMsgTime, com.plumtree.openfoundation.util.XPDateTime dtCutoffMsgTimeLog)
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
deleteddtCutoffMsgTimeLog
- 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.
IPTQueryResult QueryChangedHistory(int lPropIDMask, int lAuditTypeMask, int lClassID, int[] vsaObjectIDs, int lSkipMsgs, int lNumMsgs)
lPropIDMask
- a bitmask of values from PT_PROPIDS used to indicate
the output data desiredlAuditTypeMask
- 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_CLASSIDSvsaObjectIDs
- an array of the Object IDs of the objects of interestlSkipMsgs
- 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.)
IPTQueryResult
,
PT_PROPIDS
,
PT_AUDIT_TYPES
void TurnOffAuditing()
void TurnOnAuditing(int lAuditMask)
lAuditTypeMask
- a bitmask of values from PT_AUDIT_TYPES used to
indicate which types of auditing should be enabledPT_AUDIT_TYPES
void TurnOffGlobalAuditing()
void TurnOnGlobalAuditing(int lAuditMask)
lAuditTypeMask
- a bitmask of values from PT_AUDIT_TYPES used to
indicate which types of auditing should be enabledPT_AUDIT_TYPES
int GetAuditingState()
PT_AUDIT_TYPES
java.lang.String GetArchivePath()
int GetDaysInDB()
int GetDaysInArchive()
void SetArchivePath(java.lang.String pbstrArchivePath)
pbstrArchivePath
- the folder path into which archive files will be writtenvoid SetDaysInDB(int lDaysInDB)
lDaysInDB
- the number of days that an audit message will be stored in the
database before it's archived to an archive filevoid SetDaysInArchive(int lDaysInArchive)
lDaysInArchive
- the number of days that an audit message will be stored in an
archive file before the archive file is deleted
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |