com.adobe.edc.sdk
Class SDKException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.adobe.edc.sdk.SDKException

All Implemented Interfaces:

java.io.Serializable

public class SDKException
extends java.lang.Exception

The SDKException class defines the exception for the Adobe Experience Manager Document Security SDK.

See Also:

Serialized Form

Field Summary

static int	E_ACCOUNT_LOCKED A constant that indicates that the user account is locked.
static int	E_ADMIN_DUPLICATE_ENTRY A constant that indicates that the administrator account already exists.
static int	E_ALREADY_ENCRYPTED A constant that indicates that the requested change of policy ownership is not valid.
static int	E_AUTH_CANCELLED A constant that indicates that a user cancelled an authentication request.
static int	E_AUTH_FAILED A constant that indicates that the authentication of a user failed.
static int	E_BAD_PDRL_FORMAT A constant that indicates that the XML used does not comply with the PDRL schema.
static int	E_BAD_POLICY_SETTING A constant that indicates that the policy setting is not allowed.
static int	E_BEGINNING_TIME_LATER_THAN_CURRENT_TIME A constant that indicates that the beginning time in the event search filter is later than current time.
static int	E_BEGINNING_TIME_LATER_THAN_END_TIME A constant that indicates that the beginning time is later than the end time in the event search filter.
static int	E_CANNOT_COMMUNICATE_WITH_SERVER A constant that indicates that communication with Adobe Experience Manager Document Security cannot be established.
static int	E_CANNOT_CONNECT_TO_SERVER A constant that indicates that the connection with Adobe Experience Manager Document Security cannot be established.
static int	E_CLIENT_VERSION_MISMATCH A constant that indicates that the version of the client-side Adobe Experience Manager Document Security SDK components do not match the version of the server-side Adobe Experience Manager Document Security SDK components.
static int	E_CLIENT_VERSION_MISSING A constant that indicates that the version of the client-side Adobe Experience Manager Document Security SDK components cannot be found.
static int	E_CLIENT_VERSION_NOT_ALLOWED A constant indicating that the version of the client-side Adobe Experience Manager Document Security SDK component is denied access based on server-side constraints.
static int	E_CORRUPTED_SECURITY_INFO A constant that indicates that security information is corrupted.
static int	E_DELETING_EVENTS_IN_PROGRESS A constant that indicates deleting events process is in progress now
static int	E_DOC_ALREADY_REVOKED A constant that indicates that the attempt to revoke a document is rejected because the document is already revoked.
static int	E_DOC_ALREADY_UNREVOKED A constant that indicates that the attempt to unrevoke a document is rejected because the document is not revoked.
static int	E_DOC_EXPIRED A constant that indicates that the policy does not currently allow a document to be opened.
static int	E_DOC_NOT_YET_REOVKED A constant that indicates that the attempt to unrevoke a document is rejected because the document is not yet revoked.
static int	E_DOC_REVOKED A constant that indicates that the document is revoked.
static int	E_DUPLICATE_ENTRY_FAILURE A constant that indicates that the request to create a duplicate entry was rejected.
static int	E_END_TIME_LATER_THAN_CURRENT_TIME A constant that indicates that the end time in the event search filter is later than current time.
static int	E_ERR A constant that represents a generic error.
static int	E_EVENT_HANDLER_ALREADY_REGISTERED A constant that indicates that an attempt was made to register a second instance of the same event handler.
static int	E_EVENT_HANDLER_INVALID_CLASSPATH A constant that indicates that an invalid classpath for an event handler was provided.
static int	E_EVENT_HANDLER_NOT_REGISTERED A constant that indicates that the event handler is not registered.
static int	E_EXCEED_MAX_LENGTH_OF_LICENSE_ALT_ID A constant that indicates that one is attempting to set license alternate id which is greater than max length
static int	E_INTERNAL_SERVER_ERROR A constant that indicates that an internal server error occurred.
static int	E_INVALID_ARG A constant that indicates that an invalid argument was used.
static int	E_INVALID_CONNECTION A constant that indicates that the connection is not valid.
static int	E_INVALID_FILE A constant that indicates that the file is not valid.
static int	E_INVALID_LICENSE_XML A constant that indicates that the XML used to represent a license is not valid.
static int	E_INVALID_POLICY A constant that indicates that the policy is not valid.
static int	E_INVALID_POLICY_OWNERSHIP_CHANGE A constant that indicates that the requested change of policy ownership is not valid.
static int	E_INVALID_POLICY_XML A constant that indicates that the XML used to represent a policy is not valid.
static int	E_INVALID_REVOCATION_REASON A constant that indicates that the reason for revoking a document is not valid.
static int	E_LICENSE_ALTERNATE_ID_ALREADY_EXISTED A constant that indicates that one is attempting to set existing license alternate id (should be unique)
static int	E_LICENSE_FOR_USER_NOT_FOUND A constant that indicates that the license not found for the user.
static int	E_MISMATCHED_ANONYMOUS_SETTINGS A constant indicating that a non-anonymous policy was updated to become anonymous
static int	E_MISMATCHED_POLICY_ENCRYPT_SETTINGS A constant that indicates that the policy encryption settings do not match.
static int	E_NO_AUDIT_PERMISSION A constant that indicates that a request to audit the activity for a document was denied.
static int	E_NO_PERMISSION_ADMIN_ROLE A constant that indicates that a request is denied because the user does not have adminstrative permissions.
static int	E_NO_PERMISSION_GENERIC A constant that indicates that a request was denied because the associated permission is not granted.
static int	E_NO_REVOKE_PERMISSION A constant that indicates that a request to revoke a document was denied.
static int	E_NO_SUCH_ID A constant that indicates that the provided identification cannot be found.
static int	E_NO_SUCH_LICENSE_ID A constant that indicates that no license has the provided identification.
static int	E_NO_VIEW_PERMISSION A constant that indicates that a request to open a document was denied.
static int	E_NON_APS_FILE A constant that indicates that the file is not a Adobe Experience Manager Document Security file.
static int	E_NON_EXISTENT_EVENT A constant that indicates that an invalid event type was provided.
static int	E_NOT_AUTHORIZED A constant that indicates that the request is denied because the user is not authorized.
static int	E_OPERATION_FAILED A constant that indicates that the current operation failed.
static int	E_PACKAGER_PROCESS_UNAVAILABLE A constant that indicates that the Packager service is not available.
static int	E_POLICY_ALREADY_DELETED A constant that indicates that one is attempting to delete a policy that has already been deleted
static int	E_POLICY_SWITCH_NOT_ALLOWED A constant that indicates that switching the policy is not permitted
static int	E_REGISTRATION_BLACKLIST A constant that indicates that the user belongs to the registration blacklist.
static int	E_REGISTRATION_DISABLED_ERROR A constant that indicates that the external user registration service is disabled.
static int	E_SERVICE_DISABLED A constant that indicates that the service is disabled.
static int	E_TOKEN_INVALID A constant that indicates that the SAML authentication assurance that a client provided is not valid.
static int	E_UNSUPPORTED_DOCUMENT_FORMAT A constant that indicates the document passed to RM server is not one of the recognized formats
static int	E_USERENTRYALREADYEXISTS A constant that indicates that the the license and policy entry for the user already exists.
static int	E_USERENTRYNOTFOUND A constant that indicates that the the user entry not found.
static int	E_WATERMARK_ALREADY_DELETED A constant that indicates that one is attempting to delete a watermark that has already been deleted

Constructor Summary

SDKException(int errorCode)
Creates a new SDKException object of a specified type.

SDKException(java.lang.String message, int errorCode)
Creates a new SDKException object of a specified type, with a specified message.

Method Summary

int	getErrorCode() Retrieves the error code for the exception.
java.lang.String	getErrorMessage() Retrieves the error message for the exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

E_ERR

public static final int E_ERR

A constant that represents a generic error.

See Also:

Constant Field Values

E_OPERATION_FAILED

public static final int E_OPERATION_FAILED

A constant that indicates that the current operation failed.

See Also:

Constant Field Values

E_AUTH_FAILED

public static final int E_AUTH_FAILED

A constant that indicates that the authentication of a user failed.

See Also:

Constant Field Values

E_AUTH_CANCELLED

public static final int E_AUTH_CANCELLED

A constant that indicates that a user cancelled an authentication request.

See Also:

Constant Field Values

E_TOKEN_INVALID

public static final int E_TOKEN_INVALID

A constant that indicates that the SAML authentication assurance that a client provided is not valid.

See Also:

Constant Field Values

E_CLIENT_VERSION_MISSING

public static final int E_CLIENT_VERSION_MISSING

A constant that indicates that the version of the client-side Adobe Experience Manager Document Security SDK components cannot be found.

See Also:

Constant Field Values

E_CLIENT_VERSION_MISMATCH

public static final int E_CLIENT_VERSION_MISMATCH

A constant that indicates that the version of the client-side Adobe Experience Manager Document Security SDK components do not match the version of the server-side Adobe Experience Manager Document Security SDK components.

See Also:

Constant Field Values

E_ACCOUNT_LOCKED

public static final int E_ACCOUNT_LOCKED

A constant that indicates that the user account is locked.

See Also:

Constant Field Values

E_CLIENT_VERSION_NOT_ALLOWED

public static final int E_CLIENT_VERSION_NOT_ALLOWED

A constant indicating that the version of the client-side Adobe Experience Manager Document Security SDK component is denied access based on server-side constraints.

See Also:

Constant Field Values

E_DOC_REVOKED

public static final int E_DOC_REVOKED

A constant that indicates that the document is revoked.

See Also:

Constant Field Values

E_NO_VIEW_PERMISSION

public static final int E_NO_VIEW_PERMISSION

A constant that indicates that a request to open a document was denied.

See Also:

Constant Field Values

E_NO_REVOKE_PERMISSION

public static final int E_NO_REVOKE_PERMISSION

A constant that indicates that a request to revoke a document was denied.

See Also:

Constant Field Values

E_NO_AUDIT_PERMISSION

public static final int E_NO_AUDIT_PERMISSION

A constant that indicates that a request to audit the activity for a document was denied.

See Also:

Constant Field Values

E_DOC_EXPIRED

public static final int E_DOC_EXPIRED

A constant that indicates that the policy does not currently allow a document to be opened.

See Also:

Constant Field Values

E_NO_PERMISSION_GENERIC

public static final int E_NO_PERMISSION_GENERIC

A constant that indicates that a request was denied because the associated permission is not granted.

See Also:

Constant Field Values

E_INVALID_REVOCATION_REASON

public static final int E_INVALID_REVOCATION_REASON

A constant that indicates that the reason for revoking a document is not valid.

See Also:

Constant Field Values

E_CANNOT_CONNECT_TO_SERVER

public static final int E_CANNOT_CONNECT_TO_SERVER

A constant that indicates that the connection with Adobe Experience Manager Document Security cannot be established.

See Also:

Constant Field Values

E_CANNOT_COMMUNICATE_WITH_SERVER

public static final int E_CANNOT_COMMUNICATE_WITH_SERVER

A constant that indicates that communication with Adobe Experience Manager Document Security cannot be established.

See Also:

Constant Field Values

E_CORRUPTED_SECURITY_INFO

public static final int E_CORRUPTED_SECURITY_INFO

A constant that indicates that security information is corrupted.

See Also:

Constant Field Values

E_INTERNAL_SERVER_ERROR

public static final int E_INTERNAL_SERVER_ERROR

A constant that indicates that an internal server error occurred.

See Also:

Constant Field Values

E_DUPLICATE_ENTRY_FAILURE

public static final int E_DUPLICATE_ENTRY_FAILURE

A constant that indicates that the request to create a duplicate entry was rejected.

See Also:

Constant Field Values

E_INVALID_ARG

public static final int E_INVALID_ARG

A constant that indicates that an invalid argument was used.

See Also:

Constant Field Values

E_BAD_PDRL_FORMAT

public static final int E_BAD_PDRL_FORMAT

A constant that indicates that the XML used does not comply with the PDRL schema.

See Also:

Constant Field Values

E_INVALID_POLICY

public static final int E_INVALID_POLICY

A constant that indicates that the policy is not valid.

See Also:

Constant Field Values

E_BAD_POLICY_SETTING

public static final int E_BAD_POLICY_SETTING

A constant that indicates that the policy setting is not allowed.

See Also:

Constant Field Values

E_DOC_ALREADY_REVOKED

public static final int E_DOC_ALREADY_REVOKED

A constant that indicates that the attempt to revoke a document is rejected because the document is already revoked.

See Also:

Constant Field Values

E_DOC_ALREADY_UNREVOKED

public static final int E_DOC_ALREADY_UNREVOKED

A constant that indicates that the attempt to unrevoke a document is rejected because the document is not revoked.

See Also:

Constant Field Values

E_NO_PERMISSION_ADMIN_ROLE

public static final int E_NO_PERMISSION_ADMIN_ROLE

A constant that indicates that a request is denied because the user does not have adminstrative permissions.

See Also:

Constant Field Values

E_NO_SUCH_ID

public static final int E_NO_SUCH_ID

A constant that indicates that the provided identification cannot be found.

See Also:

Constant Field Values

E_MISMATCHED_POLICY_ENCRYPT_SETTINGS

public static final int E_MISMATCHED_POLICY_ENCRYPT_SETTINGS

A constant that indicates that the policy encryption settings do not match.

See Also:

Constant Field Values

E_NO_SUCH_LICENSE_ID

public static final int E_NO_SUCH_LICENSE_ID

A constant that indicates that no license has the provided identification.

See Also:

Constant Field Values

E_MISMATCHED_ANONYMOUS_SETTINGS

public static final int E_MISMATCHED_ANONYMOUS_SETTINGS

A constant indicating that a non-anonymous policy was updated to become anonymous

See Also:

Constant Field Values

E_NOT_AUTHORIZED

public static final int E_NOT_AUTHORIZED

A constant that indicates that the request is denied because the user is not authorized.

See Also:

Constant Field Values

E_INVALID_POLICY_XML

public static final int E_INVALID_POLICY_XML

A constant that indicates that the XML used to represent a policy is not valid.

See Also:

Constant Field Values

E_INVALID_LICENSE_XML

public static final int E_INVALID_LICENSE_XML

A constant that indicates that the XML used to represent a license is not valid.

See Also:

Constant Field Values

E_REGISTRATION_DISABLED_ERROR

public static final int E_REGISTRATION_DISABLED_ERROR

A constant that indicates that the external user registration service is disabled.

See Also:

Constant Field Values

E_ADMIN_DUPLICATE_ENTRY

public static final int E_ADMIN_DUPLICATE_ENTRY

A constant that indicates that the administrator account already exists.

See Also:

Constant Field Values

E_REGISTRATION_BLACKLIST

public static final int E_REGISTRATION_BLACKLIST

A constant that indicates that the user belongs to the registration blacklist.

See Also:

Constant Field Values

E_POLICY_SWITCH_NOT_ALLOWED

public static final int E_POLICY_SWITCH_NOT_ALLOWED

A constant that indicates that switching the policy is not permitted

See Also:

Constant Field Values

E_POLICY_ALREADY_DELETED

public static final int E_POLICY_ALREADY_DELETED

A constant that indicates that one is attempting to delete a policy that has already been deleted

See Also:

Constant Field Values

E_WATERMARK_ALREADY_DELETED

public static final int E_WATERMARK_ALREADY_DELETED

A constant that indicates that one is attempting to delete a watermark that has already been deleted

See Also:

Constant Field Values

E_LICENSE_ALTERNATE_ID_ALREADY_EXISTED

public static final int E_LICENSE_ALTERNATE_ID_ALREADY_EXISTED

A constant that indicates that one is attempting to set existing license alternate id (should be unique)

See Also:

Constant Field Values

E_EXCEED_MAX_LENGTH_OF_LICENSE_ALT_ID

public static final int E_EXCEED_MAX_LENGTH_OF_LICENSE_ALT_ID

A constant that indicates that one is attempting to set license alternate id which is greater than max length

See Also:

Constant Field Values

E_DOC_NOT_YET_REOVKED

public static final int E_DOC_NOT_YET_REOVKED

A constant that indicates that the attempt to unrevoke a document is rejected because the document is not yet revoked.

See Also:

Constant Field Values

E_BEGINNING_TIME_LATER_THAN_CURRENT_TIME

public static final int E_BEGINNING_TIME_LATER_THAN_CURRENT_TIME

A constant that indicates that the beginning time in the event search filter is later than current time.

See Also:

Constant Field Values

E_END_TIME_LATER_THAN_CURRENT_TIME

public static final int E_END_TIME_LATER_THAN_CURRENT_TIME

A constant that indicates that the end time in the event search filter is later than current time.

See Also:

Constant Field Values

E_BEGINNING_TIME_LATER_THAN_END_TIME

public static final int E_BEGINNING_TIME_LATER_THAN_END_TIME

A constant that indicates that the beginning time is later than the end time in the event search filter.

See Also:

Constant Field Values

E_UNSUPPORTED_DOCUMENT_FORMAT

public static final int E_UNSUPPORTED_DOCUMENT_FORMAT

A constant that indicates the document passed to RM server is not one of the recognized formats

See Also:

Constant Field Values

E_DELETING_EVENTS_IN_PROGRESS

public static final int E_DELETING_EVENTS_IN_PROGRESS

A constant that indicates deleting events process is in progress now

See Also:

Constant Field Values

E_LICENSE_FOR_USER_NOT_FOUND

public static final int E_LICENSE_FOR_USER_NOT_FOUND

A constant that indicates that the license not found for the user.

See Also:

Constant Field Values

E_PACKAGER_PROCESS_UNAVAILABLE

public static final int E_PACKAGER_PROCESS_UNAVAILABLE

A constant that indicates that the Packager service is not available.

See Also:

Constant Field Values

E_INVALID_FILE

public static final int E_INVALID_FILE

A constant that indicates that the file is not valid.

See Also:

Constant Field Values

E_NON_APS_FILE

public static final int E_NON_APS_FILE

A constant that indicates that the file is not a Adobe Experience Manager Document Security file.

See Also:

Constant Field Values

E_INVALID_CONNECTION

public static final int E_INVALID_CONNECTION

A constant that indicates that the connection is not valid.

See Also:

Constant Field Values

E_EVENT_HANDLER_INVALID_CLASSPATH

public static final int E_EVENT_HANDLER_INVALID_CLASSPATH

A constant that indicates that an invalid classpath for an event handler was provided.

See Also:

Constant Field Values

E_EVENT_HANDLER_ALREADY_REGISTERED

public static final int E_EVENT_HANDLER_ALREADY_REGISTERED

A constant that indicates that an attempt was made to register a second instance of the same event handler.

See Also:

Constant Field Values

E_EVENT_HANDLER_NOT_REGISTERED

public static final int E_EVENT_HANDLER_NOT_REGISTERED

A constant that indicates that the event handler is not registered.

See Also:

Constant Field Values

E_NON_EXISTENT_EVENT

public static final int E_NON_EXISTENT_EVENT

A constant that indicates that an invalid event type was provided.

See Also:

Constant Field Values

E_SERVICE_DISABLED

public static final int E_SERVICE_DISABLED

A constant that indicates that the service is disabled.

See Also:

Constant Field Values

E_INVALID_POLICY_OWNERSHIP_CHANGE

public static final int E_INVALID_POLICY_OWNERSHIP_CHANGE

A constant that indicates that the requested change of policy ownership is not valid.

See Also:

Constant Field Values

E_ALREADY_ENCRYPTED

public static final int E_ALREADY_ENCRYPTED

A constant that indicates that the requested change of policy ownership is not valid.

See Also:

Constant Field Values

E_USERENTRYNOTFOUND

public static int E_USERENTRYNOTFOUND

A constant that indicates that the the user entry not found.

E_USERENTRYALREADYEXISTS

public static int E_USERENTRYALREADYEXISTS

A constant that indicates that the the license and policy entry for the user already exists.

Constructor Detail

SDKException

public SDKException(java.lang.String message,
                    int errorCode)

Creates a new SDKException object of a specified type, with a specified message.

Parameters:

message - A String that contains the error message provided when the exception is thrown.

errorCode - An integer value that represents the type of error that threw the exception.

SDKException

public SDKException(int errorCode)

Creates a new SDKException object of a specified type.

Parameters:

errorCode - An integer value that represents the type of error that caused the exception to be thrown.

Method Detail

getErrorCode

public int getErrorCode()

Retrieves the error code for the exception.

Returns:

An integer value that represents the type of error that caused the exception to be thrown.

getErrorMessage

public java.lang.String getErrorMessage()

Retrieves the error message for the exception.

Returns:

An String value that gives information about the exception.