atg.portal.servlet
Interface PortalServletRequest

All Superinterfaces:
Attribute, javax.servlet.http.HttpServletRequest, PortalContext, javax.servlet.ServletRequest
All Known Subinterfaces:
GearServletRequest

public interface PortalServletRequest
extends javax.servlet.http.HttpServletRequest, PortalContext, Attribute

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

CLASS_VERSION

static final java.lang.String CLASS_VERSION
Class version string

See Also:
Constant Field Values
Method Detail

getDevice

Device getDevice()
Access the requested client device

Returns:
a device
See Also:
Device

getPortalContextPath

java.lang.String getPortalContextPath()
Access the portal context path

Returns:
a context path

getPortalServletPath

java.lang.String getPortalServletPath()
Access the portal servlet path

Returns:
a servlet path

getPortalPathInfo

java.lang.String getPortalPathInfo()
Access the portal path info path

Returns:
a path info path

getPortalRequestURI

java.lang.String getPortalRequestURI()
Access the portal context path

Returns:
a context path

getPortalQueryString

java.lang.String getPortalQueryString()
Access the portal query string

Returns:
a query string

getRequestDispatcher

javax.servlet.RequestDispatcher getRequestDispatcher(PortalContext pContext)
Access a RequestDispatcher

Parameters:
pPortalContext - a portal context
Returns:
a request dispatcher

lookup

java.lang.Object lookup(java.lang.String pName)
                        throws javax.naming.NamingException
Deprecated. 

Retreives the named object from the requests context

Parameters:
pName - the name of the object
Returns:
the named object
Throws:
javax.naming.NamingException - if an error occurs

lookup

java.lang.Object lookup(java.lang.String namespace,
                        java.lang.String name)
                        throws javax.naming.NamingException
Retrieves the named object from the requests context

Parameters:
namespace - where to try to find the object
name - the name of the object
Returns:
the named object
Throws:
javax.naming.NamingException - if an error occurs

isLoggingInfo

boolean isLoggingInfo()
Determine the current state of info logging

Returns:
true if logging enabled, false otherwise

isLoggingWarning

boolean isLoggingWarning()
Determine the current state of warning logging

Returns:
true if logging enabled, false otherwise

isLoggingError

boolean isLoggingError()
Determine the current state of error logging

Returns:
true if logging enabled, false otherwise

isLoggingDebug

boolean isLoggingDebug()
Determine the current state of debug logging

Returns:
true if logging enabled, false otherwise

logInfo

void logInfo(java.lang.String pMessage)
Logs an info event with the specified message

Parameters:
pMessage - the message to log

logInfo

void logInfo(java.lang.Throwable pThrowable)
Logs an info event with the specified Throwable


logInfo

void logInfo(java.lang.String pMessage,
             java.lang.Throwable pThrowable)
Logs an info event with the specified message and Throwable

Parameters:
pMessage - the message to log

logWarning

void logWarning(java.lang.String pMessage)
Logs an warning event with the specified message

Parameters:
pMessage - the message to log

logWarning

void logWarning(java.lang.Throwable pThrowable)
Logs an warning event with the specified Throwable

Parameters:
pThrowable - an exception to log

logWarning

void logWarning(java.lang.String pMessage,
                java.lang.Throwable pThrowable)
Logs an warning event with the specified message and Throwable

Parameters:
pMessage - the message to log
pThrowable - an exception to log

logError

void logError(java.lang.String pMessage)
Logs an error event with the specified message

Parameters:
pMessage - the message to log

logError

void logError(java.lang.Throwable pThrowable)
Logs an error event with the specified Throwable

Parameters:
pThrowable - an exception to log

logError

void logError(java.lang.String pMessage,
              java.lang.Throwable pThrowable)
Logs an error event with the specified message and Throwable

Parameters:
pMessage - the message to log
pThrowable - an exception to log

logDebug

void logDebug(java.lang.String pMessage)
Logs an debug event with the specified message

Parameters:
pMessage - the message to log

logDebug

void logDebug(java.lang.Throwable pThrowable)
Logs an debug event with the specified Throwable

Parameters:
pThrowable - an exception to log

logDebug

void logDebug(java.lang.String pMessage,
              java.lang.Throwable pThrowable)
Logs an debug event with the specified message and Throwable

Parameters:
pMessage - the message to log
pThrowable - an exception to log