com.ibm.websphere.personalization
Interface PznRequestObjectInterface

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

PznHttpRequestObjectInterface, PznPortletRequestObjectInterface

All Known Implementing Classes:

PznPortletRequestObjectImplementor, PznRequestObjectImplementor

public interface PznRequestObjectInterface
extends java.io.Serializable

This is the interface used to access various attributes for rules.

For http contexts, it provides access to the HttpRequest and HttpSession attributes. For non-http contexts, it provides the same interface to a surrogate for the request and session.

Field Summary

static java.lang.String

COPYRIGHT

Method Summary

boolean	addCookie(javax.servlet.http.Cookie cookie)
java.lang.String	getContextPath()
javax.servlet.http.Cookie	getCookie(java.lang.String cookieName)
javax.servlet.http.Cookie[]	getCookies()
java.util.Locale	getLocale()
java.lang.String	getRemoteHost()
java.lang.String	getRemoteUser()
java.lang.Object	getRequestAttribute(java.lang.String itemName)
java.util.Enumeration	getRequestAttributeNames()
java.lang.String	getRequestParameter(java.lang.String itemName)
java.util.Enumeration	getRequestParameterNames()
java.lang.String[]	getRequestParameterValues(java.lang.String itemName)
com.ibm.websphere.personalization.resources.ResourceContext	getResourceContext() Deprecated.
java.lang.String	getServerName()
java.lang.Object	getSessionAttribute(java.lang.String itemName)
java.util.Enumeration	getSessionAttributeNames()
java.lang.String	getUserPrincipal()
void	removeRequestAttribute(java.lang.String itemName)
void	removeSessionAttribute(java.lang.String itemName)
boolean	setContextPath(java.lang.String contextPath)
boolean	setLocale(java.util.Locale locale)
boolean	setRemoteUser(java.lang.String userName)
void	setRequestAttribute(java.lang.String itemName, java.lang.Object itemValue)
boolean	setRequestParameter(java.lang.String itemName, java.lang.String itemValue)
boolean	setRequestParameterValues(java.lang.String itemName, java.lang.String[] itemValues)
boolean	setSessionAttribute(java.lang.String itemName, java.lang.Object itemValue)
boolean	setUserPrincipal(java.lang.String userPrincipal)

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

Method Detail

getRequestAttribute

java.lang.Object getRequestAttribute(java.lang.String itemName)

setRequestAttribute

void setRequestAttribute(java.lang.String itemName,
                         java.lang.Object itemValue)

removeRequestAttribute

void removeRequestAttribute(java.lang.String itemName)

getRequestAttributeNames

java.util.Enumeration getRequestAttributeNames()

getRemoteHost

java.lang.String getRemoteHost()

getServerName

java.lang.String getServerName()

getLocale

java.util.Locale getLocale()

setLocale

boolean setLocale(java.util.Locale locale)

getRequestParameter

java.lang.String getRequestParameter(java.lang.String itemName)

setRequestParameter

boolean setRequestParameter(java.lang.String itemName,
                            java.lang.String itemValue)

getRequestParameterNames

java.util.Enumeration getRequestParameterNames()

getRequestParameterValues

java.lang.String[] getRequestParameterValues(java.lang.String itemName)

setRequestParameterValues

boolean setRequestParameterValues(java.lang.String itemName,
                                  java.lang.String[] itemValues)

getSessionAttribute

java.lang.Object getSessionAttribute(java.lang.String itemName)

setSessionAttribute

boolean setSessionAttribute(java.lang.String itemName,
                            java.lang.Object itemValue)

removeSessionAttribute

void removeSessionAttribute(java.lang.String itemName)

getSessionAttributeNames

java.util.Enumeration getSessionAttributeNames()

getRemoteUser

java.lang.String getRemoteUser()

setRemoteUser

boolean setRemoteUser(java.lang.String userName)

getContextPath

java.lang.String getContextPath()

setContextPath

boolean setContextPath(java.lang.String contextPath)

getCookies

javax.servlet.http.Cookie[] getCookies()

getCookie

javax.servlet.http.Cookie getCookie(java.lang.String cookieName)

addCookie

boolean addCookie(javax.servlet.http.Cookie cookie)

getResourceContext

com.ibm.websphere.personalization.resources.ResourceContext getResourceContext()

Deprecated.

getUserPrincipal

java.lang.String getUserPrincipal()

setUserPrincipal

boolean setUserPrincipal(java.lang.String userPrincipal)