net.sourceforge.rtf.web.servlet

Class AbstractRTFTemplateServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.sourceforge.rtf.web.servlet.AbstractRTFTemplateServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class AbstractRTFTemplateServlet
extends javax.servlet.http.HttpServlet

Abstract class RTFTemplate servlet to manage RTFTEmplate with Web Application. Method to implement are :

• getRTFReader : must return Reader of the RTF model source to use.
• putContext : must return Reader of the RTF model source to use.
• getXMLFieldsAvailable : must return XML fileds available for the RTF model or null if there is not XML Fileds available.

Version:

1.0.0

Author:

Angelo ZERR

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	RTF_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractRTFTemplateServlet()

Method Summary

Modifier and Type	Method and Description
protected String	cacheWithKey(javax.servlet.http.HttpServletRequest request)
void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP GET requests by calling { #doRequest()}.
void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles HTTP POST requests by calling { #doRequest()}.
protected void	doRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles all requests (by default).
protected void	error(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Exception cause) Invoked when there is an error thrown in any part of doRequest() processing.
protected org.springframework.context.ApplicationContext	getApplicationContext(javax.servlet.http.HttpServletRequest request) Return Spring configuration for RTFTemplate
protected String	getFileNameOfContentDisposition(javax.servlet.http.HttpServletRequest request)
protected org.springframework.context.ApplicationContext	getGlobalApplicationContext() Return global Spring configuration for RTFTemplate
protected int	getGroupByPerPageBreak(javax.servlet.http.HttpServletRequest request)
protected String	getRealPathOfRTFModel(javax.servlet.http.HttpServletRequest request, String rtfModelFile) Return the real path of RTF Model.
protected InputStream	getRTFInputStream(javax.servlet.http.HttpServletRequest request) This method to implement must return InputStream of the RTF model source to use.
protected Reader	getRTFReader(javax.servlet.http.HttpServletRequest request) This method to implement must return Reader of the RTF model source to use.
protected String	getRTFTemplateImpl(javax.servlet.http.HttpServletRequest request)
protected InputStream	getTransformerConfig(javax.servlet.http.HttpServletRequest request) If this method is implemented, RTFTemplate use this TransformerConfig, oterwise, RTFTemplate use default TransformerConfig.
protected abstract InputStream	getXMLFieldsAvailable(javax.servlet.http.HttpServletRequest request) This method to implement must return XML fileds available for the RTF model or null if there is not XML Fileds available.
void	init()
protected abstract void	putContext(javax.servlet.http.HttpServletRequest request, IContext ctx) This method to implement must put context for the RTF model source to use.
protected void	putDefaultFormat(javax.servlet.http.HttpServletRequest request, RTFTemplate rtfTemplate)
protected void	putGlobalContext(javax.servlet.http.HttpServletRequest request, IContext newContext)
protected void	setContentDisposition(javax.servlet.http.HttpServletResponse response, String fileName) Set FileName of Content Disposition
protected void	setContentType(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Set content type to RTF.
protected String	unCacheWithKey(javax.servlet.http.HttpServletRequest request)

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.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 Detail

RTF_CONTENT_TYPE

public static final String RTF_CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractRTFTemplateServlet

public AbstractRTFTemplateServlet()

Method Detail

init

public void init()

Overrides:

init in class javax.servlet.GenericServlet

doGet

public void doGet(javax.servlet.http.HttpServletRequest request,
                  javax.servlet.http.HttpServletResponse response)
           throws javax.servlet.ServletException,
                  IOException

Handles HTTP GET requests by calling { #doRequest()}.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doPost

public void doPost(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws javax.servlet.ServletException,
                   IOException

Handles HTTP POST requests by calling { #doRequest()}.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

doRequest

protected void doRequest(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws javax.servlet.ServletException,
                         IOException

Handles all requests (by default).

Parameters:

request - HttpServletRequest object containing client request

response - HttpServletResponse object for the response

Throws:

javax.servlet.ServletException - the exception.

IOException - the exception.

error

protected void error(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     Exception cause)
              throws javax.servlet.ServletException,
                     IOException

Invoked when there is an error thrown in any part of doRequest() processing.

Default will send a simple HTML response indicating there was a problem.

Parameters:

request - original HttpServletRequest from servlet container.

response - HttpServletResponse object from servlet container.

cause - Exception that was thrown by some other part of process.

Throws:

javax.servlet.ServletException - the exception.

IOException - the exception.

setContentType

protected void setContentType(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)

Set content type to RTF.

Parameters:

request - the request.

response - the response.

setContentDisposition

protected void setContentDisposition(javax.servlet.http.HttpServletResponse response,
                                     String fileName)

Set FileName of Content Disposition

Parameters:

response - the response.

fileName - the fileName.

getRTFReader

protected Reader getRTFReader(javax.servlet.http.HttpServletRequest request)
                       throws Exception

This method to implement must return Reader of the RTF model source to use.

Parameters:

request - the request.

Returns:

the result.

Throws:

Exception - the exception.

getRTFInputStream

protected InputStream getRTFInputStream(javax.servlet.http.HttpServletRequest request)
                                 throws Exception

This method to implement must return InputStream of the RTF model source to use.

Parameters:

request - the request.

Returns:

the result.

Throws:

Exception - the exception.

putContext

protected abstract void putContext(javax.servlet.http.HttpServletRequest request,
                                   IContext ctx)
                            throws Exception

This method to implement must put context for the RTF model source to use.

Parameters:

request - the request.

ctx - the ctx.

Throws:

Exception - the exception.

getXMLFieldsAvailable

protected abstract InputStream getXMLFieldsAvailable(javax.servlet.http.HttpServletRequest request)
                                              throws Exception

This method to implement must return XML fileds available for the RTF model or null if there is not XML Fileds available.

Parameters:

request - the request.

Returns:

the result.

Throws:

Exception - the exception.

getTransformerConfig

protected InputStream getTransformerConfig(javax.servlet.http.HttpServletRequest request)

If this method is implemented, RTFTemplate use this TransformerConfig, oterwise, RTFTemplate use default TransformerConfig.

Parameters:

request - the request.

Returns:

the result.

getRealPathOfRTFModel

protected String getRealPathOfRTFModel(javax.servlet.http.HttpServletRequest request,
                                       String rtfModelFile)

Return the real path of RTF Model.

Parameters:

request - the request.

rtfModelFile - the rtf Model File.

Returns:

the result.

getFileNameOfContentDisposition

protected String getFileNameOfContentDisposition(javax.servlet.http.HttpServletRequest request)

getRTFTemplateImpl

protected String getRTFTemplateImpl(javax.servlet.http.HttpServletRequest request)

putDefaultFormat

protected void putDefaultFormat(javax.servlet.http.HttpServletRequest request,
                                RTFTemplate rtfTemplate)

putGlobalContext

protected void putGlobalContext(javax.servlet.http.HttpServletRequest request,
                                IContext newContext)

getGroupByPerPageBreak

protected int getGroupByPerPageBreak(javax.servlet.http.HttpServletRequest request)

cacheWithKey

protected String cacheWithKey(javax.servlet.http.HttpServletRequest request)

unCacheWithKey

protected String unCacheWithKey(javax.servlet.http.HttpServletRequest request)

getGlobalApplicationContext

protected org.springframework.context.ApplicationContext getGlobalApplicationContext()

Return global Spring configuration for RTFTemplate

Returns:

the result.

getApplicationContext

protected org.springframework.context.ApplicationContext getApplicationContext(javax.servlet.http.HttpServletRequest request)

Return Spring configuration for RTFTemplate

Parameters:

request - the request.

Returns:

the result.