com.adobe.livecycle.encryption.client
Class EncryptionServiceException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.adobe.livecycle.encryption.client.EncryptionServiceException

All Implemented Interfaces:

java.io.Serializable

public class EncryptionServiceException
extends java.lang.Exception

Represents the base class for exceptions thrown by the Encryption service.

See Also:

Serialized Form

Field Summary

static int	E_BAD_PDF_ENCRYPTION Indicates that an invalid encrypted PDF document was specified.
static int	E_BAD_PERMNISSION A constant that indicates that an invalid permission value was specified.
static int	E_CERTIFICATE_NOT_PRESENT A constant that indicates that the certificate required for encrypting the document was not found
static int	E_COMPAT Indicates that a bad compatability level was specified.
static int	E_ENC_OPT Indicates that a invalid encryption option was specified.
static int	E_ENCRYPTED Indicates that a PDF document was already encrypted.
static int	E_ENCRYPTION_FAILED A constant that indicates that the encryption operation failed.
static int	E_ERR Represents a generic error.
static int	E_INCORRECT_CERTIFICATE A constant that indicates that the certificate is not fit to be used for encryption
static int	E_INCORRECT_CREDENTIAL A constant that indicates that the credential being used for decrypting the document is not fit for decryption
static int	E_INSUFF_PRIV
static int	E_NOT_ENCRYPTED Indicates that a PDF document is not encrypted.
static int	E_NOT_FIPS_COMPLIANT A constant that indicates that the algorithm being used for encryption is not FIPS compliant
static int	E_OPERATION_FAILED Indicates that the current operation failed.
static int	E_RE A constant that indicates that the Input Document was Reader Extended
static int	E_SIGNATURE A constant that indicates that the document is already signed.
static int	E_TODO A constant that indicates.
static int	E_WRONG_PERMISSIONS Indicates that a wrong permission value was specified.

Constructor Summary

EncryptionServiceException(int errorCode)

EncryptionServiceException(java.lang.String message)

EncryptionServiceException(java.lang.String message, int errorCode)

EncryptionServiceException(java.lang.String message, int errorCode, java.lang.Throwable cause)

EncryptionServiceException(java.lang.String message, java.lang.Object[] params)

EncryptionServiceException(java.lang.String message, java.lang.Object[] params, int errorCode)

EncryptionServiceException(java.lang.String message, java.lang.Object[] params, int errorCode, java.lang.Throwable cause)

EncryptionServiceException(java.lang.String message, java.lang.Object[] params, java.lang.Throwable cause)

EncryptionServiceException(java.lang.String message, java.lang.Throwable cause)

Method Summary

int	getErrorCode() Retrieves the error code for the exception.
java.lang.String	getInitCauseStackTrace() Returns the cause stack trace from the Encryption service.
static java.lang.String	makeErrorMessage(java.lang.String message, int errorCode) Creates an error message with a given message and error code.
void	printStackTrace() Prints the StackTrace on System.err.
void	printStackTrace(java.io.PrintStream s) Prints the StackTrace onto the input PrintStream.
void	printStackTrace(java.io.PrintWriter w) Prints the StackTrace onto the input PrintWriter.
void	setInitCauseStackTrace(java.lang.String initCauseStackTrace) Sets the stack trace value.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, 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

Represents a generic error.

See Also:

Constant Field Values

E_OPERATION_FAILED

public static final int E_OPERATION_FAILED

Indicates that the current operation failed.

See Also:

Constant Field Values

E_TODO

public static final int E_TODO

A constant that indicates.

See Also:

Constant Field Values

E_COMPAT

public static final int E_COMPAT

Indicates that a bad compatability level was specified.

See Also:

Constant Field Values

E_ENC_OPT

public static final int E_ENC_OPT

Indicates that a invalid encryption option was specified.

See Also:

Constant Field Values

E_ENCRYPTED

public static final int E_ENCRYPTED

Indicates that a PDF document was already encrypted.

See Also:

Constant Field Values

E_NOT_ENCRYPTED

public static final int E_NOT_ENCRYPTED

Indicates that a PDF document is not encrypted.

See Also:

Constant Field Values

E_WRONG_PERMISSIONS

public static final int E_WRONG_PERMISSIONS

Indicates that a wrong permission value was specified.

See Also:

Constant Field Values

E_BAD_PDF_ENCRYPTION

public static final int E_BAD_PDF_ENCRYPTION

Indicates that an invalid encrypted PDF document was specified.

See Also:

Constant Field Values

E_ENCRYPTION_FAILED

public static final int E_ENCRYPTION_FAILED

A constant that indicates that the encryption operation failed.

See Also:

Constant Field Values

E_BAD_PERMNISSION

public static final int E_BAD_PERMNISSION

A constant that indicates that an invalid permission value was specified.

See Also:

Constant Field Values

E_SIGNATURE

public static final int E_SIGNATURE

A constant that indicates that the document is already signed.

See Also:

Constant Field Values

E_CERTIFICATE_NOT_PRESENT

public static final int E_CERTIFICATE_NOT_PRESENT

A constant that indicates that the certificate required for encrypting the document was not found

See Also:

Constant Field Values

E_NOT_FIPS_COMPLIANT

public static final int E_NOT_FIPS_COMPLIANT

A constant that indicates that the algorithm being used for encryption is not FIPS compliant

See Also:

Constant Field Values

E_INCORRECT_CERTIFICATE

public static final int E_INCORRECT_CERTIFICATE

A constant that indicates that the certificate is not fit to be used for encryption

See Also:

Constant Field Values

E_INCORRECT_CREDENTIAL

public static final int E_INCORRECT_CREDENTIAL

A constant that indicates that the credential being used for decrypting the document is not fit for decryption

See Also:

Constant Field Values

E_RE

public static final int E_RE

A constant that indicates that the Input Document was Reader Extended

See Also:

Constant Field Values

E_INSUFF_PRIV

public static final int E_INSUFF_PRIV

See Also:

Constant Field Values

Constructor Detail

EncryptionServiceException

public EncryptionServiceException(int errorCode)

EncryptionServiceException

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

EncryptionServiceException

public EncryptionServiceException(java.lang.String message,
                                  int errorCode,
                                  java.lang.Throwable cause)

EncryptionServiceException

public EncryptionServiceException(java.lang.String message,
                                  java.lang.Object[] params,
                                  int errorCode)

EncryptionServiceException

public EncryptionServiceException(java.lang.String message,
                                  java.lang.Object[] params,
                                  int errorCode,
                                  java.lang.Throwable cause)

EncryptionServiceException

public EncryptionServiceException(java.lang.String message)

EncryptionServiceException

public EncryptionServiceException(java.lang.String message,
                                  java.lang.Throwable cause)

EncryptionServiceException

public EncryptionServiceException(java.lang.String message,
                                  java.lang.Object[] params)

EncryptionServiceException

public EncryptionServiceException(java.lang.String message,
                                  java.lang.Object[] params,
                                  java.lang.Throwable cause)

Method Detail

makeErrorMessage

public static java.lang.String makeErrorMessage(java.lang.String message,
                                                int errorCode)

Creates an error message with a given message and error code.

Parameters:

message - The detail message.

errorCode - The error code.

Returns:

A string value that represents the error meessage.

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.

getInitCauseStackTrace

public java.lang.String getInitCauseStackTrace()

Returns the cause stack trace from the Encryption service.

Returns:

A string value that represents the stack trace.

setInitCauseStackTrace

public void setInitCauseStackTrace(java.lang.String initCauseStackTrace)

Sets the stack trace value.

Parameters:

initCauseStackTrace - A string value that represents the stack trace.

printStackTrace

public void printStackTrace()

Prints the StackTrace on System.err.

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream s)

Prints the StackTrace onto the input PrintStream.

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter w)

Prints the StackTrace onto the input PrintWriter.

Overrides:

printStackTrace in class java.lang.Throwable