|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.p13n.http.HttpConfigurableEntity com.bea.p13n.http.Request
public class Request
The Personalization Server implementation of the Http Servlet Request interface.
This object is used by the Personalization Server to get properties on an Http Request in a format understandable to Personalization Core Services such as the RulesService.
This will use a DefaultRequestFilter
to
filter out attributes. After loading the request attributes, this will
additionally call out to any AttributeLoaders
specified by the AttributeLoaderBean's RequestLoaders attribute.
Nested Class Summary | |
---|---|
static interface |
Request.AttributeLoader
An object which is capable of loading additional attributes into a Request. |
Field Summary | |
---|---|
static boolean |
ATTRIBUTE_OVERRIDE
Controls whether the getProperty and getPropertyNoDefault methods
check the HttpRequest attributes prior to the HttpRequest parameters. |
static String |
AUTHORIZATION_SCHEME
|
static String |
CHAR_ENCODING
|
static String |
CONTENT_LENGTH
|
static String |
CONTENT_TYPE
|
static String |
CONTEXT_PATH
|
static String |
LOCAL_ADDR
|
static String |
LOCAL_NAME
|
static String |
LOCAL_PORT
|
static String |
LOCALE
|
static String |
PATH_INFO
|
static String |
PATH_TRANSLATED
|
static String |
QUERY_STRING
|
static String |
REMOTE_ADDRESS
|
static String |
REMOTE_HOST
|
static String |
REMOTE_PORT
|
static String |
REMOTE_USER
|
static String |
REQUEST_METHOD
|
static String |
REQUEST_PROPERTY_SET_TYPE
request property set type |
static String |
REQUEST_PROTOCOL
|
static String |
REQUEST_URI
|
static String |
REQUEST_URL
|
static String |
SCHEME
|
static String |
SERVER_NAME
|
static String |
SERVER_PORT
|
static String |
SERVLET_PATH
|
static String |
USER_PRINCIPAL
|
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Fields inherited from interface com.bea.p13n.property.ConfigurableEntity |
---|
RESERVED_PROPERTY_SET |
Constructor Summary | |
---|---|
Request()
Default Constructor |
|
Request(javax.servlet.http.HttpServletRequest request)
Creates a P13N HTTP Request. |
|
Request(javax.servlet.http.HttpServletRequest request,
boolean createSession)
Creates a P13N HTTP Request and, possibly, Session. |
Methods inherited from class com.bea.p13n.http.HttpConfigurableEntity |
---|
getJndiName, getPkString, getProperty, getPropertyAsString, getPropertyDefault, getPropertySetManager, getUniqueId, removeProperty, setProperty |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.bea.p13n.http.SerializableRequest |
---|
getProperty, getPropertyAsString |
Methods inherited from interface com.bea.p13n.property.ConfigurableEntity |
---|
getJndiName, getPkString, getUniqueId, removeProperty, setProperty |
Field Detail |
---|
public static final String REQUEST_PROPERTY_SET_TYPE
public static final String REQUEST_METHOD
public static final String REQUEST_URI
public static final String REQUEST_URL
public static final String REQUEST_PROTOCOL
public static final String SERVLET_PATH
public static final String PATH_INFO
public static final String PATH_TRANSLATED
public static final String CONTEXT_PATH
public static final String QUERY_STRING
public static final String CONTENT_LENGTH
public static final String CONTENT_TYPE
public static final String SERVER_NAME
public static final String SERVER_PORT
public static final String REMOTE_USER
public static final String REMOTE_ADDRESS
public static final String REMOTE_HOST
public static final String REMOTE_PORT
public static final String LOCAL_NAME
public static final String LOCAL_ADDR
public static final String LOCAL_PORT
public static final String SCHEME
public static final String AUTHORIZATION_SCHEME
public static final String LOCALE
public static final String CHAR_ENCODING
public static final String USER_PRINCIPAL
public static final boolean ATTRIBUTE_OVERRIDE
getProperty
and getPropertyNoDefault
methods
check the HttpRequest attributes prior to the HttpRequest parameters. By default,
the parameters are checked first. To override the default set the system property
com.bea.p13n.http.Request.AttributeOverride=Yes
Constructor Detail |
---|
public Request()
public Request(javax.servlet.http.HttpServletRequest request)
request
- the HttpServletRequest
used to set and
retrieve properties.public Request(javax.servlet.http.HttpServletRequest request, boolean createSession)
request
- the HttpServletRequest
used to set and
retrieve properties.createSession
- true to also create a Session
from
the request's session and set it on this.setP13NSession(com.bea.p13n.http.Session)
,
Session
Method Detail |
---|
public static Request createP13NRequest(javax.servlet.http.HttpServletRequest request) throws IllegalArgumentException
request
- the request used to create the Session object.
HttpServletRequest
IllegalArgumentException
- If the paramater is null.public void setP13NSession(Session session)
public void setP13NSession(SerializableSession session)
SerializableRequest
setP13NSession
in interface SerializableRequest
public Session getP13NSession()
getP13NSession
in interface SerializableRequest
public void setPrincipal(javax.servlet.http.HttpServletRequest request)
setPrincipal
in interface SerializableRequest
public Object getPropertyNoDefault(String propertySet, String propertyName)
getPropertyNoDefault
in interface SerializableRequest
getPropertyNoDefault
in interface ConfigurableEntity
getPropertyNoDefault
in class HttpConfigurableEntity
propertySet
- The name of the property set for which the property is
sought. This only used if no property is found in the request
and we use the scope to look up the default value in the property set for the
request. This parameter can be null.propertyName
- The property name
public Object getProperty(String propertySet, String propertyName)
getProperty
in interface SerializableRequest
getProperty
in interface ConfigurableEntity
getProperty
in class HttpConfigurableEntity
propertySet
- The name of the property set for which the property is
sought. This only used if no property is found in the request
and we use the scope to look up the default value in the property set for the
request. This parameter can be null.propertyName
- The property name
getPropertyNoDefault(java.lang.String, java.lang.String)
public String getMethod(String name)
public Object getAttribute(String name)
getAttribute
in interface javax.servlet.ServletRequest
public Enumeration getAttributeNames()
getAttributeNames
in interface javax.servlet.ServletRequest
public String getCharacterEncoding()
getCharacterEncoding
in interface javax.servlet.ServletRequest
public int getContentLength()
getContentLength
in interface javax.servlet.ServletRequest
public String getContentType()
getContentType
in interface javax.servlet.ServletRequest
public javax.servlet.ServletInputStream getInputStream()
getInputStream
in interface javax.servlet.ServletRequest
public String getParameter(String name)
getParameter
in interface javax.servlet.ServletRequest
public Enumeration getParameterNames()
getParameterNames
in interface javax.servlet.ServletRequest
public String[] getParameterValues(String name)
getParameterValues
in interface javax.servlet.ServletRequest
public String getProtocol()
getProtocol
in interface javax.servlet.ServletRequest
public String getScheme()
getScheme
in interface javax.servlet.ServletRequest
public String getServerName()
getServerName
in interface javax.servlet.ServletRequest
public int getServerPort()
getServerPort
in interface javax.servlet.ServletRequest
public BufferedReader getReader()
getReader
in interface javax.servlet.ServletRequest
public String getRemoteAddr()
getRemoteAddr
in interface javax.servlet.ServletRequest
public String getRemoteHost()
getRemoteHost
in interface javax.servlet.ServletRequest
public int getRemotePort()
getRemotePort
in interface javax.servlet.ServletRequest
public String getLocalName()
getLocalName
in interface javax.servlet.ServletRequest
public String getLocalAddr()
getLocalAddr
in interface javax.servlet.ServletRequest
public int getLocalPort()
getLocalPort
in interface javax.servlet.ServletRequest
public void setAttribute(String name, Object o)
setAttribute
in interface javax.servlet.ServletRequest
public void removeAttribute(String name)
removeAttribute
in interface javax.servlet.ServletRequest
public Locale getLocale()
getLocale
in interface javax.servlet.ServletRequest
public Enumeration getLocales()
getLocales
in interface javax.servlet.ServletRequest
public boolean isSecure()
isSecure
in interface javax.servlet.ServletRequest
public javax.servlet.RequestDispatcher getRequestDispatcher(String uri)
getRequestDispatcher
in interface javax.servlet.ServletRequest
public String getRealPath(String path)
getRealPath
in interface javax.servlet.ServletRequest
public String getAuthType()
getAuthType
in interface javax.servlet.http.HttpServletRequest
public javax.servlet.http.Cookie[] getCookies()
getCookies
in interface javax.servlet.http.HttpServletRequest
public long getDateHeader(String name)
getDateHeader
in interface javax.servlet.http.HttpServletRequest
public String getHeader(String name)
getHeader
in interface javax.servlet.http.HttpServletRequest
public Enumeration getHeaders(String name)
getHeaders
in interface javax.servlet.http.HttpServletRequest
public Enumeration getHeaderNames()
getHeaderNames
in interface javax.servlet.http.HttpServletRequest
public int getIntHeader(String name)
getIntHeader
in interface javax.servlet.http.HttpServletRequest
public String getMethod()
getMethod
in interface javax.servlet.http.HttpServletRequest
public String getPathInfo()
getPathInfo
in interface javax.servlet.http.HttpServletRequest
public String getPathTranslated()
getPathTranslated
in interface javax.servlet.http.HttpServletRequest
public String getContextPath()
getContextPath
in interface javax.servlet.http.HttpServletRequest
public String getQueryString()
getQueryString
in interface javax.servlet.http.HttpServletRequest
public String getRemoteUser()
getRemoteUser
in interface javax.servlet.http.HttpServletRequest
public boolean isUserInRole(String role)
isUserInRole
in interface javax.servlet.http.HttpServletRequest
public Principal getUserPrincipal()
getUserPrincipal
in interface javax.servlet.http.HttpServletRequest
public String getRequestedSessionId()
getRequestedSessionId
in interface javax.servlet.http.HttpServletRequest
public String getRequestURI()
getRequestURI
in interface javax.servlet.http.HttpServletRequest
public String getServletPath()
getServletPath
in interface javax.servlet.http.HttpServletRequest
public javax.servlet.http.HttpSession getSession(boolean create)
getSession
in interface javax.servlet.http.HttpServletRequest
public javax.servlet.http.HttpSession getSession()
getSession
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdValid()
isRequestedSessionIdValid
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdFromCookie()
isRequestedSessionIdFromCookie
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdFromURL()
isRequestedSessionIdFromURL
in interface javax.servlet.http.HttpServletRequest
public boolean isRequestedSessionIdFromUrl()
isRequestedSessionIdFromUrl
in interface javax.servlet.http.HttpServletRequest
public Map getParameterMap()
getParameterMap
in interface javax.servlet.ServletRequest
public void setCharacterEncoding(String anEncoding)
setCharacterEncoding
in interface javax.servlet.ServletRequest
public StringBuffer getRequestURL()
getRequestURL
in interface javax.servlet.http.HttpServletRequest
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |