com.openedit
Interface WebPageRequest

All Known Implementing Classes:

BaseWebPageRequest, TestWebPageRequest

public interface WebPageRequest

Author:

Matt Avery, mavery@einnovation.com

Method Summary

WebPageRequest	copy()
WebPageRequest	copy(Page inPage)
java.lang.String	findValue(java.lang.String inName) Looks in the action, page and parameter for a value
void	forward(java.lang.String inUrl) This will simply render a new page instead of the page the user was expecting
Page	getContentPage()
java.lang.String	getContentProperty(java.lang.String inKey)
PageAction	getCurrentAction()
java.lang.String	getLanguage()
java.lang.String	getLocale()
java.lang.String	getLocalRequestParameter(java.lang.String inKey)
java.io.OutputStream	getOutputStream()
Page	getPage() This is the page that this context refers to in the getPath() method
java.util.Map	getPageMap()
java.lang.String	getPageProperty(java.lang.String inKey)
PageStreamer	getPageStreamer()
java.lang.Object	getPageValue(java.lang.String inKey) Convenience methods for managing Velocity context objects.
java.lang.String	getParam(java.lang.String inKey) The returned values are escaped and suitable to show in a web browser
java.util.Map	getParameterMap()
WebPageRequest	getParent()
java.lang.String	getPath() This is the path to the content
java.lang.String	getPathUrl() Is the full path to the page you are on.
java.lang.String	getPathUrlWithoutContext()
java.lang.String	getReferringPage()
javax.servlet.http.HttpServletRequest	getRequest()
java.lang.String[]	getRequestActions()
java.lang.String	getRequestParameter(java.lang.String inKey)
java.lang.String[]	getRequestParameters(java.lang.String inKey)
java.lang.String	getRequestParamsAsList()
java.lang.String	getRequiredParameter(java.lang.String inParameterName)
javax.servlet.http.HttpServletResponse	getResponse()
javax.servlet.http.HttpSession	getSession()
java.lang.Object	getSessionValue(java.lang.String inKey) Convenience methods for managing session objects.
java.lang.String	getSiteRoot()
java.lang.String	getText(java.lang.String inKey)
User	getUser()
java.lang.String	getUserName()
java.io.Writer	getWriter()
boolean	hasCancelActions()
boolean	hasForwarded()
boolean	hasRedirected()
boolean	isEditable() Determine whether this page can be edited by the given user.
void	putPageStreamer(PageStreamer inStreamer)
void	putPageValue(java.lang.String inKey, java.lang.Object inObject)
void	putProtectedPageValue(java.lang.String inKey, java.lang.Object inObject) Add a protected page value to this page request.
void	putSessionValue(java.lang.String inKey, java.lang.Object inObject)
void	redirect(java.lang.String inUrl) The redirect will send the browser to a new page This looses any parameters to the original page
void	redirectPermanently(java.lang.String inPath) This is used to tell search engines to use the new links
void	removePageValue(java.lang.String inKey)
void	removeSessionValue(java.lang.String inKey)
void	setCancelActions(boolean inB)
void	setCurrentAction(PageAction inAction)
void	setEditable(boolean inEdi)
void	setHasForwarded(boolean inB)
void	setHasRedirected(boolean inB)
void	setPage(Page inPage)
void	setRequestParameter(java.lang.String inKey, java.lang.String inValue)
void	setRequestParameter(java.lang.String inKey, java.lang.String[] inValue)
void	setUser(User inUser)
void	setWriter(java.io.Writer inW)
void	unpackageVariables()

Method Detail

getRequest

javax.servlet.http.HttpServletRequest getRequest()

getResponse

javax.servlet.http.HttpServletResponse getResponse()

getSession

javax.servlet.http.HttpSession getSession()

redirect

void redirect(java.lang.String inUrl)

The redirect will send the browser to a new page This looses any parameters to the original page

Parameters:

inInUrl - can begin with http or be a path /index.html you do not need $home in there

redirectPermanently

void redirectPermanently(java.lang.String inPath)

This is used to tell search engines to use the new links

Parameters:

inPath -

forward

void forward(java.lang.String inUrl)
             throws OpenEditException

This will simply render a new page instead of the page the user was expecting

Parameters:

inInUrl - should be a path such as /index.html

Throws:

OpenEditException

getPageValue

java.lang.Object getPageValue(java.lang.String inKey)

Convenience methods for managing Velocity context objects.

findValue

java.lang.String findValue(java.lang.String inName)

Looks in the action, page and parameter for a value

Parameters:

inName -

Returns:

getPageProperty

java.lang.String getPageProperty(java.lang.String inKey)

getContentProperty

java.lang.String getContentProperty(java.lang.String inKey)

putPageValue

void putPageValue(java.lang.String inKey,
                  java.lang.Object inObject)

putProtectedPageValue

void putProtectedPageValue(java.lang.String inKey,
                           java.lang.Object inObject)

Add a protected page value to this page request. Protected values are reserved for use by OpenEdit itself and should not be overriden in general practice.

Parameters:

inKey -

inObject -

removePageValue

void removePageValue(java.lang.String inKey)

getPageMap

java.util.Map getPageMap()

getSessionValue

java.lang.Object getSessionValue(java.lang.String inKey)

Convenience methods for managing session objects.

putSessionValue

void putSessionValue(java.lang.String inKey,
                     java.lang.Object inObject)

removeSessionValue

void removeSessionValue(java.lang.String inKey)

getRequestParameter

java.lang.String getRequestParameter(java.lang.String inKey)

getParam

java.lang.String getParam(java.lang.String inKey)

The returned values are escaped and suitable to show in a web browser

Parameters:

inKey -

Returns:

getRequestParameters

java.lang.String[] getRequestParameters(java.lang.String inKey)

setRequestParameter

void setRequestParameter(java.lang.String inKey,
                         java.lang.String inValue)

setRequestParameter

void setRequestParameter(java.lang.String inKey,
                         java.lang.String[] inValue)

getParameterMap

java.util.Map getParameterMap()

Returns:

a mutable map of the request parameters

getRequiredParameter

java.lang.String getRequiredParameter(java.lang.String inParameterName)
                                      throws OpenEditException

Throws:

OpenEditException

getUser

User getUser()

setUser

void setUser(User inUser)

Parameters:

inObject -

getPath

java.lang.String getPath()

This is the path to the content

getPage

Page getPage()

This is the page that this context refers to in the getPath() method

Returns:

getPathUrl

java.lang.String getPathUrl()

Is the full path to the page you are on. This includes any arguments or parameters

Returns:

fullpath

getPathUrlWithoutContext

java.lang.String getPathUrlWithoutContext()

getOutputStream

java.io.OutputStream getOutputStream()

getWriter

java.io.Writer getWriter()

setWriter

void setWriter(java.io.Writer inW)

getPageStreamer

PageStreamer getPageStreamer()

putPageStreamer

void putPageStreamer(PageStreamer inStreamer)

hasRedirected

boolean hasRedirected()

Returns:

hasForwarded

boolean hasForwarded()

setHasRedirected

void setHasRedirected(boolean inB)

setHasForwarded

void setHasForwarded(boolean inB)

hasCancelActions

boolean hasCancelActions()

setCancelActions

void setCancelActions(boolean inB)

getContentPage

Page getContentPage()

Returns:

isEditable

boolean isEditable()

Determine whether this page can be edited by the given user. The page is editable if:

• the page's repository is not read-only;
• the "editable" property is not present or equal to "true"; and
• the edit filter is not present or passes the given user.

Parameters:

inUser - The user to query

inContext - DOCME

Returns:

boolean true if the page is editable by the user, false if not

Throws:

OpenEditException - DOCME

setEditable

void setEditable(boolean inEdi)

getRequestActions

java.lang.String[] getRequestActions()

copy

WebPageRequest copy()

Returns:

copy

WebPageRequest copy(Page inPage)

Parameters:

inPage -

Returns:

setPage

void setPage(Page inPage)

Parameters:

inPage -

getParent

WebPageRequest getParent()

setCurrentAction

void setCurrentAction(PageAction inAction)

Parameters:

inAction -

getCurrentAction

PageAction getCurrentAction()

getLocale

java.lang.String getLocale()

getLanguage

java.lang.String getLanguage()

getUserName

java.lang.String getUserName()

getLocalRequestParameter

java.lang.String getLocalRequestParameter(java.lang.String inKey)

getReferringPage

java.lang.String getReferringPage()

getRequestParamsAsList

java.lang.String getRequestParamsAsList()

unpackageVariables

void unpackageVariables()

getText

java.lang.String getText(java.lang.String inKey)

getSiteRoot

java.lang.String getSiteRoot()