com.pcbsys.nirvana.nAdminAPI.nAuditEvent Class Reference

This class contains information for realm auditing. More...

Public Member Functions

virtual nACLEntry getNewValue ()
 If applicable, returns the new value after the change More...
 
virtual string getObjectName ()
 Returns the name of the object oin which the audit event is reporting on More...
 
virtual string getObjectString ()
 Returns a string representing the object being reported More...
 
virtual int getObjectType ()
 Returns the int object type More...
 
virtual nACLEntry getOldValue ()
 If applicable, returns the old value prior to the change. More...
 
virtual int getOperation ()
 Returns the int operation type More...
 
virtual string getOperationString ()
 Returns a string representing the operation being reported More...
 
virtual string getSubject ()
 Returns the subject on which the audit event is reporting on More...
 
virtual string getTimestamp ()
 Returns the time stamp that the event took place More...
 
DateTime getTimestampDate ()
 Returns the time stamp that the event took place represented as a date More...
 

Data Fields

const int sAccess = 3
 Indicates an access operation
 
const int sChanACL = 7
 Indicates a Channel ACL audit object type
 
const int sChange = 2
 Indicates a changed operation
 
const int sChannel = 1
 Indicates a channel audit object type
 
const int sChannelFailure = 12
 Indicates a failed channel audit object type
 
const int sChannelSuccess = 11
 Indicates a successful channel audit object type
 
const int sDelete = 1
 Indicates a delete operation
 
const int sInterface = 19
 Indicates an Interface audit object type
 
const int sJoin = 4
 Indicates a join audit object type
 
const int sJoinFailure = 18
 Indicates a failed join audit object type
 
const int sJoinSuccess = 17
 Indicates a successful join audit object type
 
const int sModify = 0
 Indicates a modified operation
 
const int sQueue = 2
 Indicates a queue audit object type
 
const int sQueueACL = 6
 Indicates a Queue ACL audit object type
 
const int sQueueFailure = 14
 Indicates a failed queue audit object type
 
const int sQueueSuccess = 13
 Indicates a successful queue audit object type
 
const int sRealm = 0
 Indicates a Realm audit object type
 
const int sRealmACL = 5
 Indicates a Realm ACL audit object type
 
const int sRealmFailure = 10
 Indicates a failed realm audit object type
 
const int sRealmSuccess = 9
 Indicates a successful realm audit object type
 
const int sService = 3
 Indicates a service audit object type
 
const int sServiceACL = 8
 Indicates a service ACL audit object type
 
const int sServiceFailure = 16
 Indicates a failed service audit object type
 
const int sServiceSuccess = 15
 Indicates a successful service audit object type
 
const int sStart = 4
 Indicates a start operation
 
const int sStop = 5
 Indicates a stop operation
 

Detailed Description

This class contains information for realm auditing.

The type of information contained is for :

Realms / Channels / Queues / ACLs / Service / Join

specifically operation such as :

Add / Delete / Remove

and 'who' i.e. the subject that performed the operation

Member Function Documentation

virtual nACLEntry com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getNewValue ( )
virtual

If applicable, returns the new value after the change

Returns
New value
virtual string com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getObjectName ( )
virtual

Returns the name of the object oin which the audit event is reporting on

Returns
String object name
virtual string com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getObjectString ( )
virtual

Returns a string representing the object being reported

Returns
String value
virtual int com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getObjectType ( )
virtual

Returns the int object type

Returns
Int value representative of the object type
virtual nACLEntry com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getOldValue ( )
virtual

If applicable, returns the old value prior to the change.

Only valid on a sChanged operation

Returns
Old value as an nACLEntry object or null if not an sChaned operation
virtual int com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getOperation ( )
virtual

Returns the int operation type

Returns
Int value of the operation being reported
virtual string com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getOperationString ( )
virtual

Returns a string representing the operation being reported

Returns
A string representation of the operation being reported
virtual string com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getSubject ( )
virtual

Returns the subject on which the audit event is reporting on

Returns
String subject of username
virtual string com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getTimestamp ( )
virtual

Returns the time stamp that the event took place

Returns
A String timestamp
DateTime com.pcbsys.nirvana.nAdminAPI.nAuditEvent.getTimestampDate ( )

Returns the time stamp that the event took place represented as a date

Returns
a Date timestamp