atg.portal.servlet
Interface GearServletRequest

All Superinterfaces:

Attribute, GearContext, javax.servlet.http.HttpServletRequest, PortalContext, PortalServletRequest, javax.servlet.ServletRequest

public interface GearServletRequest
extends PortalServletRequest, GearContext

The gear request object encapsulates all information from a portal for a gear to render.

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

java.lang.String	getGearParameter(java.lang.String pName) Get the value of a named parameter
java.lang.String[]	getGearParameterNames() Access the names of the gear definition parameters
javax.servlet.http.HttpSession	getGearSession() Returns the current GearSession associated with this request or if there is no current session returns a new session.
javax.servlet.http.HttpSession	getGearSession(boolean pCreate) Returns the current GearSession associated with this request or if there is no current session and create is true returns a new session
java.lang.String	getGearSessionId() Obtain the gear session id

Methods inherited from interface atg.portal.servlet.PortalServletRequest

getDevice, getPortalContextPath, getPortalPathInfo, getPortalQueryString, getPortalRequestURI, getPortalServletPath, getRequestDispatcher, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingWarning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logWarning, logWarning, logWarning, lookup, lookup

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

Methods inherited from interface atg.portal.servlet.GearContext

getGear, getGearMode

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

getGearParameterNames

java.lang.String[] getGearParameterNames()

Access the names of the gear definition parameters

Returns:

array of gear parameter names

getGearParameter

java.lang.String getGearParameter(java.lang.String pName)

Get the value of a named parameter

Parameters:

pName - the parameter name

Returns:

the value of the parameter or null

getGearSessionId

java.lang.String getGearSessionId()

Obtain the gear session id

Returns:

a session id

getGearSession

javax.servlet.http.HttpSession getGearSession(boolean pCreate)

Returns the current GearSession associated with this request or if there is no current session and create is true returns a new session

Returns:

a gear session

getGearSession

javax.servlet.http.HttpSession getGearSession()

Returns the current GearSession associated with this request or if there is no current session returns a new session.

Returns:

a gear session