atg.projects.store.droplet
Class ActionURLDroplet

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.projects.store.droplet.ActionURLDroplet

All Implemented Interfaces:

atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, atg.servlet.ParameterServlet, java.util.EventListener, javax.servlet.Servlet

public class ActionURLDroplet
extends atg.servlet.DynamoServlet

This droplet builds a complete URL string for the Endeca-produced action object. The action can be represented either by NavigationAction, RecordAction or UrlAction. For the NavigationAction type of Action the URL is built of request's context path, action's contentPath and navigationState. For the RecordAction type of Action the URL is built of request's context path, action's contentPath and recordState. For the UrlAction type of Action the URL is built of request's context path (only in the case of relative URL) and action's URL.

Input parameters:

• action - An action object to produce URL for.

Output parameters:

• actionURL - An URL for the passed in action Object.

Open parameters rendered by the droplet:

• output - The output oparam is rendered when the not empty URL is represented by the Action object.
*
• empty - The empty oparam is rendered in the case of empty URL.

Here is the example of droplet's usage: <dsp:droplet name="ActionURLDroplet"> <dsp:param name="action" value="${contentItem.link}"/> <dsp:oparam name="output"> <dsp:getvalueof var="actionURL" param="actionURL"/> <c:set var="url" value="${originatingRequest.contextPath}${actionURL}"/> </dsp:oparam> <dsp:oparam name="empty"> <c:set var="url" value="#"/> </dsp:oparam> </dsp:droplet>

Version:

$Id: //hosting-blueprint/B2CBlueprint/version/10.2.1/Endeca/Assembler/src/atg/projects/store/droplet/ActionURLDroplet.java#1 $$Change: 796860 $

Author:

Natallia Paulouskaya

Field Summary

static atg.nucleus.naming.ParameterName	ACTION Action object input parameter name
static java.lang.String	ACTION_URL The URL for the action output parameter name
static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	EMPTY Empty parameter name.
static java.lang.String	OUTPUT Output parameter name.
static java.lang.String	URL_SEPARATOR URL separator

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

ActionURLDroplet()

Method Summary

void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Builds the complete URL string for the Endeca-produced action object.

Methods inherited from class atg.servlet.DynamoServlet

doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter

Methods inherited from class atg.nucleus.servlet.ServletService

destroy, getServletConfig, getServletInfo, setServletInfo

Methods inherited from class atg.nucleus.TimedOperationService

getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

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

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

ACTION

public static final atg.nucleus.naming.ParameterName ACTION

Action object input parameter name

ACTION_URL

public static final java.lang.String ACTION_URL

The URL for the action output parameter name

See Also:

Constant Field Values

OUTPUT

public static final java.lang.String OUTPUT

Output parameter name.

See Also:

Constant Field Values

EMPTY

public static final java.lang.String EMPTY

Empty parameter name.

See Also:

Constant Field Values

URL_SEPARATOR

public static final java.lang.String URL_SEPARATOR

URL separator

See Also:

Constant Field Values

Constructor Detail

ActionURLDroplet

public ActionURLDroplet()

Method Detail

service

public void service(atg.servlet.DynamoHttpServletRequest pRequest,
                    atg.servlet.DynamoHttpServletResponse pResponse)
             throws javax.servlet.ServletException,
                    java.io.IOException

Builds the complete URL string for the Endeca-produced action object. The action can be represented either by NavigationAction, RecordAction or UrlAction.

Overrides:

service in class atg.servlet.DynamoServlet

Throws:

javax.servlet.ServletException

java.io.IOException