com.adobe.livecycle.rightsmanagement.client
Interface EventManager

public interface EventManager

The EventManager interface enables you to search for events. This interface also defines the constants that represent each type of event. For information, see Searching for Events in Programming with Adobe Experience Manager Forms.

Field Summary

static java.lang.String	ADMIN_ACTIVATE_EVENT Represents the event where an administrator account was activated.
static java.lang.String	ADMIN_ADD_EVENT Represents the event where an administrator account was created.
static java.lang.String	ADMIN_DEACTIVATE_EVENT Represents the event where an administrative account was deactivated.
static java.lang.String	ADMIN_DELETE_EVENT Represents the event where an administrator account was deleted.
static java.lang.String	ADMIN_EDIT_EVENT Represents the event where an administrator account was modified.
static java.lang.String	ALL_EVENTS Represents all types of events.
static java.lang.String	DOCUMENT_ADD_ANNOTATION_EVENT Represents the event where a user adds an annotation to a policy-protected document.
static java.lang.String	DOCUMENT_CHANGE_REVOKE_URL_EVENT Represents the event where a user changes the redirection URL for a revoked document.
static java.lang.String	DOCUMENT_CHANGE_SECURITY_HANDLER_EVENT Represents the event where a user changes a document so that it no longer uses the Rights Management service for security.
static java.lang.String	DOCUMENT_CLOSE_EVENT Represents the event where a user closes a policy-protected document.
static java.lang.String	DOCUMENT_FORM_FILL_EVENT Represents the event where a user fills in the fields on a policy-protected document.
static java.lang.String	DOCUMENT_MODIFY_EVENT Represents the event where a user makes changes to the content of a policy-protected document.
static java.lang.String	DOCUMENT_PRINT_HIGH_EVENT Represents the event where a policy-protected document is prStringed using high resolution.
static java.lang.String	DOCUMENT_PRINT_LOW_EVENT Represents the event where a policy-protected document is prStringed using low resolution.
static java.lang.String	DOCUMENT_REVOKE_EVENT Represents the event where a user or an administrator revokes access to a policy-protected document.
static java.lang.String	DOCUMENT_SECURE_EVENT Represents the event where a user secures a document with a policy.
static java.lang.String	DOCUMENT_SIGN_EVENT Represents the event where a user digitally signs a policy-protected document.
static java.lang.String	DOCUMENT_SWITCH_POLICY_EVENT Represents the event where a user or an administrator switches the policy that is protecting a document.
static java.lang.String	DOCUMENT_UNKNOWN_CLIENT_EVENT Represents the event where a client attempts to connect to the server, but is not a recognized client type.
static java.lang.String	DOCUMENT_UNREVOKE_EVENT Represents the event where a user or an administrator provides access to a document that was revoked.
static java.lang.String	DOCUMENT_VIEW_EVENT Represents the event where a policy-protected document is opened.
static java.lang.String	ERROR_DIRECTORY_SERVICE_EVENT Represents the event where the directory service used for authenticating Stringernal users is not available.
static java.lang.String	POLICY_CHANGE_EVENT Represents the event where a user or an administrator modifies an existing policy.
static java.lang.String	POLICY_CHANGE_OWNER_EVENT Represents the event where an administrator changes the owner of a policy.
static java.lang.String	POLICY_CREATE_EVENT Represents the event where a user or an administrator creates a new policy.
static java.lang.String	POLICY_DELETE_EVENT Represents the event where a user or an administrator deletes a policy.
static java.lang.String	POLICY_DISABLE_EVENT Represents the event where an administrator disables an organizational policy.
static java.lang.String	POLICY_ENABLE_EVENT Represents the event where an administrator enables an organizational policy.
static java.lang.String	SERVER_CLIENT_SYNC_EVENT Represents the event where a client synchronizes with the Rights Management service.
static java.lang.String	SERVER_CONFIG_CHANGE_EVENT Represents the event where the configuration of the Rights Management service was changed by importing a configuration file.
static java.lang.String	SERVER_DELETING_AUDIT_EVENTS_EVENT Represents the event where a user provided offline access for a document that user is protecting.
static java.lang.String	SERVER_ENABLE_OFFLINE_ACCESS_EVENT Represents the event where a user provided offline access for a document that user is protecting.
static java.lang.String	SERVER_SYNC_DIR_COMPLETE_EVENT Represents the event where the Rights Management service completed synchronizing with the user directory.
static java.lang.String	SERVER_SYNC_DIR_INFO_EVENT Represents the event where the Rights Management service begins synchronizing with the user directory.
static java.lang.String	SERVER_VERSION_MISMATCH_EVENT Represents the event where a client application attempted to connect to the Rights Management service, and the version of the client-side SDK components is not compatible with the version of the server-side SDK components.
static java.lang.String	USER_ACCOUNT_LOCK_EVENT Represents the event where an external user account is locked.
static java.lang.String	USER_ACTIVATE_EVENT Represents the event where an external user account is activated.
static java.lang.String	USER_AUTHENTICATE_DENY_EVENT Represents the event where a user authentication fails.
static java.lang.String	USER_AUTHENTICATE_EVENT Represents the event where a user is successfully authenticated.
static java.lang.String	USER_CHANGE_PASSWORD_EVENT Represents the event where the password of an external user is changed.
static java.lang.String	USER_DEACTIVATE_EVENT Represents the event where an external user account is deactivated.
static java.lang.String	USER_DELETE_EVENT Represents the event where an external user account is deleted.
static java.lang.String	USER_PREREGISTER_EVENT Represents the event where an external user is invited to register with the Rights Management service.
static java.lang.String	USER_REGISTER_EVENT Represents the event where an external user registers with the Rights Management service.
static java.lang.String	USER_UPDATE_PROFILE_EVENT Represents the event where the name, organization, or password of an external user is changed.

Method Summary

int	deleteEvents(EventSearchFilter filter) Enables you to export events specified in the search criteria to a file with CSV or XML format.
void	exportEvents(EventSearchFilter filter, java.lang.String filePrefix, int maxRecordsPerFile, EventExportFileFormat fileFormat) Enables you to export the events specified in the search criteria.
int	getNumberOfSearchedEvents(EventSearchFilter filter) Enables you to obtain the number of events returned from search in specified search criteria.
Event[]	searchForEvents(EventSearchFilter event, int maxResults) Enables you to search for events.

Field Detail

ALL_EVENTS

static final java.lang.String ALL_EVENTS

Represents all types of events.

See Also:

Constant Field Values

USER_CHANGE_PASSWORD_EVENT

static final java.lang.String USER_CHANGE_PASSWORD_EVENT

Represents the event where the password of an external user is changed.

See Also:

Constant Field Values

USER_REGISTER_EVENT

static final java.lang.String USER_REGISTER_EVENT

Represents the event where an external user registers with the Rights Management service.

See Also:

Constant Field Values

USER_PREREGISTER_EVENT

static final java.lang.String USER_PREREGISTER_EVENT

Represents the event where an external user is invited to register with the Rights Management service.

See Also:

Constant Field Values

USER_ACTIVATE_EVENT

static final java.lang.String USER_ACTIVATE_EVENT

Represents the event where an external user account is activated.

See Also:

Constant Field Values

USER_DEACTIVATE_EVENT

static final java.lang.String USER_DEACTIVATE_EVENT

Represents the event where an external user account is deactivated.

See Also:

Constant Field Values

USER_AUTHENTICATE_EVENT

static final java.lang.String USER_AUTHENTICATE_EVENT

Represents the event where a user is successfully authenticated.

See Also:

Constant Field Values

USER_AUTHENTICATE_DENY_EVENT

static final java.lang.String USER_AUTHENTICATE_DENY_EVENT

Represents the event where a user authentication fails.

See Also:

Constant Field Values

USER_ACCOUNT_LOCK_EVENT

static final java.lang.String USER_ACCOUNT_LOCK_EVENT

Represents the event where an external user account is locked.

See Also:

Constant Field Values

USER_DELETE_EVENT

static final java.lang.String USER_DELETE_EVENT

Represents the event where an external user account is deleted.

See Also:

Constant Field Values

USER_UPDATE_PROFILE_EVENT

static final java.lang.String USER_UPDATE_PROFILE_EVENT

Represents the event where the name, organization, or password of an external user is changed.

See Also:

Constant Field Values

DOCUMENT_VIEW_EVENT

static final java.lang.String DOCUMENT_VIEW_EVENT

Represents the event where a policy-protected document is opened.

See Also:

Constant Field Values

DOCUMENT_PRINT_LOW_EVENT

static final java.lang.String DOCUMENT_PRINT_LOW_EVENT

Represents the event where a policy-protected document is prStringed using low resolution.

See Also:

Constant Field Values

DOCUMENT_PRINT_HIGH_EVENT

static final java.lang.String DOCUMENT_PRINT_HIGH_EVENT

Represents the event where a policy-protected document is prStringed using high resolution.

See Also:

Constant Field Values

DOCUMENT_SIGN_EVENT

static final java.lang.String DOCUMENT_SIGN_EVENT

Represents the event where a user digitally signs a policy-protected document.

See Also:

Constant Field Values

DOCUMENT_ADD_ANNOTATION_EVENT

static final java.lang.String DOCUMENT_ADD_ANNOTATION_EVENT

Represents the event where a user adds an annotation to a policy-protected document.

See Also:

Constant Field Values

DOCUMENT_FORM_FILL_EVENT

static final java.lang.String DOCUMENT_FORM_FILL_EVENT

Represents the event where a user fills in the fields on a policy-protected document.

See Also:

Constant Field Values

DOCUMENT_CLOSE_EVENT

static final java.lang.String DOCUMENT_CLOSE_EVENT

Represents the event where a user closes a policy-protected document.

See Also:

Constant Field Values

DOCUMENT_MODIFY_EVENT

static final java.lang.String DOCUMENT_MODIFY_EVENT

Represents the event where a user makes changes to the content of a policy-protected document.

See Also:

Constant Field Values

DOCUMENT_CHANGE_SECURITY_HANDLER_EVENT

static final java.lang.String DOCUMENT_CHANGE_SECURITY_HANDLER_EVENT

Represents the event where a user changes a document so that it no longer uses the Rights Management service for security.

See Also:

Constant Field Values

DOCUMENT_SWITCH_POLICY_EVENT

static final java.lang.String DOCUMENT_SWITCH_POLICY_EVENT

Represents the event where a user or an administrator switches the policy that is protecting a document.

See Also:

Constant Field Values

DOCUMENT_REVOKE_EVENT

static final java.lang.String DOCUMENT_REVOKE_EVENT

Represents the event where a user or an administrator revokes access to a policy-protected document.

See Also:

Constant Field Values

DOCUMENT_UNREVOKE_EVENT

static final java.lang.String DOCUMENT_UNREVOKE_EVENT

Represents the event where a user or an administrator provides access to a document that was revoked.

See Also:

Constant Field Values

DOCUMENT_SECURE_EVENT

static final java.lang.String DOCUMENT_SECURE_EVENT

Represents the event where a user secures a document with a policy.

See Also:

Constant Field Values

DOCUMENT_UNKNOWN_CLIENT_EVENT

static final java.lang.String DOCUMENT_UNKNOWN_CLIENT_EVENT

Represents the event where a client attempts to connect to the server, but is not a recognized client type.

See Also:

Constant Field Values

DOCUMENT_CHANGE_REVOKE_URL_EVENT

static final java.lang.String DOCUMENT_CHANGE_REVOKE_URL_EVENT

Represents the event where a user changes the redirection URL for a revoked document.

See Also:

Constant Field Values

POLICY_CHANGE_EVENT

static final java.lang.String POLICY_CHANGE_EVENT

Represents the event where a user or an administrator modifies an existing policy.

See Also:

Constant Field Values

POLICY_ENABLE_EVENT

static final java.lang.String POLICY_ENABLE_EVENT

Represents the event where an administrator enables an organizational policy.

See Also:

Constant Field Values

POLICY_DISABLE_EVENT

static final java.lang.String POLICY_DISABLE_EVENT

Represents the event where an administrator disables an organizational policy.

See Also:

Constant Field Values

POLICY_CREATE_EVENT

static final java.lang.String POLICY_CREATE_EVENT

Represents the event where a user or an administrator creates a new policy.

See Also:

Constant Field Values

POLICY_DELETE_EVENT

static final java.lang.String POLICY_DELETE_EVENT

Represents the event where a user or an administrator deletes a policy.

See Also:

Constant Field Values

POLICY_CHANGE_OWNER_EVENT

static final java.lang.String POLICY_CHANGE_OWNER_EVENT

Represents the event where an administrator changes the owner of a policy.

See Also:

Constant Field Values

SERVER_CLIENT_SYNC_EVENT

static final java.lang.String SERVER_CLIENT_SYNC_EVENT

Represents the event where a client synchronizes with the Rights Management service.

See Also:

Constant Field Values

SERVER_SYNC_DIR_INFO_EVENT

static final java.lang.String SERVER_SYNC_DIR_INFO_EVENT

Represents the event where the Rights Management service begins synchronizing with the user directory.

See Also:

Constant Field Values

SERVER_SYNC_DIR_COMPLETE_EVENT

static final java.lang.String SERVER_SYNC_DIR_COMPLETE_EVENT

Represents the event where the Rights Management service completed synchronizing with the user directory.

See Also:

Constant Field Values

SERVER_VERSION_MISMATCH_EVENT

static final java.lang.String SERVER_VERSION_MISMATCH_EVENT

Represents the event where a client application attempted to connect to the Rights Management service, and the version of the client-side SDK components is not compatible with the version of the server-side SDK components.

See Also:

Constant Field Values

SERVER_CONFIG_CHANGE_EVENT

static final java.lang.String SERVER_CONFIG_CHANGE_EVENT

Represents the event where the configuration of the Rights Management service was changed by importing a configuration file.

See Also:

Constant Field Values

SERVER_ENABLE_OFFLINE_ACCESS_EVENT

static final java.lang.String SERVER_ENABLE_OFFLINE_ACCESS_EVENT

Represents the event where a user provided offline access for a document that user is protecting.

See Also:

Constant Field Values

SERVER_DELETING_AUDIT_EVENTS_EVENT

static final java.lang.String SERVER_DELETING_AUDIT_EVENTS_EVENT

Represents the event where a user provided offline access for a document that user is protecting.

See Also:

Constant Field Values

ADMIN_ADD_EVENT

static final java.lang.String ADMIN_ADD_EVENT

Represents the event where an administrator account was created.

See Also:

Constant Field Values

ADMIN_DELETE_EVENT

static final java.lang.String ADMIN_DELETE_EVENT

Represents the event where an administrator account was deleted.

See Also:

Constant Field Values

ADMIN_EDIT_EVENT

static final java.lang.String ADMIN_EDIT_EVENT

Represents the event where an administrator account was modified.

See Also:

Constant Field Values

ADMIN_ACTIVATE_EVENT

static final java.lang.String ADMIN_ACTIVATE_EVENT

Represents the event where an administrator account was activated.

See Also:

Constant Field Values

ADMIN_DEACTIVATE_EVENT

static final java.lang.String ADMIN_DEACTIVATE_EVENT

Represents the event where an administrative account was deactivated.

See Also:

Constant Field Values

ERROR_DIRECTORY_SERVICE_EVENT

static final java.lang.String ERROR_DIRECTORY_SERVICE_EVENT

Represents the event where the directory service used for authenticating Stringernal users is not available.

See Also:

Constant Field Values

Method Detail

searchForEvents

Event[] searchForEvents(EventSearchFilter event,
                        int maxResults)
                        throws SDKException

Enables you to search for events. To see this method used in a code example, see the Searching for events using the Java API quick start in Programming with Adobe Experience Manager Forms.

Parameters:

filter - An EventSearchFilter object that specifies the search criteria.

maxResults - The maximum number of events to return.

Returns:

A com.adobe.livecycle.rightsmanagement.client.infomodel.Event array containing events matching the search filter.

Throws:

SDKException - If an error occurred during this operation.

exportEvents

void exportEvents(EventSearchFilter filter,
                  java.lang.String filePrefix,
                  int maxRecordsPerFile,
                  EventExportFileFormat fileFormat)
                  throws SDKException

Enables you to export the events specified in the search criteria. If you specify a filePrefix value that does not exist, it is automatically created. This method creates the export files on the computer hosting Adobe Experience Manager Forms, not the client. This method was added in Adobe Experience Manager Forms.

Parameters:

filter - An EventSearchFilter object that specifies the search criteria.

filePrefix - A string value that specifies the file path prefix. It is strongly recommend that an absolute path be used for this parameter value. If not, and a relative path is used, the files are written out to jboss\bin (assuming Adobe Experience Manager Forms is deployed on JBOSS).

maxRecordsPerFile - An integer value that specifies the maximum number of records per file. The minimum value is 1 and maximum is 100000.

fileFormat - An EventExportFileFormat enumumeration value that specifies the output file format, either a CSV or an XML file.

Throws:

SDKException - If an error occurred during this operation.

deleteEvents

int deleteEvents(EventSearchFilter filter)
                 throws SDKException

Enables you to export events specified in the search criteria to a file with CSV or XML format.

Parameters:

filter - An EventSearchFilter object that specifies the search criteria.

Returns:

An int indicating the number of events deleted;

Throws:

SDKException - If an error occurred during this operation.

getNumberOfSearchedEvents

int getNumberOfSearchedEvents(EventSearchFilter filter)
                              throws SDKException

Enables you to obtain the number of events returned from search in specified search criteria.

Parameters:

filter - An EventSearchFilter object that specifies the search criteria.

Returns:

An int indicating the number of events searched matching the search filter.

Throws:

SDKException - If an error occurred during this operation.