com.adobe.livecycle.rightsmanagement.client.infomodel
Interface Event


public interface Event

The Event interface provides methods for retrieving information about Right Management service events. For example, when a policy is created, an event is created. You cannot create Event objects. To see this interface in a code example, see the Searching for events using the Java API quick start in Programming with Adobe Experience Manager Forms.


Method Summary
 java.lang.String getClientIPAddress()
          Retrieves the IP Address of the client which triggered the audit event.
 java.lang.String getEventCode()
          Retrieves the event code for the associated action that caused this audit event.
 java.lang.String getEventId()
          Retrieves the unique identifier for this audit event.
 java.lang.String getEventName()
          Retrieves the event name of the event.
 java.lang.String getEventNamespace()
          Retrieves the event namespace of the event.
 java.lang.String getLicenseId()
          Retrieves the unique identifier for the License that is associted with the audit event.
 java.lang.String getLoginId()
          Retrieves the unique login identifier for the user that is associted with the audit event.
 java.lang.String getPolicyId()
          Retrieves the unique identifier for the policy associated with the event.
 java.lang.String getPolicySetId()
          Retrieves the unique identifier for the policy set associated with the event.
 java.util.Date getTimestamp()
          Retrieves the timestamp indicating when the audit event occurred.
 java.lang.String getUserOid()
          Retrieves the unique identifier for the user that is associted with the audit event.
 boolean isAllowed()
          Retrieves a boolean value that indicates whether the action causing this event was allowed to proceed.
 boolean isOnline()
          Retrieves a boolean value that indicates whether the user was connected to the Document Security Server.
 

Method Detail

isAllowed

boolean isAllowed()
Retrieves a boolean value that indicates whether the action causing this event was allowed to proceed.

Returns:
A boolean that indicates whether the action causing this event was allowed to proceed.
See Also:
Event

getEventCode

java.lang.String getEventCode()
Retrieves the event code for the associated action that caused this audit event. For example, the EventManager.ALL_EVENTS event is the string "999". The event codes are described in the Public Constants for the EventManager interface.

Returns:
A java.lang.String representing the numeric value of the event codes.

getEventId

java.lang.String getEventId()
Retrieves the unique identifier for this audit event.

Returns:
A java.lang.String that holds unique identifier for this audit event.
See Also:
EventManager

getEventName

java.lang.String getEventName()
Retrieves the event name of the event.

Returns:
The name of the event.
See Also:
EventManager

getEventNamespace

java.lang.String getEventNamespace()
Retrieves the event namespace of the event.

Returns:
The name of the event.
See Also:
EventManager

getLicenseId

java.lang.String getLicenseId()
Retrieves the unique identifier for the License that is associted with the audit event.

Returns:
A java.lang.String that holds the unique identifier for the License that is associted with the audit event.
See Also:
Event.getLicenseId()

getTimestamp

java.util.Date getTimestamp()
Retrieves the timestamp indicating when the audit event occurred.

Returns:
A java.util.Date that holds the timestamp indicating when the audit event occurred.
See Also:
Event.getTimestamp()

getUserOid

java.lang.String getUserOid()
Retrieves the unique identifier for the user that is associted with the audit event.

Returns:
A java.lang.String that holds the unique identifier for the user that is associted with the audit event.
See Also:
Event.getUserOid()

getLoginId

java.lang.String getLoginId()
Retrieves the unique login identifier for the user that is associted with the audit event.

Returns:
A java.lang.String that holds the unique login identifier for the user that is associted with the audit event.
See Also:
Event.getLoginId()

getClientIPAddress

java.lang.String getClientIPAddress()
Retrieves the IP Address of the client which triggered the audit event.

Returns:
A java.lang.String that holds the IP Address of the client that triggered the audit event.
See Also:
Event.getClientIPAddress()

getPolicyId

java.lang.String getPolicyId()
Retrieves the unique identifier for the policy associated with the event.

Returns:
A java.lang.String that holds the unique login identifier for the policy that is associted with the audit event.
See Also:
Event.getPolicyId()

getPolicySetId

java.lang.String getPolicySetId()
Retrieves the unique identifier for the policy set associated with the event.

Returns:
A java.lang.String that holds the unique login identifier for the policy set that is associted with the audit event.
See Also:
Event.getPolicySetId()

isOnline

boolean isOnline()
Retrieves a boolean value that indicates whether the user was connected to the Document Security Server.

Returns:
A boolean that indicates whether the user was connected to the Document Security Server
See Also:
Event.isOnline()