com.bea.p13n.http
Interface SerializableRequest

All Superinterfaces
ConfigurableEntity, javax.servlet.http.HttpServletRequest, Serializable, javax.servlet.ServletRequest
All Known Implementing Classes:
Request

public interface SerializableRequest
extends javax.servlet.http.HttpServletRequest, ConfigurableEntity, Serializable

An HttpServletRequest which also serves as a ConfigurableEntity, and can be Serialized.


Field Summary
 
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
 
Method Summary
 SerializableSession getP13NSession()
          Get the P13N Session related to this request (can be null).
 Object getProperty(String propertySet, String propertyName)
          Retrieve the value that was persisted for this entity for the given property, within the given property set.
 Object getProperty(String propertySet, String propertyName, Object defaultValue)
          Provided as convenience method so client code can still provide a default value
 String getPropertyAsString(String propertySet, String propertyName)
          Convenience method to return a property as a String.
 Object getPropertyNoDefault(String propertySet, String propertyName)
          Retrieve the value associated with the named key in the specified property set, but does not return a default value from the property's PropertyDefinition if a value was not persisted for this entity.
 void setP13NSession(SerializableSession session)
          Set the P13N Session related to this request.
 void setPrincipal(javax.servlet.http.HttpServletRequest request)
           
 
Methods inherited from interface javax.servlet.http.HttpServletRequest
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 interface javax.servlet.ServletRequest
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, isSecure, removeAttribute, setAttribute, setCharacterEncoding
 
Methods inherited from interface com.bea.p13n.property.ConfigurableEntity
getJndiName, getPkString, getUniqueId, removeProperty, setProperty
 

Method Detail

setP13NSession

void setP13NSession(SerializableSession session)
Set the P13N Session related to this request.


getP13NSession

SerializableSession getP13NSession()
Get the P13N Session related to this request (can be null).


setPrincipal

void setPrincipal(javax.servlet.http.HttpServletRequest request)

getProperty

Object getProperty(String propertySet,
                   String propertyName)
Description copied from interface: ConfigurableEntity
Retrieve the value that was persisted for this entity for the given property, within the given property set. If the entity does not have a value persisted for this property, the default value from the property set will be returned.

Specified by:
getProperty in interface ConfigurableEntity
Parameters
propertySet - The name of the property set to look in
propertyName - The name of the property to retrieve.
Returns
the value for this property, or null if all searches failed

getPropertyAsString

String getPropertyAsString(String propertySet,
                           String propertyName)
Description copied from interface: ConfigurableEntity
Convenience method to return a property as a String.

Specified by:
getPropertyAsString in interface ConfigurableEntity
Parameters
propertySet - The name of the property set to look in
propertyName - The name of the property to retrieve.
Returns
the value for this property as a String, or null if all searches failed

getPropertyNoDefault

Object getPropertyNoDefault(String propertySet,
                            String propertyName)
Description copied from interface: ConfigurableEntity
Retrieve the value associated with the named key in the specified property set, but does not return a default value from the property's PropertyDefinition if a value was not persisted for this entity. This method is used by the implementation of the getProperty methods so that the search in the successor hierarchy does not return a default value from the Schema.

Specified by:
getPropertyNoDefault in interface ConfigurableEntity
Parameters
propertySet - The name of the property set
propertyName - The name of the property to retrieve.
Returns
the value for this property, or null if all searches failed

getProperty

Object getProperty(String propertySet,
                   String propertyName,
                   Object defaultValue)
Provided as convenience method so client code can still provide a default value



Copyright © 2011, Oracle. All rights reserved.