com.stellent.cis.web.servlets
Class SCSFileDownloadServlet

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          com.stellent.cis.web.servlets.SCSBaseAuthenticatedServlet
              com.stellent.cis.web.servlets.SCSFileDownloadServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class SCSFileDownloadServlet
extends SCSBaseAuthenticatedServlet

This servlet allows for the streaming downloads from the ContentServer. The files maybe streamed directly from the vault or over an http connection. If the configuration file defines a vault location then the file protocol is used to stream the files directly from the vault. Else an http connection is attempted using the admin login and pass as specified in the configuration files.

Version:

1.0

See Also:

Serialized Form

Field Summary

protected ISCSDocumentInformationAPI	m_contentCommandAPI
protected ISCSFileAPI	m_fileApi

Fields inherited from class com.stellent.cis.web.servlets.SCSBaseAuthenticatedServlet

CONTEXT_PATH, GET_USER_PRINCIPAL_ENABLED, m_cisApplication, m_commandFacade, m_contextPath, m_defaultUser, m_getUserPrincipalEnabled, m_log, m_principalLookupAllowed, m_principalLookupName, m_principalLookupScope, PRINCIPAL_LOOKUP_ALLOWED, PRINCIPAL_LOOKUP_NAME, PRINCIPAL_LOOKUP_SCOPE, s_validScopes, USER_ATTRIBUTE

Constructor Summary

SCSFileDownloadServlet()

Method Summary

void	destroy() Destroys the servlet.
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the HTTP GET method.
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the HTTP POST method.
protected ISCSFileAPI	getFileApi()
java.lang.String	getServletInfo() Returns a short description of the servlet.
void	init(javax.servlet.ServletConfig config) Initializes the servlet.
protected void	processRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Processes requests for both HTTP GET and POST methods.
protected boolean	streamFileToUser(java.io.InputStream inStream, java.lang.String documentName, int length, java.lang.String mimeType, javax.servlet.http.HttpServletResponse response)

Methods inherited from class com.stellent.cis.web.servlets.SCSBaseAuthenticatedServlet

getActiveApi, getCisApplication, getCommandFacade, getContext, getDefaultUser, getPrincipalLookupName, getPrincipalLookupScope, getUcpmApi, isEmpty, isGetUserPrincipalEnabled, isPrincipalLookupAllowed, lookupObject, setCisApplication, setDefaultUser, setGetUserPrincipalEnabled, setPrincipalLookupAllowed, setPrincipalLookupName, setPrincipalLookupScope

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

m_fileApi

protected ISCSFileAPI m_fileApi

m_contentCommandAPI

protected ISCSDocumentInformationAPI m_contentCommandAPI

Constructor Detail

SCSFileDownloadServlet

public SCSFileDownloadServlet()

Method Detail

init

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

Initializes the servlet.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class SCSBaseAuthenticatedServlet

Parameters:

config - Servlet config

Throws:

javax.servlet.ServletException - if the servlet cannot be initialized

destroy

public void destroy()

Destroys the servlet.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

doGet

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

Handles the HTTP GET method.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - servlet request

response - servlet response

Throws:

javax.servlet.ServletException - a servlet error while processing

doPost

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

Handles the HTTP POST method.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

request - servlet request

response - servlet response

Throws:

javax.servlet.ServletException - servlet error while processing

getServletInfo

public java.lang.String getServletInfo()

Returns a short description of the servlet.

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

Returns:

servlet description

processRequest

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

Processes requests for both HTTP GET and POST methods.

Parameters:

request - servlet request

response - servlet response

Throws:

javax.servlet.ServletException - if the request cannot be processed due to some server issues

getFileApi

protected ISCSFileAPI getFileApi()
                          throws CommandException

Throws:

CommandException

streamFileToUser

protected boolean streamFileToUser(java.io.InputStream inStream,
                                   java.lang.String documentName,
                                   int length,
                                   java.lang.String mimeType,
                                   javax.servlet.http.HttpServletResponse response)
                            throws javax.servlet.ServletException

Parameters:

inStream -

documentName -

length -

mimeType -

response -

Returns:

Throws:

javax.servlet.ServletException