|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.nucleus.TimedOperationService atg.nucleus.servlet.ServletService atg.nucleus.servlet.HttpServletService atg.servlet.DynamoServlet atg.droplet.multisite.SiteLinkDroplet
public class SiteLinkDroplet
Droplet that gets the URL for a particular site. The site is set with the
siteId
parameter. If the siteId
isn't provided, the
current site will be used. An optional path
parameter will be
included in the returned URL. An optional queryParams
parameter
will be included in the returned URL. An optional protocol
inInclude is ture, relative URLs will be relative to the
included page's path, not the current request path. The output parameters for
this Droplet are:
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
static ParameterName |
ERROR
ParameterName for error |
static java.lang.String |
ERROR_MSG_PROP_NAME
Parameter name for errorMessage |
static ParameterName |
IN_INCLUDE
ParameterName for inInclude |
static ParameterName |
OUTPUT
ParameterName for output |
static ParameterName |
PATH
ParameterName for path |
static ParameterName |
PROTOCOL
ParameterName for protocol |
static ParameterName |
QUERY_PARAMS
ParameterName for queryParams |
static ParameterName |
SITE_ID
Class version string |
static java.lang.String |
URL_PROP_NAME
Parameter name for url |
Fields inherited from class atg.servlet.DynamoServlet |
---|
mAllowCleanupRequest, mParameters |
Fields inherited from class atg.nucleus.servlet.ServletService |
---|
SERVLET_INFO_KEY |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
SiteLinkDroplet()
|
Method Summary | |
---|---|
java.lang.String |
getProtocol()
Gets the default protocol. |
SiteURLManager |
getSiteURLManager()
Gets the SiteURLManager. |
boolean |
isInInclude()
Gets if the link is in an included page. |
void |
service(DynamoHttpServletRequest pReq,
DynamoHttpServletResponse pRes)
This method provides the default implementation of service, by dispatching to conventionally named methods which begin with "do". |
void |
setInInclude(boolean pInInclude)
Sets if the link is in an included page. |
void |
setProtocol(java.lang.String pProtocol)
Sets the default protocol |
void |
setSiteURLManager(SiteURLManager pSiteURLManager)
Sets the SiteURLManager |
Methods inherited from class atg.servlet.DynamoServlet |
---|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter |
Methods inherited from class atg.nucleus.servlet.ServletService |
---|
destroy, getServletConfig, getServletInfo, init, setServletInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final ParameterName SITE_ID
public static final ParameterName PROTOCOL
public static final ParameterName OUTPUT
public static final ParameterName PATH
public static final ParameterName QUERY_PARAMS
public static final ParameterName ERROR
public static final java.lang.String ERROR_MSG_PROP_NAME
public static final java.lang.String URL_PROP_NAME
public static final ParameterName IN_INCLUDE
Constructor Detail |
---|
public SiteLinkDroplet()
Method Detail |
---|
public SiteURLManager getSiteURLManager()
public void setSiteURLManager(SiteURLManager pSiteURLManager)
pSiteURLManager
- the siteURLManager to setpublic java.lang.String getProtocol()
public void setProtocol(java.lang.String pProtocol)
pProtocol
- the protocol to setpublic boolean isInInclude()
public void setInInclude(boolean pInInclude)
pInInclude
- the inInclude to setpublic void service(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes) throws javax.servlet.ServletException, java.io.IOException
DynamoServlet
service
in class DynamoServlet
pReq
- The requestpRes
- The response
javax.servlet.ServletException
- The ServletException
java.io.IOException
- The IOExceptionDynamoServlet.service(atg.servlet.DynamoHttpServletRequest,
atg.servlet.DynamoHttpServletResponse)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |