EncryptionServiceException (AEM Forms API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.adobe.fd.encryption.client.EncryptionServiceException

All Implemented Interfaces:

Serializable
```
public class EncryptionServiceException
extends Exception
```
Represents the base class for exceptions thrown by the Encryption service.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`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_INVALID_ARG` A constant that indicates that invalid argument was passed.
`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.
`protected String`	`errMsg`
`protected static org.slf4j.Logger`	`logger`
`protected StringBuffer`	`stackTrace`

Constructor Summary

Constructors
Constructor and Description
`EncryptionServiceException(int errorCode)`
`EncryptionServiceException(String message)`
`EncryptionServiceException(String message, int errorCode)`
`EncryptionServiceException(String message, int errorCode, Throwable cause)`
`EncryptionServiceException(String message, Object[] params)`
`EncryptionServiceException(String message, Object[] params, int errorCode)`
`EncryptionServiceException(String message, Object[] params, int errorCode, Throwable cause)`
`EncryptionServiceException(String message, Object[] params, Throwable cause)`
`EncryptionServiceException(String message, Throwable cause)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getErrorCode()` Retrieves the error code for the exception.
`String`	`getInitCauseStackTrace()` Returns the cause stack trace from the Encryption service.
`protected static void`	`initProps(String fileName, Properties properties, Class currentClass)` A static function that should be called by all exception classes that derive from this abstract base class, in the static section of their definitions.
`static String`	`makeErrorMessage(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(PrintStream s)` Prints the StackTrace onto the input PrintStream.
`void`	`printStackTrace(PrintWriter w)` Prints the StackTrace onto the input PrintWriter.
`void`	`setInitCauseStackTrace(String initCauseStackTrace)` Sets the stack trace value.

- 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
  - E_INVALID_ARG
```
public static final int E_INVALID_ARG
```
    A constant that indicates that invalid argument was passed.
    
    See Also:
    
    Constant Field Values
  - logger
```
protected static org.slf4j.Logger logger
```
  - errMsg
```
protected String errMsg
```
  - stackTrace
```
protected StringBuffer stackTrace
```
- Constructor Detail
  - EncryptionServiceException
```
public EncryptionServiceException(int errorCode)
```
  - EncryptionServiceException
```
public EncryptionServiceException(String message,
                                  int errorCode)
```
  - EncryptionServiceException
```
public EncryptionServiceException(String message,
                                  int errorCode,
                                  Throwable cause)
```
  - EncryptionServiceException
```
public EncryptionServiceException(String message,
                                  Object[] params,
                                  int errorCode)
```
  - EncryptionServiceException
```
public EncryptionServiceException(String message,
                                  Object[] params,
                                  int errorCode,
                                  Throwable cause)
```
  - EncryptionServiceException
```
public EncryptionServiceException(String message)
```
  - EncryptionServiceException
```
public EncryptionServiceException(String message,
                                  Throwable cause)
```
  - EncryptionServiceException
```
public EncryptionServiceException(String message,
                                  Object[] params)
```
  - EncryptionServiceException
```
public EncryptionServiceException(String message,
                                  Object[] params,
                                  Throwable cause)
```
- Method Detail
  - makeErrorMessage
```
public static String makeErrorMessage(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 String getInitCauseStackTrace()
```
    Returns the cause stack trace from the Encryption service.
    
    Returns:
    
    A string value that represents the stack trace.
  - setInitCauseStackTrace
```
public void setInitCauseStackTrace(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 Throwable
  - printStackTrace
```
public void printStackTrace(PrintStream s)
```
    Prints the StackTrace onto the input PrintStream.
    
    Overrides:
    
    printStackTrace in class Throwable
  - printStackTrace
```
public void printStackTrace(PrintWriter w)
```
    Prints the StackTrace onto the input PrintWriter.
    
    Overrides:
    
    printStackTrace in class Throwable
  - initProps
```
protected static void initProps(String fileName,
                                Properties properties,
                                Class currentClass)
```
    A static function that should be called by all exception classes that derive from this abstract base class, in the static section of their definitions. This function initialises the passed in Properties object with the key-value pairs from the file corresponding to the name passed in as the fileName arguement. The derived classes should return this properties object from their props function.
    
    Parameters:
    
    fileName - The name of the file which contains the key-value pairs corresponding to the unique MessageIds used while throwing exceptions and their corresponding localised Exception Messages. This file is searched in the same location where the class definition of the input arguement current class is available.
    
    properties - The properties object that will be initialised with the contents of the file pointed to by fileName
    
    currentClass - The class relative to which the file pointed to by fileName will be searched.

Class EncryptionServiceException

Field Summary

Constructor Summary

Method Summary

Field Detail

E_ERR

E_OPERATION_FAILED

E_TODO

E_COMPAT

E_ENC_OPT

E_ENCRYPTED

E_NOT_ENCRYPTED

E_WRONG_PERMISSIONS

E_BAD_PDF_ENCRYPTION

E_ENCRYPTION_FAILED

E_BAD_PERMNISSION

E_SIGNATURE

E_CERTIFICATE_NOT_PRESENT

E_NOT_FIPS_COMPLIANT

E_INCORRECT_CERTIFICATE

E_INCORRECT_CREDENTIAL

E_RE

E_INSUFF_PRIV

E_INVALID_ARG

logger

errMsg

stackTrace

Constructor Detail

EncryptionServiceException

EncryptionServiceException

EncryptionServiceException

EncryptionServiceException

EncryptionServiceException

EncryptionServiceException

EncryptionServiceException

EncryptionServiceException

EncryptionServiceException

Method Detail

makeErrorMessage

getErrorCode

getInitCauseStackTrace

setInitCauseStackTrace

printStackTrace

printStackTrace

printStackTrace

initProps