wt.audit
Class AuditServiceEvent

java.lang.Object
  extended bywt.events.KeyedEvent
      extended bywt.audit.AuditServiceEvent
All Implemented Interfaces:
Serializable

public class AuditServiceEvent
extends KeyedEvent
implements Serializable

Event emitted when a user logs in or out the system or a specific container. The types of event supported are AuditEventType objects.

Supported API: false

Extendable: false

See Also:
Serialized Form

Field Summary
private static String CLASSNAME
           
private  ObjectReference containerRef
           
private  Timestamp eventTime
           
private static String RESOURCE
           
private  WTPrincipalReference userRef
           
 
Fields inherited from class wt.events.KeyedEvent
 
Constructor Summary
AuditServiceEvent(AuditEventType event_type, WTPrincipalReference user_ref, ObjectReference container_ref)
          Audit service event constructor.
 
Method Summary
static String generateEventKey(AuditEventType event_type)
          Generates the event key given the event type as a AuditEventType.
static String generateEventKey(String event_type)
          Generates the event key given the event type as a String.
 ObjectReference getContainerRef()
          Gets the value of the attribute: containerRef; Reference to the container that is being logged in/out.
 Timestamp getEventTime()
          Gets the value of the attribute: eventTime; Time of the event.
 WTPrincipalReference getUserRef()
          Gets the value of the attribute: userRef; Holds a reference to the user that is logging in/out.
 void setContainerRef(ObjectReference a_ContainerRef)
          Sets the value of the attribute: containerRef; Reference to the container that is being logged in/out.
 void setEventTime(Timestamp a_EventTime)
          Sets the value of the attribute: eventTime; Time of the event.
 void setUserRef(WTPrincipalReference a_UserRef)
          Sets the value of the attribute: userRef; Holds a reference to the user that is logging in/out.
 String toString()
          Return a String representation of this event

Supported API: false
 
Methods inherited from class wt.events.KeyedEvent
generateEventKey, generateEventKey, getConceptualClassname, getEventKey, getEventTarget, getEventType, toMultiObjectEvent, toSingleObjectEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

userRef

private WTPrincipalReference userRef

containerRef

private ObjectReference containerRef

eventTime

private Timestamp eventTime
Constructor Detail

AuditServiceEvent

public AuditServiceEvent(AuditEventType event_type,
                         WTPrincipalReference user_ref,
                         ObjectReference container_ref)
Audit service event constructor. Takes the user logging in/out and the target.

Supported API: false

Parameters:
event_type -
user_ref -
container_ref -
Method Detail

getUserRef

public WTPrincipalReference getUserRef()
Gets the value of the attribute: userRef; Holds a reference to the user that is logging in/out.

Supported API: false

Returns:
WTPrincipalReference

setUserRef

public void setUserRef(WTPrincipalReference a_UserRef)
Sets the value of the attribute: userRef; Holds a reference to the user that is logging in/out.

Supported API: false

Parameters:
a_UserRef -

getContainerRef

public ObjectReference getContainerRef()
Gets the value of the attribute: containerRef; Reference to the container that is being logged in/out. If it is a system login this field is 'null.'

Supported API: false

Returns:
ObjectReference

setContainerRef

public void setContainerRef(ObjectReference a_ContainerRef)
Sets the value of the attribute: containerRef; Reference to the container that is being logged in/out. If it is a system login this field is 'null.'

Supported API: false

Parameters:
a_ContainerRef -

getEventTime

public Timestamp getEventTime()
Gets the value of the attribute: eventTime; Time of the event.

Supported API: false

Returns:
Timestamp

setEventTime

public void setEventTime(Timestamp a_EventTime)
Sets the value of the attribute: eventTime; Time of the event.

Supported API: false

Parameters:
a_EventTime -

generateEventKey

public static String generateEventKey(String event_type)
Generates the event key given the event type as a String.

Supported API: false

Parameters:
event_type -
Returns:
String

generateEventKey

public static String generateEventKey(AuditEventType event_type)
Generates the event key given the event type as a AuditEventType.

Supported API: false

Parameters:
event_type -
Returns:
String

toString

public String toString()
Description copied from class: KeyedEvent
Return a String representation of this event

Supported API: false

Overrides:
toString in class KeyedEvent
Returns:
String