atg.projects.store.adc.pipeline
Class ImportJavaScriptProcessor

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.adc.pipeline.ADCPipelineProcessor
              extended by atg.projects.store.adc.pipeline.ImportJavaScriptProcessor
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.service.pipeline.PipelineProcessor, java.util.EventListener

public class ImportJavaScriptProcessor
extends atg.adc.pipeline.ADCPipelineProcessor

This processor is responsible for creating JavaScript library include.

Version:
$Id: //hosting-blueprint/B2CBlueprint/main/integrations/test/src/atg/projects/b2cblueprint/dusttests/BlueprintMismatchException.java#2 $$Change: 791366 $
Author:
ATG

Field Summary
static java.lang.String ABSOLUTE_URL_PREFIX
           
static java.lang.String CLASS_VERSION
          Class version string
static java.lang.String JAVASCRIPT_IMPORT
           
static java.lang.String PERFORM_MONITOR_NAME
           
static java.lang.String PERFORM_OPERATION_NAME
           
static java.lang.String URL_SEPARATOR
           
 
Fields inherited from class atg.adc.pipeline.ADCPipelineProcessor
MADE_CHANGE, NO_CHANGE
 
Fields inherited from class atg.nucleus.GenericService
SERVICE_INFO_KEY
 
Fields inherited from interface atg.service.pipeline.PipelineProcessor
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK
 
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
ImportJavaScriptProcessor()
           
 
Method Summary
 java.lang.String getScriptUrl()
          Returns the JavaScript library URL that will be used to build JavaSript import statement.
 boolean isIncludeContextPath()
          Returns includeContextPath boolean property indicating whether current context path should be added to the script URL.
 void setIncludeContextPath(boolean pIncludeContextPath)
          Sets includeContextPath boolean property indicating whether current context path should be added to the script URL.
 void setScriptUrl(java.lang.String pScriptUrl)
          Sets the JavaScript library URL that will be used to build JavaSript import statement.
 int updateADCData(atg.adc.pipeline.ADCPipelineArgs pArgs)
          This processor will append to the response stream the configured JavaScript library import.
 
Methods inherited from class atg.adc.pipeline.ADCPipelineProcessor
getRetCodes, isEnabled, runProcess, setEnabled
 
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

PERFORM_MONITOR_NAME

public static final java.lang.String PERFORM_MONITOR_NAME
See Also:
Constant Field Values

PERFORM_OPERATION_NAME

public static final java.lang.String PERFORM_OPERATION_NAME
See Also:
Constant Field Values

JAVASCRIPT_IMPORT

public static final java.lang.String JAVASCRIPT_IMPORT
See Also:
Constant Field Values

ABSOLUTE_URL_PREFIX

public static final java.lang.String ABSOLUTE_URL_PREFIX
See Also:
Constant Field Values

URL_SEPARATOR

public static final java.lang.String URL_SEPARATOR
See Also:
Constant Field Values
Constructor Detail

ImportJavaScriptProcessor

public ImportJavaScriptProcessor()
Method Detail

getScriptUrl

public java.lang.String getScriptUrl()
Returns the JavaScript library URL that will be used to build JavaSript import statement.

Returns:
the JavaScript library URL

setScriptUrl

public void setScriptUrl(java.lang.String pScriptUrl)
Sets the JavaScript library URL that will be used to build JavaSript import statement.

Parameters:
pScriptUrl - - the JavaScript library URL

setIncludeContextPath

public void setIncludeContextPath(boolean pIncludeContextPath)
Sets includeContextPath boolean property indicating whether current context path should be added to the script URL.

Parameters:
pIncludeContextPath - The boolean property indicating whether current context path should be added to the script URL.

isIncludeContextPath

public boolean isIncludeContextPath()
Returns includeContextPath boolean property indicating whether current context path should be added to the script URL.

Returns:
The boolean property indicating whether current context path should be added to the script URL.

updateADCData

public int updateADCData(atg.adc.pipeline.ADCPipelineArgs pArgs)
This processor will append to the response stream the configured JavaScript library import.

Specified by:
updateADCData in class atg.adc.pipeline.ADCPipelineProcessor
Parameters:
pArgs - the current ADC pipeline arguments
Returns:
an ADC processor status code