org.alfresco.module.vti.web.fp

Class VtiFpResponse

java.lang.Object

javax.servlet.ServletResponseWrapper

javax.servlet.http.HttpServletResponseWrapper

org.alfresco.module.vti.web.fp.VtiFpResponse

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse

public class VtiFpResponse
extends javax.servlet.http.HttpServletResponseWrapper

VtiFpResponse is wrapper for HttpServletResponse. It provides specific methods which allow to generate response for Frontpage extension protocol.

Author:

Michael Shavnev

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Constructor and Description
VtiFpResponse(javax.servlet.http.HttpServletResponse response) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(String value) Adds parameter in root of packet or in list
void	addParameter(String key, String value) Add parameter
void	beginList() Begins anonymous list
void	beginList(String listName) Begins list in root of packet or in other list
void	beginPacket() Begins vermeer packet with header
void	beginVtiAnswer(String methodName, String version) Begins vti response with header and method name and version
void	endList() Ends current list
void	endPacket() Ends vermeer packet with footer
void	endVtiAnswer() Ends vti answer with vermeer packet footer
void	writeMetaDictionary(VtiProperty property, VtiType type, VtiConstraint constraint, String value)

Methods inherited from class javax.servlet.http.HttpServletResponseWrapper

addCookie, addDateHeader, addHeader, addIntHeader, containsHeader, encodeRedirectUrl, encodeRedirectURL, encodeUrl, encodeURL, sendError, sendError, sendRedirect, setDateHeader, setHeader, setIntHeader, setStatus, setStatus

Methods inherited from class javax.servlet.ServletResponseWrapper

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getResponse, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale, setResponse

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletResponse

flushBuffer, getBufferSize, getCharacterEncoding, getContentType, getLocale, getOutputStream, getWriter, isCommitted, reset, resetBuffer, setBufferSize, setCharacterEncoding, setContentLength, setContentType, setLocale

Constructor Detail

VtiFpResponse

public VtiFpResponse(javax.servlet.http.HttpServletResponse response)

Constructor

Parameters:

response - HttpServletResponse

Method Detail

beginPacket

public void beginPacket()
                 throws IOException

Begins vermeer packet with header

Throws:

IOException

endPacket

public void endPacket()
               throws IOException

Ends vermeer packet with footer

Throws:

IOException

beginList

public void beginList(String listName)
               throws IOException

Begins list in root of packet or in other list

Parameters:

listName - name of list

Throws:

IOException

beginList

public void beginList()
               throws IOException

Begins anonymous list

Throws:

IOException

endList

public void endList()
             throws IOException

Ends current list

Throws:

IOException

addParameter

public void addParameter(String value)
                  throws IOException

Adds parameter in root of packet or in list

Parameters:

value - parameter value

Throws:

IOException

addParameter

public void addParameter(String key,
                String value)
                  throws IOException

Add parameter

Parameters:

key - param key

value - param value

Throws:

IOException

beginVtiAnswer

public void beginVtiAnswer(String methodName,
                  String version)
                    throws IOException

Begins vti response with header and method name and version

Parameters:

methodName - method name

version - version string

Throws:

IOException

endVtiAnswer

public void endVtiAnswer()
                  throws IOException

Ends vti answer with vermeer packet footer

Throws:

IOException

writeMetaDictionary

public void writeMetaDictionary(VtiProperty property,
                       VtiType type,
                       VtiConstraint constraint,
                       String value)
                         throws IOException

Throws:

IOException