org.alfresco.module.vti.web.fp

Class VtiFpRequest

java.lang.Object

javax.servlet.ServletRequestWrapper

javax.servlet.http.HttpServletRequestWrapper

org.alfresco.module.vti.web.fp.VtiFpRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class VtiFpRequest
extends HttpServletRequestWrapper

VtiFpRequest is wrapper for HttpServletRequest. It provides specific methods which allow to retrieve appropriate parameters from request data for Frontpage extension protocol.

Author:

Michael Shavnev

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CBRACKET
protected static String	COMMASEP
protected static String	LISTSEP
protected static String	METADICT_CONSTRAINT_IGNORE
protected static String	METADICT_CONSTRAINT_RO
protected static String	METADICT_CONSTRAINT_RW
protected static String	METADICT_VALUE_BOOLEAN
protected static String	METADICT_VALUE_DOUBLE
protected static String	METADICT_VALUE_INT_VECTOR
protected static String	METADICT_VALUE_STRING
protected static String	METADICT_VALUE_STRING_VECTOR
protected static String	METADICT_VALUE_TIME
protected static String	OBRACKET

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
VtiFpRequest(HttpServletRequest request) Constructor

Method Summary

Modifier and Type	Method and Description
String	getAlfrescoContextName()
Map<String,String>	getDictionary(String paramName) Get dictionary
Map<String,Object>	getMetaDictionary(String paramName) Get meta-dictionary
String	getNotEncodedParameter(String name)
String	getParameter(String name)
boolean	getParameter(String paramName, boolean defaultValue) Get boolean parameter
Date	getParameter(String paramName, Date defaultValue) Get Date parameter
DocsMetaInfo	getParameter(String paramName, DocsMetaInfo defaultValue) Get DocsMetaInfo parameter
Document	getParameter(String paramName, Document defaultValue) Get Document parameter
int	getParameter(String paramName, int defaultValue) Get VtiSortField parameter
List<String>	getParameter(String paramName, List<String> defaultValue) Get List of Strings parameter
String	getParameter(String paramName, String defaultValue) Get String parameter
VtiSort	getParameter(String paramName, VtiSort defaultValue) Get VtiSort parameter
VtiSortField	getParameter(String paramName, VtiSortField defaultValue) Get VtiSortField parameter
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
void	setParameter(String name, String value) Set additional specific request parameter
void	setParameterValues(String name, String[] values) Set additional specific request parameters

Methods inherited from class javax.servlet.http.HttpServletRequestWrapper

getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole

Methods inherited from class javax.servlet.ServletRequestWrapper

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequest, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding, setRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.ServletRequest

getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding

Field Detail

OBRACKET

protected static final String OBRACKET

See Also:

Constant Field Values

CBRACKET

protected static final String CBRACKET

See Also:

Constant Field Values

LISTSEP

protected static final String LISTSEP

See Also:

Constant Field Values

COMMASEP

protected static final String COMMASEP

See Also:

Constant Field Values

METADICT_CONSTRAINT_IGNORE

protected static final String METADICT_CONSTRAINT_IGNORE

See Also:

Constant Field Values

METADICT_CONSTRAINT_RO

protected static final String METADICT_CONSTRAINT_RO

See Also:

Constant Field Values

METADICT_CONSTRAINT_RW

protected static final String METADICT_CONSTRAINT_RW

See Also:

Constant Field Values

METADICT_VALUE_TIME

protected static final String METADICT_VALUE_TIME

See Also:

Constant Field Values

METADICT_VALUE_STRING_VECTOR

protected static final String METADICT_VALUE_STRING_VECTOR

See Also:

Constant Field Values

METADICT_VALUE_BOOLEAN

protected static final String METADICT_VALUE_BOOLEAN

See Also:

Constant Field Values

METADICT_VALUE_INT_VECTOR

protected static final String METADICT_VALUE_INT_VECTOR

See Also:

Constant Field Values

METADICT_VALUE_DOUBLE

protected static final String METADICT_VALUE_DOUBLE

See Also:

Constant Field Values

METADICT_VALUE_STRING

protected static final String METADICT_VALUE_STRING

See Also:

Constant Field Values

Constructor Detail

VtiFpRequest

public VtiFpRequest(HttpServletRequest request)

Constructor

Parameters:

request - HttpServletRequest

Method Detail

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface ServletRequest

Overrides:

getParameter in class ServletRequestWrapper

See Also:

ServletRequestWrapper.getParameter(java.lang.String)

getNotEncodedParameter

public String getNotEncodedParameter(String name)

See Also:

ServletRequestWrapper.getParameter(java.lang.String)

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface ServletRequest

Overrides:

getParameterValues in class ServletRequestWrapper

See Also:

ServletRequestWrapper.getParameterValues(java.lang.String)

setParameterValues

public void setParameterValues(String name,
                               String[] values)

Set additional specific request parameters

Parameters:

name - parameter name

values - parameter values

setParameter

public void setParameter(String name,
                         String value)

Set additional specific request parameter

Parameters:

name - parameter name

value - parameter value

getParameterMap

public Map<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

Overrides:

getParameterMap in class ServletRequestWrapper

See Also:

ServletRequestWrapper.getParameterMap()

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

Overrides:

getParameterNames in class ServletRequestWrapper

See Also:

ServletRequestWrapper.getParameterNames()

getParameter

public boolean getParameter(String paramName,
                            boolean defaultValue)

Get boolean parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

boolean parameter from request or defaultValue if not present

getParameter

public Date getParameter(String paramName,
                         Date defaultValue)

Get Date parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

Date parameter from request or defaultValue if not present

getParameter

public VtiSort getParameter(String paramName,
                            VtiSort defaultValue)

Get VtiSort parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

VtiSort parameter from request or defaultValue if not present

getParameter

public VtiSortField getParameter(String paramName,
                                 VtiSortField defaultValue)

Get VtiSortField parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

VtiSortField parameter from request or defaultValue if not present

getParameter

public int getParameter(String paramName,
                        int defaultValue)

Get VtiSortField parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

int parameter from request or defaultValue if not present

getParameter

public String getParameter(String paramName,
                           String defaultValue)
                    throws UnsupportedEncodingException

Get String parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

String parameter from request or defaultValue if not present

Throws:

UnsupportedEncodingException

getParameter

public List<String> getParameter(String paramName,
                                 List<String> defaultValue)

Get List of Strings parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

parameter from request or defaultValue if not present

getParameter

public DocsMetaInfo getParameter(String paramName,
                                 DocsMetaInfo defaultValue)

Get DocsMetaInfo parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

DocsMetaInfo parameter from request or defaultValue if not present

getParameter

public Document getParameter(String paramName,
                             Document defaultValue)
                      throws IOException

Get Document parameter

Parameters:

paramName - name of parameter

defaultValue - default value for parameter if not present

Returns:

Document parameter from request or defaultValue if not present

Throws:

IOException

getDictionary

public Map<String,String> getDictionary(String paramName)

Get dictionary

Parameters:

paramName - name of parameter

Returns:

parameter from request

getMetaDictionary

public Map<String,Object> getMetaDictionary(String paramName)

Get meta-dictionary

Parameters:

paramName - name of parameter

Returns:

parameter from request

getAlfrescoContextName

public String getAlfrescoContextName()

Returns:

context name