public class DropletDescriptor extends BaseDropletDescriptor
handlePropertyName(ServletRequest, ServletResponse)
Each descriptor is associated with a particular java class. If the referenced component's class changes, a new descriptor has to be created.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
DROPLET_ANCHOR_QUALIFIER, DROPLET_ANCHOR_VALUE, DROPLET_ARGUMENTS, DROPLET_BEAN_PREFIX, DROPLET_BEFORE_GET_ATTRIBUTE, DROPLET_EVENT_ATTRIBUTE, DROPLET_EVENT_PREFIX, DROPLET_EXCEPTIONS_ATTRIBUTE, DROPLET_PARAM_PREFIX, DROPLET_PROPERTY_PREFIX, DROPLET_SESSION_CONF, DROPLET_SUBMIT_VALUE_PREFIX, OBJECT_BEFORE_GET_ATTRIBUTE, PRIORITY_DEFAULT, SUBMIT_PRIORITY_DEFAULT, UNCHECKED_DROPLET_EXCEPTIONS_ATTRIBUTE
Constructor and Description |
---|
DropletDescriptor(java.lang.Class pClass,
java.lang.Class pHandleParamOne,
java.lang.Class pHandleParamTwo,
java.lang.String pPropertyName)
Constructor for DropletDescriptor
|
DropletDescriptor(java.lang.Class pClass,
java.lang.String pPropertyName)
Constructor for DropletDescriptor
|
Modifier and Type | Method and Description |
---|---|
void |
beforeHandle(java.lang.Object pObject,
java.lang.String pPath,
DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Method that should be invoked before the handleMethod would be called
(even if handleMethod is null).
|
static java.lang.Boolean |
convertBoolean(java.lang.String pValue)
These methods perform the valueOf function after trimming whitespace
|
static java.lang.Byte |
convertByte(java.lang.String pValue) |
static java.lang.Character |
convertCharacter(java.lang.String pValue)
This method fills in the role of the valueOf method for the Character
class.
|
static java.lang.Class |
convertClass(java.lang.String pValue) |
static java.lang.Double |
convertDouble(java.lang.String pValue) |
static java.lang.Float |
convertFloat(java.lang.String pValue) |
static java.lang.Integer |
convertInteger(java.lang.String pValue) |
static java.lang.Long |
convertLong(java.lang.String pValue) |
static java.lang.Byte |
convertNumberToByte(java.lang.Number pValue) |
static java.lang.Double |
convertNumberToDouble(java.lang.Number pValue) |
static java.lang.Float |
convertNumberToFloat(java.lang.Number pValue) |
static java.lang.Integer |
convertNumberToInteger(java.lang.Number pValue) |
static java.lang.Long |
convertNumberToLong(java.lang.Number pValue) |
static java.lang.Short |
convertNumberToShort(java.lang.Number pValue) |
static java.awt.Point |
convertPoint(java.lang.String pValue) |
static java.lang.Short |
convertShort(java.lang.String pValue) |
static UploadedFile |
convertUploadedFile(java.lang.String pValue) |
static java.lang.String |
evalDynamicDimensions(PropertyName pPropertyPath,
DynamoHttpServletRequest pRequest)
Goes through the dimensions string and replaces the param: and property:
values with their current values.
|
static java.lang.String |
evalDynamicDimensions(java.lang.String pPropertyPath,
DynamoHttpServletRequest pRequest)
Goes through the dimensions string and replaces the param: and property:
values with their current values.
|
java.lang.Class<?> |
getBeanClass()
Return the class of the bean we are representing.
|
static DropletDescriptor |
getDropletDescriptor(java.lang.Class<?> pClass,
java.lang.Class<?> pHandleParamOne,
java.lang.Class<?> pHandleParamTwo,
java.lang.String pPropertyName)
Returns the property descriptor for the specified class and property
name.
|
static DropletDescriptor |
getDropletDescriptor(java.lang.Class pClass,
java.lang.String pPropertyName)
Returns the property descriptor for the specified class and property
name.
|
java.lang.reflect.Method |
getGetMethod() |
static atg.droplet.DropletDescriptorManager |
getGlobalManager()
Get the static DropletDescriptorManager instance.
|
java.lang.reflect.Method |
getHandleMethod() |
static java.lang.String |
getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
PropertyName pPropertyName,
boolean pCallBeforeGet,
TagConverter pConverter,
java.util.Properties pConverterArgs)
Returns the string property value for the specified component and
the specified path.
|
static java.lang.String |
getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
java.lang.String pPropertyPath,
boolean pCallBeforeGet,
TagConverter pConverter,
java.util.Properties pConverterArgs)
Returns the string property value for the specified component and
the specified path.
|
static java.lang.String |
getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest,
java.lang.String pPropertyPath)
Returns the string property value for the specified component and
the specified path.
|
static java.lang.String |
getPropertyStringValue(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
PropertyName pPropertyName,
boolean pCallBeforeGet,
TagConverter pConverter,
java.util.Properties pConverterArgs)
Returns the string property value for the specified component and
the specified path.
|
static java.lang.String |
getPropertyStringValue(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
java.lang.String pPropertyPath,
boolean pCallBeforeGet,
TagConverter pConverter,
java.util.Properties pConverterArgs)
Returns the string property value for the specified component and
the specified path.
|
static java.lang.String |
getPropertyStringValue(DynamoHttpServletRequest pRequest,
PropertyName pPropertyPath)
Returns the string property value for the specified component and
the specified path.
|
static java.lang.String |
getPropertyStringValue(DynamoHttpServletRequest pRequest,
java.lang.String pPropertyPath)
Returns the string property value for the specified component and
the specified path.
|
static java.lang.Object |
getPropertyValue(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
PropertyName pPropertyPath,
boolean pCallBeforeGet,
TagConverter pConverter,
java.util.Properties pConverterArgs)
Returns the object property value for the specified component and
the specified path.
|
static java.lang.Object |
getPropertyValue(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
java.lang.String pPropertyPath,
boolean pCallBeforeGet,
TagConverter pConverter,
java.util.Properties pConverterArgs)
Returns the object property value for the specified component and
the specified path.
|
static java.lang.Object |
getPropertyValue(DynamoHttpServletRequest pRequest,
PropertyName pPropertyPath)
Returns the object property value for the specified component and
the specified path.
|
static java.lang.Object |
getPropertyValue(DynamoHttpServletRequest pRequest,
java.lang.String pPropertyPath)
Returns the object property value for the specified component and
the specified path.
|
java.lang.reflect.Method |
getSetMethod() |
static boolean |
hasPropertyValue(DynamoHttpServletRequest pRequest,
PropertyName pPropertyName)
Returns true if the specified property path name has a value
for the specified request.
|
static boolean |
hasPropertyValue(DynamoHttpServletRequest pRequest,
java.lang.String pPropertyName)
Returns true if the specified property path name has a value
for the specified request.
|
static boolean |
matchesPropertyValue(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
PropertyName pPropertyName,
java.lang.String pValue,
boolean pCallBeforeGet,
TagConverter pConverter,
java.util.Properties pConverterArgs)
Returns true if the specified value matches the value of the property
specified in pPropertyName.
|
static boolean |
matchesPropertyValue(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse,
java.lang.String pPropertyPath,
java.lang.String pValue,
boolean pCallBeforeGet,
TagConverter pConverter,
java.util.Properties pConverterArgs)
Returns true if the specified value matches the value of the property
specified in pPropertyPath.
|
static boolean |
matchesPropertyValue(DynamoHttpServletRequest pRequest,
java.lang.String pPropertyPath,
java.lang.String pValue)
Returns true if the specified value matches the value of the property
specified in pPropertyPath.
|
protected void |
setCvtType(java.lang.Class pPropertyType,
java.lang.String pName)
Sets the cvtMethod member variable that we use to convert
a string value to an object of the right parameter type
|
static atg.droplet.DropletDescriptorManager |
setGlobalManager(atg.droplet.DropletDescriptorManager pManager)
Set the static DropletDescriptorManager instance.
|
static boolean |
setPropertyValue(DynamoHttpServletRequest pReq,
DynamoHttpServletResponse pRes,
java.lang.String pPropertyPath,
java.lang.Object pValue)
This method sets the property value specified by the pPropertyPath
parameter to the value specified by the pValue parameter.
|
static boolean |
setPropertyValue(DynamoHttpServletRequest pReq,
DynamoHttpServletResponse pRes,
java.lang.String pPropertyPath,
java.lang.Object pValue,
TagConverter pConverter,
java.util.Properties pConverterArgs)
This method sets the property value specified by the pPropertyPath
parameter to the value specified by the pValue parameter.
|
public DropletDescriptor(java.lang.Class pClass, java.lang.String pPropertyName) throws DropletException
pClass
- The Class for which to return a DropletDescriptorpPropertyName
- The property name to return for the given classDropletException
public DropletDescriptor(java.lang.Class pClass, java.lang.Class pHandleParamOne, java.lang.Class pHandleParamTwo, java.lang.String pPropertyName) throws DropletException
pClass
- The Class for which to return a DropletDescriptorpHandleParamOne
- The type of the first parameter for the handleXXX methodpHandleParamTwo
- The type of the second parameter for the handleXXX methodpPropertyName
- The property name to return for the given classDropletException
public java.lang.Class<?> getBeanClass()
public static atg.droplet.DropletDescriptorManager setGlobalManager(atg.droplet.DropletDescriptorManager pManager)
pManager
- the new DropletDescriptorManager to use.public static atg.droplet.DropletDescriptorManager getGlobalManager()
public static java.lang.String getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyPath) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}/{component path}.{property}.{property}
javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.String getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String pPropertyPath, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}/{component path}.{property}.{property}
pCallBeforeGet
- true if the beforeGet method of DropletFormHandler
components should be called if this is the first time that a property
of this component has been accessed for this request.javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.String getPropertyHtmlStringValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, PropertyName pPropertyName, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException
pPropertyName
- the path name to the property in the form:
{component path}/{component path}.{property}.{property}
pCallBeforeGet
- true if the beforeGet method of DropletFormHandler
components should be called if this is the first time that a property
of this component has been accessed for this request.javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.String getPropertyStringValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyPath) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}/{component path}.{property}.{property}
javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.String getPropertyStringValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String pPropertyPath, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}/{component path}.{property}.{property}
pCallBeforeGet
- true if the beforeGet method of DropletFormHandler
components should be called if this is the first time that a property
of this component has been accessed for this request.javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.String getPropertyStringValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, PropertyName pPropertyName, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException
pPropertyName
- the PropertyName for the property in the form.pCallBeforeGet
- true if the beforeGet method of DropletFormHandler
components should be called if this is the first time that a property
of this component has been accessed for this request.javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static boolean matchesPropertyValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyPath, java.lang.String pValue) throws javax.servlet.ServletException
javax.servlet.ServletException
public static boolean matchesPropertyValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String pPropertyPath, java.lang.String pValue, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException
This version of this method can be used to call the beforeGet method of the component if this is the first time that the components value has been accessed in this request.
pCallBeforeGet
- true if the beforeGet method of DropletFormHandler
components should be called if this is the first time that a property
of this component has been accessed for this request.javax.servlet.ServletException
public static boolean matchesPropertyValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, PropertyName pPropertyName, java.lang.String pValue, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException
This version of this method can be used to call the beforeGet method of the component if this is the first time that the components value has been accessed in this request.
pPropertyName
- the property name to match against.pCallBeforeGet
- true if the beforeGet method of DropletFormHandler
components should be called if this is the first time that a property
of this component has been accessed for this request.javax.servlet.ServletException
public static java.lang.Object getPropertyValue(DynamoHttpServletRequest pRequest, PropertyName pPropertyPath) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}.{property}.{property}
javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.Object getPropertyValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, PropertyName pPropertyPath, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}.{property}.{property}
pCallBeforeGet
- true if the beforeGet method of DropletFormHandler
components should be called if this is the first time that a property
of this component has been accessed for this request.javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.Object getPropertyValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyPath) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}.{property}.{property}
javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.String getPropertyStringValue(DynamoHttpServletRequest pRequest, PropertyName pPropertyPath) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}/{component path}.{property}.{property}
javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static java.lang.Object getPropertyValue(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse, java.lang.String pPropertyPath, boolean pCallBeforeGet, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException
pPropertyPath
- the path name to the property in the form:
{component path}.{property}.{property}
pCallBeforeGet
- true if the beforeGet method of DropletFormHandler
components should be called if this is the first time that a property
of this component has been accessed for this request.javax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the property
values.public static boolean setPropertyValue(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes, java.lang.String pPropertyPath, java.lang.Object pValue) throws javax.servlet.ServletException, java.io.IOException
pReq
- the request (which is passed to handleXXX methods)pRes
- the response (which is passed to handleXXX methods)pPropertyPath
- the path name to the property in the form:
{component path}.{property}.{property}
pValue
- the value of the propertyjavax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the intermediate property
values, or trying to set the final property value. A ServletException
can also be thrown by one of the handleXXX methods, in which case
that exception is propagated up through this call.java.io.IOException
- thrown if the handleXXX methods throws an
IOExceptionpublic static boolean setPropertyValue(DynamoHttpServletRequest pReq, DynamoHttpServletResponse pRes, java.lang.String pPropertyPath, java.lang.Object pValue, TagConverter pConverter, java.util.Properties pConverterArgs) throws javax.servlet.ServletException, java.io.IOException
pReq
- the request (which is passed to handleXXX methods)pRes
- the response (which is passed to handleXXX methods)pPropertyPath
- the path name to the property in the form:
{component path}.{property}.{property}
pValue
- the value of the propertyjavax.servlet.ServletException
- thrown if an error occurs trying to
find the component, or trying to get one of the intermediate property
values, or trying to set the final property value. A ServletException
can also be thrown by one of the handleXXX methods, in which case
that exception is propagated up through this call.java.io.IOException
- thrown if the handleXXX methods throws an
IOExceptionpublic static java.lang.String evalDynamicDimensions(PropertyName pPropertyPath, DynamoHttpServletRequest pRequest) throws javax.servlet.ServletException
javax.servlet.ServletException
public static java.lang.String evalDynamicDimensions(java.lang.String pPropertyPath, DynamoHttpServletRequest pRequest) throws javax.servlet.ServletException
javax.servlet.ServletException
public static DropletDescriptor getDropletDescriptor(java.lang.Class<?> pClass, java.lang.Class<?> pHandleParamOne, java.lang.Class<?> pHandleParamTwo, java.lang.String pPropertyName) throws DropletException
pClass
- pHandleParamOne
- pHandleParamTwo
- pPropertyName
- DropletException
public static DropletDescriptor getDropletDescriptor(java.lang.Class pClass, java.lang.String pPropertyName) throws DropletException
DropletException
public static boolean hasPropertyValue(DynamoHttpServletRequest pRequest, java.lang.String pPropertyName)
public static boolean hasPropertyValue(DynamoHttpServletRequest pRequest, PropertyName pPropertyName)
public void beforeHandle(java.lang.Object pObject, java.lang.String pPath, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse)
pObject
- the component whose property has just been set.pPath
- the full component path to the object.pRequest
- the current dynamo requestpResponse
- the current dynamo responseprotected void setCvtType(java.lang.Class pPropertyType, java.lang.String pName) throws DropletException
This must be a static member of the class that takes a single String parameter and returns an object of the appropriate type.
DropletException
public java.lang.reflect.Method getGetMethod()
public java.lang.reflect.Method getSetMethod()
public java.lang.reflect.Method getHandleMethod()
public static java.lang.Character convertCharacter(java.lang.String pValue)
public static java.awt.Point convertPoint(java.lang.String pValue)
public static java.lang.Boolean convertBoolean(java.lang.String pValue)
public static java.lang.Byte convertByte(java.lang.String pValue)
public static java.lang.Double convertDouble(java.lang.String pValue)
public static java.lang.Float convertFloat(java.lang.String pValue)
public static java.lang.Integer convertInteger(java.lang.String pValue)
public static java.lang.Long convertLong(java.lang.String pValue)
public static java.lang.Short convertShort(java.lang.String pValue)
public static java.lang.Double convertNumberToDouble(java.lang.Number pValue)
public static java.lang.Float convertNumberToFloat(java.lang.Number pValue)
public static java.lang.Integer convertNumberToInteger(java.lang.Number pValue)
public static java.lang.Long convertNumberToLong(java.lang.Number pValue)
public static java.lang.Short convertNumberToShort(java.lang.Number pValue)
public static java.lang.Byte convertNumberToByte(java.lang.Number pValue)
public static java.lang.Class convertClass(java.lang.String pValue)
public static UploadedFile convertUploadedFile(java.lang.String pValue)