|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortalServletRequest
The portal request object encapsulates all information from a portal client
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Fields inherited from interface javax.servlet.http.HttpServletRequest |
---|
BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH |
Fields inherited from interface atg.portal.servlet.Attribute |
---|
COMMUNITY, COMMUNITY_PAGES, DEVICE, DISPLAYMODE, GEAR, GEARMODE, GEARSERVLETREQUEST, GEARSERVLETRESPONSE, PAGE, PORTAL, PORTALCONTEXTPATH, PORTALPATHINFO, PORTALQUERYSTRING, PORTALSERVLETPATH, PORTALSERVLETREQUEST, PORTALSERVLETRESPONSE |
Method Summary | |
---|---|
Device |
getDevice()
Access the requested client device |
java.lang.String |
getPortalContextPath()
Access the portal context path |
java.lang.String |
getPortalPathInfo()
Access the portal path info path |
java.lang.String |
getPortalQueryString()
Access the portal query string |
java.lang.String |
getPortalRequestURI()
Access the portal context path |
java.lang.String |
getPortalServletPath()
Access the portal servlet path |
javax.servlet.RequestDispatcher |
getRequestDispatcher(PortalContext pContext)
Access a RequestDispatcher |
boolean |
isLoggingDebug()
Determine the current state of debug logging |
boolean |
isLoggingError()
Determine the current state of error logging |
boolean |
isLoggingInfo()
Determine the current state of info logging |
boolean |
isLoggingWarning()
Determine the current state of warning logging |
void |
logDebug(java.lang.String pMessage)
Logs an debug event with the specified message |
void |
logDebug(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an debug event with the specified message and Throwable |
void |
logDebug(java.lang.Throwable pThrowable)
Logs an debug event with the specified Throwable |
void |
logError(java.lang.String pMessage)
Logs an error event with the specified message |
void |
logError(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an error event with the specified message and Throwable |
void |
logError(java.lang.Throwable pThrowable)
Logs an error event with the specified Throwable |
void |
logInfo(java.lang.String pMessage)
Logs an info event with the specified message |
void |
logInfo(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an info event with the specified message and Throwable |
void |
logInfo(java.lang.Throwable pThrowable)
Logs an info event with the specified Throwable |
void |
logWarning(java.lang.String pMessage)
Logs an warning event with the specified message |
void |
logWarning(java.lang.String pMessage,
java.lang.Throwable pThrowable)
Logs an warning event with the specified message and Throwable |
void |
logWarning(java.lang.Throwable pThrowable)
Logs an warning event with the specified Throwable |
java.lang.Object |
lookup(java.lang.String pName)
Deprecated. |
java.lang.Object |
lookup(java.lang.String namespace,
java.lang.String name)
Retrieves the named object from the requests context |
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 atg.portal.servlet.PortalContext |
---|
getCommunity, getDisplayMode, getPage, getPortal |
Field Detail |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
Device getDevice()
Device
java.lang.String getPortalContextPath()
java.lang.String getPortalServletPath()
java.lang.String getPortalPathInfo()
java.lang.String getPortalRequestURI()
java.lang.String getPortalQueryString()
javax.servlet.RequestDispatcher getRequestDispatcher(PortalContext pContext)
pPortalContext
- a portal context
java.lang.Object lookup(java.lang.String pName) throws javax.naming.NamingException
pName
- the name of the object
javax.naming.NamingException
- if an error occursjava.lang.Object lookup(java.lang.String namespace, java.lang.String name) throws javax.naming.NamingException
namespace
- where to try to find the objectname
- the name of the object
javax.naming.NamingException
- if an error occursboolean isLoggingInfo()
boolean isLoggingWarning()
boolean isLoggingError()
boolean isLoggingDebug()
void logInfo(java.lang.String pMessage)
pMessage
- the message to logvoid logInfo(java.lang.Throwable pThrowable)
void logInfo(java.lang.String pMessage, java.lang.Throwable pThrowable)
pMessage
- the message to logvoid logWarning(java.lang.String pMessage)
pMessage
- the message to logvoid logWarning(java.lang.Throwable pThrowable)
pThrowable
- an exception to logvoid logWarning(java.lang.String pMessage, java.lang.Throwable pThrowable)
pMessage
- the message to logpThrowable
- an exception to logvoid logError(java.lang.String pMessage)
pMessage
- the message to logvoid logError(java.lang.Throwable pThrowable)
pThrowable
- an exception to logvoid logError(java.lang.String pMessage, java.lang.Throwable pThrowable)
pMessage
- the message to logpThrowable
- an exception to logvoid logDebug(java.lang.String pMessage)
pMessage
- the message to logvoid logDebug(java.lang.Throwable pThrowable)
pThrowable
- an exception to logvoid logDebug(java.lang.String pMessage, java.lang.Throwable pThrowable)
pMessage
- the message to logpThrowable
- an exception to log
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |