public abstract class DownloadAction extends BaseAction
getStreamInfo()
method so that it returns the relevant information for the file (or other
stream) to be downloaded. Optionally, the getBufferSize()
method may be overridden to customize the size of the buffer used to
transfer the file.Modifier and Type | Class and Description |
---|---|
static class |
DownloadAction.FileStreamInfo
A concrete implementation of the
StreamInfo interface
which simplifies the downloading of a file from the disk. |
static class |
DownloadAction.ResourceStreamInfo
A concrete implementation of the
StreamInfo interface
which simplifies the downloading of a web application resource. |
static interface |
DownloadAction.StreamInfo
The information on a file, or other stream, to be downloaded by the
DownloadAction . |
Modifier and Type | Field and Description |
---|---|
protected static int |
DEFAULT_BUFFER_SIZE
If the
getBufferSize() method is not overridden, this is
the buffer size that will be used to transfer the data to the servlet
output stream. |
messages
Constructor and Description |
---|
DownloadAction() |
Modifier and Type | Method and Description |
---|---|
int |
copy(InputStream input,
OutputStream output)
Copy bytes from an
InputStream to an
OutputStream . |
ActionForward |
execute(ActionMapping mapping,
ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Process the specified HTTP request, and create the corresponding HTTP
response (or forward to another web component that will create it).
|
protected int |
getBufferSize()
Returns the size of the buffer to be used in transferring the data to
the servlet output stream.
|
protected abstract DownloadAction.StreamInfo |
getStreamInfo(ActionMapping mapping,
ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Returns the information on the file, or other stream, to be downloaded
by this action.
|
addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet
protected static final int DEFAULT_BUFFER_SIZE
getBufferSize()
method is not overridden, this is
the buffer size that will be used to transfer the data to the servlet
output stream.protected abstract DownloadAction.StreamInfo getStreamInfo(ActionMapping mapping, ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
mapping
- The ActionMapping used to select this instance.form
- The optional ActionForm bean for this request (if
any).request
- The HTTP request we are processing.response
- The HTTP response we are creating.Exception
- if an exception occurs.protected int getBufferSize()
public ActionForward execute(ActionMapping mapping, ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
ActionForward
instance describing where and how
control should be forwarded, or null
if the response has
already been completed.execute
in class Action
mapping
- The ActionMapping used to select this instance.form
- The optional ActionForm bean for this request (if
any).request
- The HTTP request we are processing.response
- The HTTP response we are creating.null
if the response has been completed.Exception
- if an exception occurs.public int copy(InputStream input, OutputStream output) throws IOException
InputStream
to an
OutputStream
.input
- The InputStream
to read from.output
- The OutputStream
to write to.IOException
- In case of an I/O problemCopyright © 2000–2016 Apache Software Foundation. All rights reserved.