PDFUtilityMsgSet (AEM Forms API)

java.lang.Object
- com.adobe.fd.pdfutility.services.client.PDFUtilityMsgSet

```
public class PDFUtilityMsgSet
extends Object
```
Represents error messages logged by the PDF Utility service.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PREFIX` A prefix for all messages.
`static String`	`UTL_N00_001_VERSION` Displays the PDF Utility service version.
`static String`	`UTL_N00_002_REQUEST` Shows the requests being processed.
`static String`	`UTL_N00_003_RESULT` Shows the results being returned.
`static String`	`UTL_N00_004_MISSING_REDACTION_OPTIONS` Uses a default RedactionOptionSpec object.
`static String`	`UTL_S00_001_MISSING_DOCUMENT` The document to query is missing.
`static String`	`UTL_S00_002_QUERY_EXCEPTION` An error occured during processing.
`static String`	`UTL_S00_003_INVALID_PDF_DOCUMENT` The document provided as a PDF document was invalid.
`static String`	`UTL_S00_004_MISSING_DOCUMENT_FOR_REDACTION` No document was supplied for redaction
`static String`	`UTL_S00_009_HAS_SIGNED_SIGNATURE_FIELD` The PDF document is signed
`static String`	`UTL_S00_010_INVALID_PDF_DOCUMENT_REDACTION` The document provided as a PDF document was invalid.
`static String`	`UTL_S00_011_PDF_IO_ERROR` An I/O error has occurred during the reading or writing of the PDF file or in the reading or writing of temporary caches of PDF data.
`static String`	`UTL_S00_012_INVALID_PARAMETERS_FOR_REDACTION` One or more of the parameters passed to redact are invalid
`static String`	`UTL_S00_013_UNABLE_TO_COMPLETE_OPERATION` An error occurred which is not mappable into one of the other exception classes.
`static String`	`UTL_S00_014_AFE_FONT_SET_ERROR` This exception indicates an error in the AFE font set or in one of the individual fonts in that font set.
`static String`	`UTL_S00_015_PDF_SECURITY_ERROR` This exception indicates that some general security issue has occurred during the processing of the request.
`static String`	`UTL_S00_016_PDF_GENERAL_ERROR` If the exceptions occurred is not caught but is still a child of PDFException, and the PDFException is caught, then this message is thrown.
`static String`	`UTL_S00_017_IMAGE_FILTER_NOT_SUPPORTED` This exception message is shown when the user wants to redact an image portion but the image filter is unsupported and the user had chosen not to remove whole image for unsupported filter.
`static String`	`UTL_S00_022_MISSING_DOCUMENT_FOR_SANITIZATION` No document was supplied for sanitization
`static String`	`UTL_S00_023_CANNOT_SANITIZE_DOCUMENT_WITH_XFA_CONTENT` Cannot sanitize document with XFA content.
`static String`	`UTL_S00_024_CANNOT_SANITIZE_DOCUMENT_WITH_COLLECTION` Cannot sanitize document with collection.
`static String`	`UTL_S00_025_DOCUMENT_PROCESSING_ERROR` General Error that will be thrown whenever an error is encountered in document processing
`static String`	`UTL_S01_001_ERROR_PROCESSING_DOCUMENT` Generic error code returned when the an error occurs while processing a document.
`static String`	`UTL_S04_001_XDP_CONVERSION_FAILURE` Unable to convert the input PDF document to an XDP document.
`static String`	`UTL_S04_002_MISSING_DOCUMENT` The document to convert to a PDF document or XDP document is missing.
`static String`	`UTL_S04_003_NO_XDP_DOCUMENT` The document to convert to a PDF document is not an XDP document.
`static String`	`UTL_S04_004_NO_XFA_PDF_DOCUMENT` The input document to convert to an XDP document is not an XFA-based PDF document.
`static String`	`UTL_S04_005_PDF_CONVERSION_FAILURE` Unable to convert the input PDF document to an XDP document.
`static String`	`UTL_S04_006_FAILURE_TO_DETECT_FORMAT` Unable to detect the format of the input PDF document.
`static String`	`UTL_S04_007_DOCUMENT_FAILED_TO_CLOSE` Unable to close the output document.
`static String`	`UTL_W00_002_MISSING_OPTIONS` Uses a default options object because `null` was passed in.
`static String`	`UTL_W00_003_UNKNOWN_PROPERTIES` Warnings regarding requested options that were returned as null because the query failed.

Constructor Summary

Constructors
Constructor and Description

PDFUtilityMsgSet()

Constructors
Constructor and Description
`PDFUtilityMsgSet()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static String getMessage(String code, Object[] args)

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getMessage(String code, Object[] args)`

- Field Detail
  - PREFIX
```
public static final String PREFIX
```
    A prefix for all messages.
    
    See Also:
    
    Constant Field Values
  - UTL_N00_001_VERSION
```
public static final String UTL_N00_001_VERSION
```
    Displays the PDF Utility service version.
    
    See Also:
    
    Constant Field Values
  - UTL_N00_002_REQUEST
```
public static final String UTL_N00_002_REQUEST
```
    Shows the requests being processed.
    
    See Also:
    
    Constant Field Values
  - UTL_N00_003_RESULT
```
public static final String UTL_N00_003_RESULT
```
    Shows the results being returned.
    
    See Also:
    
    Constant Field Values
  - UTL_N00_004_MISSING_REDACTION_OPTIONS
```
public static final String UTL_N00_004_MISSING_REDACTION_OPTIONS
```
    Uses a default RedactionOptionSpec object.
    
    See Also:
    
    Constant Field Values
  - UTL_W00_002_MISSING_OPTIONS
```
public static final String UTL_W00_002_MISSING_OPTIONS
```
    Uses a default options object because null was passed in.
    
    See Also:
    
    Constant Field Values
  - UTL_W00_003_UNKNOWN_PROPERTIES
```
public static final String UTL_W00_003_UNKNOWN_PROPERTIES
```
    Warnings regarding requested options that were returned as null because the query failed.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_001_MISSING_DOCUMENT
```
public static final String UTL_S00_001_MISSING_DOCUMENT
```
    The document to query is missing. The result contians null properties. Verify that the document exists.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_002_QUERY_EXCEPTION
```
public static final String UTL_S00_002_QUERY_EXCEPTION
```
    An error occured during processing. This is a wrapper exception which is used to contain exceptions thrown from underlying libraries. The original exception is included in the stack trace.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_003_INVALID_PDF_DOCUMENT
```
public static final String UTL_S00_003_INVALID_PDF_DOCUMENT
```
    The document provided as a PDF document was invalid. The document may either be corrupted or the content is not PDF content.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_004_MISSING_DOCUMENT_FOR_REDACTION
```
public static final String UTL_S00_004_MISSING_DOCUMENT_FOR_REDACTION
```
    No document was supplied for redaction
    
    See Also:
    
    Constant Field Values
  - UTL_S00_009_HAS_SIGNED_SIGNATURE_FIELD
```
public static final String UTL_S00_009_HAS_SIGNED_SIGNATURE_FIELD
```
    The PDF document is signed
    
    See Also:
    
    Constant Field Values
  - UTL_S00_010_INVALID_PDF_DOCUMENT_REDACTION
```
public static final String UTL_S00_010_INVALID_PDF_DOCUMENT_REDACTION
```
    The document provided as a PDF document was invalid. The document may either be corrupted or the content is not PDF content.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_011_PDF_IO_ERROR
```
public static final String UTL_S00_011_PDF_IO_ERROR
```
    An I/O error has occurred during the reading or writing of the PDF file or in the reading or writing of temporary caches of PDF data.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_012_INVALID_PARAMETERS_FOR_REDACTION
```
public static final String UTL_S00_012_INVALID_PARAMETERS_FOR_REDACTION
```
    One or more of the parameters passed to redact are invalid
    
    See Also:
    
    Constant Field Values
  - UTL_S00_013_UNABLE_TO_COMPLETE_OPERATION
```
public static final String UTL_S00_013_UNABLE_TO_COMPLETE_OPERATION
```
    An error occurred which is not mappable into one of the other exception classes. This could be due to a variety of things such as invalid/inconsistent internal state of an object, erroneous hard-coded internal data, or unmappable exceptions that are thrown from external libraries (the JDK or Jars).
    
    See Also:
    
    Constant Field Values
  - UTL_S00_014_AFE_FONT_SET_ERROR
```
public static final String UTL_S00_014_AFE_FONT_SET_ERROR
```
    This exception indicates an error in the AFE font set or in one of the individual fonts in that font set. A client should consider rebuilding this font set before continuing further operations with the Adobe PDF Java Toolkit.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_015_PDF_SECURITY_ERROR
```
public static final String UTL_S00_015_PDF_SECURITY_ERROR
```
    This exception indicates that some general security issue has occurred during the processing of the request. This actual cause may be one of the descendant exceptions to this one. There are a limited number of these defined within the Adobe PDF Java Toolkit for the most common cases. However, a client that is providing its own implementation of the SecurityHandler interface may wish to subclass one of these to provide more specific information.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_016_PDF_GENERAL_ERROR
```
public static final String UTL_S00_016_PDF_GENERAL_ERROR
```
    If the exceptions occurred is not caught but is still a child of PDFException, and the PDFException is caught, then this message is thrown.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_017_IMAGE_FILTER_NOT_SUPPORTED
```
public static final String UTL_S00_017_IMAGE_FILTER_NOT_SUPPORTED
```
    This exception message is shown when the user wants to redact an image portion but the image filter is unsupported and the user had chosen not to remove whole image for unsupported filter.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_022_MISSING_DOCUMENT_FOR_SANITIZATION
```
public static final String UTL_S00_022_MISSING_DOCUMENT_FOR_SANITIZATION
```
    No document was supplied for sanitization
    
    See Also:
    
    Constant Field Values
  - UTL_S00_023_CANNOT_SANITIZE_DOCUMENT_WITH_XFA_CONTENT
```
public static final String UTL_S00_023_CANNOT_SANITIZE_DOCUMENT_WITH_XFA_CONTENT
```
    Cannot sanitize document with XFA content.
    
    See Also:
    
    Constant Field Values
  - UTL_S00_025_DOCUMENT_PROCESSING_ERROR
```
public static final String UTL_S00_025_DOCUMENT_PROCESSING_ERROR
```
    General Error that will be thrown whenever an error is encountered in document processing
    
    See Also:
    
    Constant Field Values
  - UTL_S00_024_CANNOT_SANITIZE_DOCUMENT_WITH_COLLECTION
```
public static final String UTL_S00_024_CANNOT_SANITIZE_DOCUMENT_WITH_COLLECTION
```
    Cannot sanitize document with collection.
    
    See Also:
    
    Constant Field Values
  - UTL_S04_001_XDP_CONVERSION_FAILURE
```
public static final String UTL_S04_001_XDP_CONVERSION_FAILURE
```
    Unable to convert the input PDF document to an XDP document.
    
    See Also:
    
    Constant Field Values
  - UTL_S04_002_MISSING_DOCUMENT
```
public static final String UTL_S04_002_MISSING_DOCUMENT
```
    The document to convert to a PDF document or XDP document is missing.
    
    See Also:
    
    Constant Field Values
  - UTL_S04_003_NO_XDP_DOCUMENT
```
public static final String UTL_S04_003_NO_XDP_DOCUMENT
```
    The document to convert to a PDF document is not an XDP document.
    
    See Also:
    
    Constant Field Values
  - UTL_S04_004_NO_XFA_PDF_DOCUMENT
```
public static final String UTL_S04_004_NO_XFA_PDF_DOCUMENT
```
    The input document to convert to an XDP document is not an XFA-based PDF document.
    
    See Also:
    
    Constant Field Values
  - UTL_S04_005_PDF_CONVERSION_FAILURE
```
public static final String UTL_S04_005_PDF_CONVERSION_FAILURE
```
    Unable to convert the input PDF document to an XDP document.
    
    See Also:
    
    Constant Field Values
  - UTL_S04_006_FAILURE_TO_DETECT_FORMAT
```
public static final String UTL_S04_006_FAILURE_TO_DETECT_FORMAT
```
    Unable to detect the format of the input PDF document.
    
    See Also:
    
    Constant Field Values
  - UTL_S04_007_DOCUMENT_FAILED_TO_CLOSE
```
public static final String UTL_S04_007_DOCUMENT_FAILED_TO_CLOSE
```
    Unable to close the output document.
    
    See Also:
    
    Constant Field Values
  - UTL_S01_001_ERROR_PROCESSING_DOCUMENT
```
public static final String UTL_S01_001_ERROR_PROCESSING_DOCUMENT
```
    Generic error code returned when the an error occurs while processing a document.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PDFUtilityMsgSet
```
public PDFUtilityMsgSet()
```
- Method Detail
  - getMessage
```
public static String getMessage(String code,
                                Object[] args)
```

Class PDFUtilityMsgSet

Field Summary

Constructor Summary

Method Summary

Field Detail

PREFIX

UTL_N00_001_VERSION

UTL_N00_002_REQUEST

UTL_N00_003_RESULT

UTL_N00_004_MISSING_REDACTION_OPTIONS

UTL_W00_002_MISSING_OPTIONS

UTL_W00_003_UNKNOWN_PROPERTIES

UTL_S00_001_MISSING_DOCUMENT

UTL_S00_002_QUERY_EXCEPTION

UTL_S00_003_INVALID_PDF_DOCUMENT

UTL_S00_004_MISSING_DOCUMENT_FOR_REDACTION

UTL_S00_009_HAS_SIGNED_SIGNATURE_FIELD

UTL_S00_010_INVALID_PDF_DOCUMENT_REDACTION

UTL_S00_011_PDF_IO_ERROR

UTL_S00_012_INVALID_PARAMETERS_FOR_REDACTION

UTL_S00_013_UNABLE_TO_COMPLETE_OPERATION

UTL_S00_014_AFE_FONT_SET_ERROR

UTL_S00_015_PDF_SECURITY_ERROR

UTL_S00_016_PDF_GENERAL_ERROR

UTL_S00_017_IMAGE_FILTER_NOT_SUPPORTED

UTL_S00_022_MISSING_DOCUMENT_FOR_SANITIZATION

UTL_S00_023_CANNOT_SANITIZE_DOCUMENT_WITH_XFA_CONTENT

UTL_S00_025_DOCUMENT_PROCESSING_ERROR

UTL_S00_024_CANNOT_SANITIZE_DOCUMENT_WITH_COLLECTION

UTL_S04_001_XDP_CONVERSION_FAILURE

UTL_S04_002_MISSING_DOCUMENT

UTL_S04_003_NO_XDP_DOCUMENT

UTL_S04_004_NO_XFA_PDF_DOCUMENT

UTL_S04_005_PDF_CONVERSION_FAILURE

UTL_S04_006_FAILURE_TO_DETECT_FORMAT

UTL_S04_007_DOCUMENT_FAILED_TO_CLOSE

UTL_S01_001_ERROR_PROCESSING_DOCUMENT

Constructor Detail

PDFUtilityMsgSet

Method Detail

getMessage