com.logicaldoc.web.util

Class ServletIOUtil

java.lang.Object

com.logicaldoc.web.util.ServletIOUtil

public class ServletIOUtil
extends Object

Some helper utilities to download/upload a document and its resources. The downloaded document is also added to the recent files of the user.

Author:

Sebastian Stein

Constructor Summary

Constructors

Constructor and Description
ServletIOUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addToRecentFiles(long userId, long docId) Adds the given document to the recent files entry of the user
static void	downloadDocument(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String sid, long docId, String fileVersion, String fileName, String suffix, User user) Sends the specified document to the response object; the client will receive it as a download
static void	downloadDocument(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String sid, String docId, String fileVersion, String fileName, User user) Sends the specified document to the response object; the client will receive it as a download
static void	downloadDocumentText(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, long docId, User user) Sends the specified document's indexed text to the response object; the client will receive it as a download
static void	downloadFile(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, File file, String fileName) Sends the specified file to the response object; the client will receive it as a download
static void	downloadPluginResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String sid, String pluginName, String resourcePath, String fileName) Downloads a plugin resource
static void	setContentDisposition(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String filename, boolean asAttachment) Sets the correct Content-Disposition header into the response
static void	uploadDocumentResource(javax.servlet.http.HttpServletRequest request, String docId, String suffix, String fileVersion, String docVersion) Uploads a document's related resource.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletIOUtil

public ServletIOUtil()

Method Detail

addToRecentFiles

public static void addToRecentFiles(long userId,
                    long docId)

Adds the given document to the recent files entry of the user

Parameters:

userId - the id of the user accessing the file

docId - id of the document the user accessed

downloadPluginResource

public static void downloadPluginResource(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response,
                          String sid,
                          String pluginName,
                          String resourcePath,
                          String fileName)
                                   throws FileNotFoundException,
                                          IOException,
                                          javax.servlet.ServletException

Downloads a plugin resource

Parameters:

request -

response -

pluginName - name of the plug-in

resourcePath - Relative path ot the plug-in's resource

fileName - Optional file name

Throws:

FileNotFoundException

IOException

javax.servlet.ServletException

downloadDocument

public static void downloadDocument(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    String sid,
                    long docId,
                    String fileVersion,
                    String fileName,
                    String suffix,
                    User user)
                             throws FileNotFoundException,
                                    IOException,
                                    javax.servlet.ServletException

Sends the specified document to the response object; the client will receive it as a download

Parameters:

request - the current request

response - the document is written to this object

sid - Session identifier, if not provided the request parameter is inspected

docId - Id of the document

fileVersion - name of the file version; if null the latest version will be returned

suffix - of the linked document's resource

Throws:

javax.servlet.ServletException

FileNotFoundException

IOException

downloadFile

public static void downloadFile(javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                File file,
                String fileName)
                         throws FileNotFoundException,
                                IOException,
                                javax.servlet.ServletException

Sends the specified file to the response object; the client will receive it as a download

Parameters:

request - the current request

response - the file is written to this object

Throws:

javax.servlet.ServletException

FileNotFoundException

IOException

setContentDisposition

public static void setContentDisposition(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response,
                         String filename,
                         boolean asAttachment)
                                  throws UnsupportedEncodingException

Sets the correct Content-Disposition header into the response

Throws:

UnsupportedEncodingException

downloadDocumentText

public static void downloadDocumentText(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        long docId,
                        User user)
                                 throws FileNotFoundException,
                                        IOException

Sends the specified document's indexed text to the response object; the client will receive it as a download

Parameters:

request - the current request

response - the document is written to this object

docId - Id of the document

version - name of the version; if null the latest version will returned

Throws:

FileNotFoundException

IOException

downloadDocument

public static void downloadDocument(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response,
                    String sid,
                    String docId,
                    String fileVersion,
                    String fileName,
                    User user)
                             throws FileNotFoundException,
                                    IOException,
                                    NumberFormatException,
                                    javax.servlet.ServletException

Sends the specified document to the response object; the client will receive it as a download

Parameters:

request - the current request

response - the document is written to this object

docId - Id of the document

fileVersion - name of the file version; if null the latest version will be returned

Throws:

javax.servlet.ServletException

NumberFormatException

FileNotFoundException

IOException

uploadDocumentResource

public static void uploadDocumentResource(javax.servlet.http.HttpServletRequest request,
                          String docId,
                          String suffix,
                          String fileVersion,
                          String docVersion)
                                   throws Exception

Uploads a document's related resource. The resource will be stored in the folder where the document's files reside using the following pattern: fileVersion-suffix If no version is specified, the current one is used instead

Parameters:

request - the current request

docId - Id of the document

suffix - Suffix of the document

fileVersion - id of the file version; if null the latest version will returned

docVersion - id of the doc version; if null the latest version will returned

Throws:

Exception