Package fr.opensagres.xdocreport.document.web.dispatcher

Class ProcessDispatcherXDocReportServlet

java.lang.Object

jakarta.servlet.GenericServlet

jakarta.servlet.http.HttpServlet

fr.opensagres.xdocreport.document.web.BaseXDocReportServlet

fr.opensagres.xdocreport.document.web.AbstractProcessXDocReportServlet

fr.opensagres.xdocreport.document.web.dispatcher.ProcessDispatcherXDocReportServlet

All Implemented Interfaces:

XDocBaseServletConstants, XDocProcessServletConstants, jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

public class ProcessDispatcherXDocReportServlet
extends AbstractProcessXDocReportServlet

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<IXDocReportDispatcher<?>>	dispatchers

Fields inherited from interface fr.opensagres.xdocreport.document.web.XDocBaseServletConstants

DISPATCH_HTTP_PARAM, ENTRY_NAME_HTTP_PARAM, PROCESS_STATE_HTTP_PARAM, REPORT_ID_HTTP_PARAM, TEMPLATE_ENGINE_ID_HTTP_PARAM, TEMPLATE_ENGINE_KIND_HTTP_PARAM, XDOCREPORT_ATTR_KEY, XDOCREPORTREGISTRY_SESSION_KEY

Fields inherited from interface fr.opensagres.xdocreport.document.web.XDocProcessServletConstants

CONVERTER_ID_HTTP_PARAM, DOWNLOAD_DISPATCH, DUMPER_KIND_HTTP_PARAM, FONT_ENCODING_HTTP_PARAM, REMOVE_DISPATCH, VIEW_DISPATCH

Constructor Summary

Constructors

Constructor	Description
ProcessDispatcherXDocReportServlet()

Method Summary

Modifier and Type	Method	Description
protected fr.opensagres.xdocreport.template.formatter.FieldsMetadata	getFieldsMetadata(String reportId, jakarta.servlet.http.HttpServletRequest request)	Returns the fields metadata to use for the report.
protected InputStream	getSourceStream(String reportId, jakarta.servlet.http.HttpServletRequest request)	Returns input stream of the report to load identified with reportId.
protected String	getTemplateEngineKind(jakarta.servlet.http.HttpServletRequest request)
void	init(jakarta.servlet.ServletConfig config)
protected boolean	isCacheReport(String reportId, jakarta.servlet.http.HttpServletRequest request)	Returns true if the report with the given id must be cached and false otherwise.
protected void	populateContext(fr.opensagres.xdocreport.template.IContext context, IXDocReport report, jakarta.servlet.http.HttpServletRequest request)
protected void	populateContext(fr.opensagres.xdocreport.template.IContext context, String reportId, jakarta.servlet.http.HttpServletRequest request)	Put the Java model in the context for the report reportId.
void	registerDispatcher(IXDocReportDispatcher<?> dispatcher)
void	unregisterDispatcher(IXDocReportDispatcher<?> dispatcher)

Methods inherited from class fr.opensagres.xdocreport.document.web.AbstractProcessXDocReportServlet

createWEBURIResolver, doDocumentArchive, doGenerateReport, doRedirectAfterRemoveReport, doRemoveReport, doSaveEntry, doSaveReport, error, getConverterId, getDumperKind, getFontEncoding, getOptionsConverter, getOptionsDumper, getReport, isCacheOriginalDocument, isGenerateContentDisposition, loadReport, prepareOptions, processRequest

Methods inherited from class fr.opensagres.xdocreport.document.web.BaseXDocReportServlet

clearRegistryFromHTTPSession, disableHTTPResponCache, doGet, doPost, getContentDisposition, getContentDisposition, getDispatchParameter, getEntryName, getProcessState, getRegistry, getRegistryFromHTTPSession, getReportId, getTemplateEngine, getTemplateEngine, getTemplateEngine, getTemplateEngineId, getTemplateEngineKind, isDisableHTTPResponCache, prepareHTTPResponse, prepareHTTPResponse

Methods inherited from class jakarta.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class jakarta.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dispatchers

protected final List<IXDocReportDispatcher<?>> dispatchers

Constructor Details

ProcessDispatcherXDocReportServlet

public ProcessDispatcherXDocReportServlet()

Method Details

init

public void init(jakarta.servlet.ServletConfig config)
          throws jakarta.servlet.ServletException

Specified by:

init in interface jakarta.servlet.Servlet

Overrides:

init in class AbstractProcessXDocReportServlet

Throws:

jakarta.servlet.ServletException

registerDispatcher

public void registerDispatcher(IXDocReportDispatcher<?> dispatcher)

unregisterDispatcher

public void unregisterDispatcher(IXDocReportDispatcher<?> dispatcher)

getSourceStream

protected InputStream getSourceStream(String reportId,
 jakarta.servlet.http.HttpServletRequest request)
                               throws IOException,
fr.opensagres.xdocreport.core.XDocReportException

Description copied from class: AbstractProcessXDocReportServlet

Returns input stream of the report to load identified with reportId.

Specified by:

getSourceStream in class AbstractProcessXDocReportServlet

Parameters:

reportId - report id.

request - Http servlet request context.

Returns:

Throws:

IOException

fr.opensagres.xdocreport.core.XDocReportException

getTemplateEngineKind

protected String getTemplateEngineKind(jakarta.servlet.http.HttpServletRequest request)

Overrides:

getTemplateEngineKind in class BaseXDocReportServlet

getFieldsMetadata

protected fr.opensagres.xdocreport.template.formatter.FieldsMetadata getFieldsMetadata(String reportId,
 jakarta.servlet.http.HttpServletRequest request)

Description copied from class: AbstractProcessXDocReportServlet

Returns the fields metadata to use for the report.

Overrides:

getFieldsMetadata in class AbstractProcessXDocReportServlet

Parameters:

reportId - the report id.

request - the HTTP request.

Returns:

isCacheReport

protected boolean isCacheReport(String reportId,
 jakarta.servlet.http.HttpServletRequest request)

Description copied from class: AbstractProcessXDocReportServlet

Returns true if the report with the given id must be cached and false otherwise.

Overrides:

isCacheReport in class AbstractProcessXDocReportServlet

Parameters:

reportId - the report id.

request - the HTTP request.

Returns:

true if the report with the given id must be cached and false otherwise.

populateContext

protected void populateContext(fr.opensagres.xdocreport.template.IContext context,
 String reportId,
 jakarta.servlet.http.HttpServletRequest request)
                        throws IOException,
fr.opensagres.xdocreport.core.XDocReportException

Description copied from class: AbstractProcessXDocReportServlet

Put the Java model in the context for the report reportId.

Specified by:

populateContext in class AbstractProcessXDocReportServlet

Parameters:

context - XDocReport context to register Java data model.

reportId - report id.

request - Http servlet request context.

Throws:

IOException

fr.opensagres.xdocreport.core.XDocReportException

populateContext

protected void populateContext(fr.opensagres.xdocreport.template.IContext context,
 IXDocReport report,
 jakarta.servlet.http.HttpServletRequest request)