atg.projects.store.droplet

Class NullPropertiesCheck

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.NullPropertiesCheck

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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 NullPropertiesCheck
extends atg.servlet.DynamoServlet

This droplet is a convenience to help prevent JSP compilation failure due to the passing of nulls into a dsp tag. This droplet takes a pipe-delimited list of property names and a repository item. In the case of strings, strings are considered null if they are equivalent to the empty string or are null.

This droplet takes the following input parameters:

• item - repository item whose properties need checking
• properties - pipe delimited list of property names to check

This droplet renders the following oparams:

• all - rendered if all of the properties are null
• true - rendered if some of the properties are null
• false - rendered if none of the properties are null

This droplet sets the following parameters on output oparam of true

• nullProperties - list of properties that were null
• definedProperties - list of properties that were not null

Example:

 <dsp:droplet bean="/atg/store/droplet/NullPropertiesCheck">
 <dsp:param name="item" param="category">
 <dsp:param name="properties" value="template.url|auxiliaryMedia.navon.url">
 <dsp:oparam name="true">
 These properties were null
 <dsp:valueof param="nullProperties">
 </dsp:valueof>
 </dsp:oparam>
 <dsp:oparam name="false">
 </dsp:oparam>
 </dsp:droplet>

 

Version:

$Revision: #1 $

Author:

ATG

Field Summary

Fields

Modifier and Type	Field and Description
static atg.nucleus.naming.ParameterName	ALL All parameter name.
static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	DEFINED_PROPERTIES Defined properties parameter name.
static atg.nucleus.naming.ParameterName	FALSE False parameter name.
static atg.nucleus.naming.ParameterName	ITEM Item parameter name.
static java.lang.String	NULL_PROPERTIES Null properties parameter name.
static atg.nucleus.naming.ParameterName	PROPERTIES Properties parameter name.
static atg.nucleus.naming.ParameterName	TRUE True parameter name.

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

Constructors

Constructor and Description
NullPropertiesCheck()

Method Summary

Modifier and Type	Method and Description
protected boolean	isValueEmpty(java.lang.Object pValue) Returns true if the value represented by the object is empty.
void	service(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Performs the tasks outlined in the class description.

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, toString

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, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

ITEM

public static final atg.nucleus.naming.ParameterName ITEM

Item parameter name.

PROPERTIES

public static final atg.nucleus.naming.ParameterName PROPERTIES

Properties parameter name.

ALL

public static final atg.nucleus.naming.ParameterName ALL

All parameter name.

TRUE

public static final atg.nucleus.naming.ParameterName TRUE

True parameter name.

FALSE

public static final atg.nucleus.naming.ParameterName FALSE

False parameter name.

NULL_PROPERTIES

public static final java.lang.String NULL_PROPERTIES

Null properties parameter name.

See Also:

Constant Field Values

DEFINED_PROPERTIES

public static final java.lang.String DEFINED_PROPERTIES

Defined properties parameter name.

See Also:

Constant Field Values

Constructor Detail

NullPropertiesCheck

public NullPropertiesCheck()

Method Detail

service

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

Performs the tasks outlined in the class description.

Overrides:

service in class atg.servlet.DynamoServlet

Parameters:

pRequest - DynamoHttpServletRequest

pResponse - DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

isValueEmpty

protected boolean isValueEmpty(java.lang.Object pValue)

Returns true if the value represented by the object is empty.

For strings they are empty if they equal the empty string '' or are null.

Collections are empty if they say they are empty

null is always empty

Parameters:

pValue - - value to check

Returns:

true if the value represented by the object is empty, false - otherwise