com.tenduke.fileplus.servlet

Class IOServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.tenduke.sdk2.networking.http.BaseServlet

com.tenduke.fileplus.servlet.FilePlusServlet

com.tenduke.fileplus.servlet.IOServlet

All Implemented Interfaces:

com.tenduke.sdk2.api.Observer<com.tenduke.sdk2.api.lifecycle.LifecycleEvent>, Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

CpServlet, DeleteAccessPolicyServlet, DownloadServlet, GetAccessPolicyServlet, LsServlet, MkdirServlet, MvServlet, RmServlet, SetAccessPolicyServlet, UploadServlet

public abstract class IOServlet
extends FilePlusServlet

Servlet that accepts requests for file download, upload and other IO operations.

Author:

frej

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_NAME_TICKET Request parameter name for ticket.

Fields inherited from class com.tenduke.sdk2.networking.http.BaseServlet

INIT_PARAMETER_SIGN_ON_ENDPOINT_URL

Constructor Summary

Constructors

Constructor and Description
IOServlet()

Method Summary

Modifier and Type	Method and Description
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called by the server (via the service method) to allow a servlet to handle a GET request.
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called by the server (via the service method) to allow a servlet to handle a POST request.
protected void	doPut(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Called by the server (via the service method) to allow a servlet to handle a PUT request.
protected void	processRequestAndRespond(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Processes upload request.
protected abstract AbstractIORequest<? extends AbstractIOTicket,? extends AbstractIORequestResult>	resolveRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Resolves object that handles the request.
protected void	writeErrorResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FilePlusResult fileplusResult, RuntimeException ex) Writes error response back to client.
protected void	writeSuccessResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, FilePlusResult fileplusResult, AbstractIORequestResult result) Writes success response back to client.

Methods inherited from class com.tenduke.fileplus.servlet.FilePlusServlet

resolveAccount

Methods inherited from class com.tenduke.sdk2.networking.http.BaseServlet

authorizeCrossOriginRequest, ensureRequiredProtocol, getSignOnEndpointUrl, handleSignOn, handleSignOnBySuccess, isStopping, resolveEntityManager, resolveOnBehalfOfActor, resolveSessionActor, resolveSignOnEndpointUrl, service, setResponseNoCache, setSignOnEndpointUrl, storeActorIdToRequestAttribute, updateObserver

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_NAME_TICKET

public static final String PARAMETER_NAME_TICKET

Request parameter name for ticket.

See Also:

Constant Field Values

Constructor Detail

IOServlet

public IOServlet()

Method Detail

doGet

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

Called by the server (via the service method) to allow a servlet to handle a GET request.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

request - Client HTTP request.

response - HTTP response.

Throws:

javax.servlet.ServletException - ServletException if the request could not be handled.

IOException - IOException if an input or output error is detected.

doPost

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

Called by the server (via the service method) to allow a servlet to handle a POST request.

Overrides:

doPost in class javax.servlet.http.HttpServlet

Parameters:

request - Client HTTP request.

response - HTTP response.

Throws:

javax.servlet.ServletException - if the request could not be handled.

IOException - if an input or output error is detected.

doPut

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

Called by the server (via the service method) to allow a servlet to handle a PUT request.

Overrides:

doPut in class javax.servlet.http.HttpServlet

Parameters:

request - Client HTTP request.

response - HTTP response.

Throws:

javax.servlet.ServletException - if the request could not be handled.

IOException - if an input or output error is detected.

processRequestAndRespond

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

Processes upload request.

Parameters:

request - Client HTTP request.

response - HTTP response.

Throws:

javax.servlet.ServletException - if the request could not be handled.

IOException - if an input or output error is detected when the servlet handles the request.

com.tenduke.sdk2.api.LocatorException - Thrown if failed to find ObjectSerializer for requested response type.

writeErrorResponse

protected void writeErrorResponse(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response,
                                  FilePlusResult fileplusResult,
                                  RuntimeException ex)
                           throws IOException

Writes error response back to client.

Parameters:

request - Client HTTP request.

response - HTTP response.

fileplusResult - Processing result.

ex - Exception reported by File+ request instance.

Throws:

IOException - for IO errors when writing response.

writeSuccessResponse

protected void writeSuccessResponse(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    FilePlusResult fileplusResult,
                                    AbstractIORequestResult result)
                             throws IOException

Writes success response back to client.

Parameters:

request - Client HTTP request.

response - HTTP response.

fileplusResult - Top level File+ request result object.

result - Processing result.

Throws:

IOException - for IO errors when writing response.

resolveRequest

protected abstract AbstractIORequest<? extends AbstractIOTicket,? extends AbstractIORequestResult> resolveRequest(javax.servlet.http.HttpServletRequest request,
                                                                                                                  javax.servlet.http.HttpServletResponse response)

Resolves object that handles the request.

Parameters:

request - Client HTTP request.

response - HTTP response.

Returns:

Object that handles request or null if request is not supported.