org.craftercms.engine.util.freemarker

Class HttpRequestHashModel

java.lang.Object

org.craftercms.engine.util.freemarker.HttpRequestHashModel

All Implemented Interfaces:

freemarker.template.TemplateHashModel, freemarker.template.TemplateHashModelEx, freemarker.template.TemplateModel

public class HttpRequestHashModel
extends Object
implements freemarker.template.TemplateHashModelEx

Just like HttpRequestHashModel, but besides returning request attributes, it also returns values for the following properties of the request:

• scheme
• serverName
• serverPort
• contextPath
• servletPath
• requestURI
• queryString

Author:

avasquez

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CONTEXT_PATH
static String	KEY_QUERY_STRING
static String	KEY_REQUEST_URI
static String	KEY_SCHEME
static String	KEY_SERVER_NAME
static String	KEY_SERVER_PORT
static String	KEY_SERVLET_PATH

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor and Description
HttpRequestHashModel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, freemarker.template.ObjectWrapper wrapper)
HttpRequestHashModel(javax.servlet.http.HttpServletRequest request, freemarker.template.ObjectWrapper wrapper)

Method Summary

Modifier and Type	Method and Description
freemarker.template.TemplateModel	get(String key)
freemarker.template.ObjectWrapper	getObjectWrapper()
javax.servlet.http.HttpServletRequest	getRequest()
javax.servlet.http.HttpServletResponse	getResponse()
boolean	isEmpty()
freemarker.template.TemplateCollectionModel	keys()
int	size()
freemarker.template.TemplateCollectionModel	values()

Methods inherited from class java.lang.Object

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

Field Detail

KEY_SCHEME

public static final String KEY_SCHEME

See Also:

Constant Field Values

KEY_SERVER_NAME

public static final String KEY_SERVER_NAME

See Also:

Constant Field Values

KEY_SERVER_PORT

public static final String KEY_SERVER_PORT

See Also:

Constant Field Values

KEY_CONTEXT_PATH

public static final String KEY_CONTEXT_PATH

See Also:

Constant Field Values

KEY_SERVLET_PATH

public static final String KEY_SERVLET_PATH

See Also:

Constant Field Values

KEY_REQUEST_URI

public static final String KEY_REQUEST_URI

See Also:

Constant Field Values

KEY_QUERY_STRING

public static final String KEY_QUERY_STRING

See Also:

Constant Field Values

Constructor Detail

HttpRequestHashModel

public HttpRequestHashModel(javax.servlet.http.HttpServletRequest request,
                            freemarker.template.ObjectWrapper wrapper)

HttpRequestHashModel

public HttpRequestHashModel(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response,
                            freemarker.template.ObjectWrapper wrapper)

Method Detail

get

public freemarker.template.TemplateModel get(String key)
                                      throws freemarker.template.TemplateModelException

Specified by:

get in interface freemarker.template.TemplateHashModel

Throws:

freemarker.template.TemplateModelException

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface freemarker.template.TemplateHashModel

size

public int size()

Specified by:

size in interface freemarker.template.TemplateHashModelEx

keys

public freemarker.template.TemplateCollectionModel keys()

Specified by:

keys in interface freemarker.template.TemplateHashModelEx

values

public freemarker.template.TemplateCollectionModel values()

Specified by:

values in interface freemarker.template.TemplateHashModelEx

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

getResponse

public javax.servlet.http.HttpServletResponse getResponse()

getObjectWrapper

public freemarker.template.ObjectWrapper getObjectWrapper()