com.flexive.war.servlet

Class DownloadServlet

java.lang.Object

com.flexive.war.servlet.DownloadServlet

All Implemented Interfaces:

javax.servlet.Servlet

public class DownloadServlet
extends java.lang.Object
implements javax.servlet.Servlet

Provides streaming downloads for all binary objects (FxBinary). The requested value is identified by its XPath or by a unique tree path.

Link format:

/download/pk{n.m}/xpath/filename.ext

/download/tree/[edit,live]/fqn-path

When no XPath is provided, the first mandatory binary property of the instance's type is chosen.

URL Parameters:

Optional parameters can be appended to the requested path (e.g. ?param=value&param2):

• inline=true to download the content "inline" (i.e. skip the attachment response header)
• hintBinaryId=[id] hint at the expected binary ID. Used from UI content editors that may change the order of binaries (the binary will only be returned if it's actually present in the content, to preserve security)

Version:

$Rev: 3177 $

Author:

Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BASEURL

Constructor Summary

Constructors

Constructor and Description
DownloadServlet()

Method Summary

Modifier and Type	Method and Description
void	destroy()
(package private) static com.flexive.shared.value.BinaryDescriptor	findBinaryDescriptor(com.flexive.shared.content.FxContent content, long hintBinaryId)
static java.lang.String	getLink(com.flexive.shared.content.FxPK pk, java.lang.String xpath, java.lang.String fileName) Returns a link (absolute to the server context) to download the binary stored under the given XPath for the given object.
static java.lang.String	getLink(java.lang.String downloadServletPath, com.flexive.shared.content.FxPK pk, java.lang.String xpath, java.lang.String fileName) Returns a link (absolute to the server context) to download the binary stored under the given XPath for the given object.
static java.lang.String	getLink(java.lang.String downloadServletPath, java.lang.String fullXPath, java.lang.String filename) Returns a link (absolute to the server context) to download the binary stored under the given XPath.
javax.servlet.ServletConfig	getServletConfig()
java.lang.String	getServletInfo()
void	init(javax.servlet.ServletConfig servletConfig)
void	service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)

Methods inherited from class java.lang.Object

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

Field Detail

BASEURL

public static final java.lang.String BASEURL

See Also:

Constant Field Values

Constructor Detail

DownloadServlet

public DownloadServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig servletConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Throws:

javax.servlet.ServletException

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

Specified by:

getServletConfig in interface javax.servlet.Servlet

getServletInfo

public java.lang.String getServletInfo()

Specified by:

getServletInfo in interface javax.servlet.Servlet

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

service

public void service(javax.servlet.ServletRequest servletRequest,
                    javax.servlet.ServletResponse servletResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Specified by:

service in interface javax.servlet.Servlet

Throws:

javax.servlet.ServletException

java.io.IOException

getLink

public static java.lang.String getLink(com.flexive.shared.content.FxPK pk,
                                       java.lang.String xpath,
                                       java.lang.String fileName)

Returns a link (absolute to the server context) to download the binary stored under the given XPath for the given object. fileName is the filename visible to the browser, the actual name of the downloaded file is determined by the stored filename.

Parameters:

pk - the object pk

xpath - the XPath of the binary property to be downloaded

fileName - the filename visible to the browser

Returns:

a link (absolute to the server context) to download the given binary

getLink

public static java.lang.String getLink(java.lang.String downloadServletPath,
                                       com.flexive.shared.content.FxPK pk,
                                       java.lang.String xpath,
                                       @Nullable
                                       java.lang.String fileName)

Returns a link (absolute to the server context) to download the binary stored under the given XPath for the given object. fileName is the filename visible to the browser, the actual name of the downloaded file is determined by the stored filename.

Parameters:

downloadServletPath - a custom download servlet path

pk - the object pk

xpath - the XPath of the binary property to be downloaded

fileName - the filename visible to the browser

Returns:

a link (absolute to the server context) to download the given binary

getLink

public static java.lang.String getLink(java.lang.String downloadServletPath,
                                       java.lang.String fullXPath,
                                       java.lang.String filename)

Returns a link (absolute to the server context) to download the binary stored under the given XPath. fileName is the filename visible to the browser, the actual name of the downloaded file is determined by the stored filename. Note: XPath must contain pk.

Parameters:

downloadServletPath - a custom download servlet path. If not set the default BASEURL will be used.

fullXPath - a full XPath (i.e. including the pk of a stored content instance)

filename - the filename visible to the browser

Returns:

a link (absolute to the server context) to download the binary stored under the given XPath.

findBinaryDescriptor

static com.flexive.shared.value.BinaryDescriptor findBinaryDescriptor(com.flexive.shared.content.FxContent content,
                                                                      long hintBinaryId)