Package de.aeb.xnsg.documentcore.bf

Interface IDocumentCoreBF

@BusinessFacade
@MTOM
@StreamingAttachment(parseEagerly=true,
                     memoryThreshold=1048576L)
public interface IDocumentCoreBF

Defines the business facades for processing document templates

Field Summary

Fields

Modifier and Type	Field	Description
static String	STATE_PROCESSING_PROBLEMS	The response state if the document processing encountered problems
static String	STATE_SUCCESS	The response state if everything is fine
static String	STATE_TEMPLATE_MISSING	The response state if the template was not found in the template cache directory
static String	STATE_VALIDATION_PROBLEMS	The response state if the validation encountered problems

Method Summary

Modifier and Type	Method	Description
GenerateDocumentResponseDTO	generate(GenerateDocumentRequestDTO request)	Generates a document from the provided template and document data.
PDFTemplateFormResponseDTO	getFormOfPDFXFATemplate(PDFTemplateFormRequestDTO request)	Deprecated. use parse(ParseDocumentTemplateRequestDTO) with the "PDFXFA" processor (see PDFXFADocumentTemplateDTO.PROCESSOR) and query "XFAForm" (see PDFXFADocumentTemplateDTO.PARSE_QUERY_XFA_FORM
PDFTemplatePagesResponseDTO	getPageNamesOfPDFXFATemplate(PDFTemplatePagesRequestDTO request)	Deprecated. use parse(ParseDocumentTemplateRequestDTO) with the "PDFXFA" processor (see PDFXFADocumentTemplateDTO.PROCESSOR) and query "PageNames" (see PDFXFADocumentTemplateDTO.PARSE_QUERY_PAGE_NAMES
DocumentProcessorInfoDTO	getProcessorInfo(String processor)	Returns an information on functions and/or features supported by the processor.
String[]	getSupportedProcessors()	Collects tags of all document processors that are supported in the system.
ParseDocumentTemplateResponseDTO	parse(ParseDocumentTemplateRequestDTO request)	Parses the provided template data and returns the required information, as specified in the parse query parameters.
void	printPDFClassic(PrintPDFClassicRequestDTO request)	Deprecated. this method is no more supported
ProcessPDFResponseDTO	processPDF(ProcessPDFRequestDTO parameters)	Deprecated. use generate(GenerateDocumentRequestDTO) with the "PDFXFA" processor (see PDFXFADocumentTemplateDTO.PROCESSOR)
ValidateDocumentTemplateResponseDTO	validate(ValidateDocumentTemplateRequestDTO request)	Checks the document template for possible format or syntactic problems, which would make problems during the document processing.
PDFTemplateValidationResponseDTO	validatePDFXFATemplate(PDFTemplateValidationRequestDTO request)	Deprecated. use validate(ValidateDocumentTemplateRequestDTO) with the "PDFXFA" processor (see PDFXFADocumentTemplateDTO.PROCESSOR)

Field Detail

STATE_SUCCESS

static final String STATE_SUCCESS

The response state if everything is fine

See Also:

Constant Field Values

STATE_TEMPLATE_MISSING

static final String STATE_TEMPLATE_MISSING

The response state if the template was not found in the template cache directory

See Also:

Constant Field Values

STATE_VALIDATION_PROBLEMS

static final String STATE_VALIDATION_PROBLEMS

The response state if the validation encountered problems

See Also:

Constant Field Values

STATE_PROCESSING_PROBLEMS

static final String STATE_PROCESSING_PROBLEMS

The response state if the document processing encountered problems

See Also:

Constant Field Values

Method Detail

getSupportedProcessors

String[] getSupportedProcessors()

Collects tags of all document processors that are supported in the system.

Returns:

list of tags of the supported document processors

getProcessorInfo

DocumentProcessorInfoDTO getProcessorInfo(String processor)

Returns an information on functions and/or features supported by the processor.

Parameters:

processor -

Returns:

processor information

validate

ValidateDocumentTemplateResponseDTO validate(ValidateDocumentTemplateRequestDTO request)

Checks the document template for possible format or syntactic problems, which would make problems during the document processing.

Parameters:

request - template data

Returns:

validation state and a list of validation problems

generate

GenerateDocumentResponseDTO generate(GenerateDocumentRequestDTO request)
                              throws DocumentCoreTaskException

Generates a document from the provided template and document data.

Parameters:

request - template data, document data and processing options

Returns:

generated document, optionally with a list of processing traces/problems

Throws:

DocumentCoreTaskException - checked processing failures like rejection (server busy), cancellation (timeout or interruption), conversion error etc.

parse

ParseDocumentTemplateResponseDTO parse(ParseDocumentTemplateRequestDTO request)

Parses the provided template data and returns the required information, as specified in the parse query parameters. The supported query parameters are individual to each document processor.

Parameters:

request - template data and parse query parameters

Returns:

parsed content, as requested by the query

getPageNamesOfPDFXFATemplate

@Deprecated
PDFTemplatePagesResponseDTO getPageNamesOfPDFXFATemplate(PDFTemplatePagesRequestDTO request)

Deprecated.

use parse(ParseDocumentTemplateRequestDTO) with the "PDFXFA" processor (see PDFXFADocumentTemplateDTO.PROCESSOR) and query "PageNames" (see PDFXFADocumentTemplateDTO.PARSE_QUERY_PAGE_NAMES

Return the page names of the PDF-XFA template.

Parameters:

template - the PDF template to use

Returns:

information packed in a TemplatePagesResponseDTO object

getFormOfPDFXFATemplate

@Deprecated
PDFTemplateFormResponseDTO getFormOfPDFXFATemplate(PDFTemplateFormRequestDTO request)

Deprecated.

use parse(ParseDocumentTemplateRequestDTO) with the "PDFXFA" processor (see PDFXFADocumentTemplateDTO.PROCESSOR) and query "XFAForm" (see PDFXFADocumentTemplateDTO.PARSE_QUERY_XFA_FORM

Return the XFA form structure data of the PDF-XFA template.

Parameters:

template - the PDF template to use

Returns:

information packed in a TemplateFormResponseTO object

validatePDFXFATemplate

@Deprecated
PDFTemplateValidationResponseDTO validatePDFXFATemplate(PDFTemplateValidationRequestDTO request)

Deprecated.

use validate(ValidateDocumentTemplateRequestDTO) with the "PDFXFA" processor (see PDFXFADocumentTemplateDTO.PROCESSOR)

Return the validation problems for the requested PDF-XFA template for converting it into PDF classic.

Parameters:

The - template to validate.

processPDF

@Deprecated
ProcessPDFResponseDTO processPDF(ProcessPDFRequestDTO parameters)
                          throws DocumentCoreTaskException

Deprecated.

use generate(GenerateDocumentRequestDTO) with the "PDFXFA" processor (see PDFXFADocumentTemplateDTO.PROCESSOR)

Process the PDF. Generate and/or print PDF classic documents using a PDF-XFA template and data.

Parameters:

parameters - all options and parameters for this business facade

Returns:

information packed in a TemplatePagesResultDTO object

Throws:

DocumentCoreTaskException

printPDFClassic

@Deprecated
void printPDFClassic(PrintPDFClassicRequestDTO request)

Deprecated.

this method is no more supported

Just print a PDF classic file.

Parameters:

request - all options and parameters for this business facade