org.nuxeo.ecm.core.io.download

Class DownloadHelper

java.lang.Object

org.nuxeo.ecm.core.io.download.DownloadHelper

public class DownloadHelper
extends Object

Helper class related to the download service.

Since:

7.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	INLINE

Method Summary

Modifier and Type	Method and Description
static String	getRFC2231ContentDisposition(javax.servlet.http.HttpServletRequest request, String filename) Generates a Content-Disposition string based on the servlet request for a given filename.
static String	getRFC2231ContentDisposition(javax.servlet.http.HttpServletRequest request, String filename, Boolean inline) Generates a Content-Disposition string for a given filename.
static void	handleClientDisconnect(IOException e) Re-throws the passed exception except if it corresponds to a client disconnect, for which logging doesn't bring us anything.
static boolean	isClientAbortError(Throwable t)
static void	logClientAbort(Exception e)
static DownloadService.ByteRange	parseRange(String range, long length) Parses a byte range.

Methods inherited from class java.lang.Object

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

Field Detail

INLINE

public static final String INLINE

See Also:

Constant Field Values

Method Detail

parseRange

public static DownloadService.ByteRange parseRange(String range,
                                                   long length)

Parses a byte range.

Parameters:

range - the byte range as a string

length - the file length

Returns:

the byte range, or null if it couldn't be parsed.

getRFC2231ContentDisposition

public static String getRFC2231ContentDisposition(javax.servlet.http.HttpServletRequest request,
                                                  String filename)

Generates a Content-Disposition string based on the servlet request for a given filename.

The value follows RFC2231.

Parameters:

request - the http servlet request

filename - the filename

Returns:

a full string to set as value of a Content-Disposition header

getRFC2231ContentDisposition

public static String getRFC2231ContentDisposition(javax.servlet.http.HttpServletRequest request,
                                                  String filename,
                                                  Boolean inline)

Generates a Content-Disposition string for a given filename.

The value follows RFC2231.

Parameters:

request - the http servlet request

filename - the filename

inline - how to set the content disposition; TRUE for inline, FALSE for attachment, or null to detect from inline request parameter or attribute

Returns:

a full string to set as value of a Content-Disposition header

Since:

7.10

isClientAbortError

public static boolean isClientAbortError(Throwable t)

logClientAbort

public static void logClientAbort(Exception e)

handleClientDisconnect

public static void handleClientDisconnect(IOException e)
                                   throws IOException

Re-throws the passed exception except if it corresponds to a client disconnect, for which logging doesn't bring us anything.

Parameters:

e - the original exception

Throws:

IOException - if this is not a client disconnect