com.dpslink.flash.servlet

Class FlashServletRequest

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.servlet.FlashServletRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FlashServletRequest>

public class FlashServletRequest
extends MappedAttributesObject
implements java.lang.Comparable<FlashServletRequest>

Defines a servlet request and its associated parameters.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
FlashServletRequest() Constructs a new servlet request object.
FlashServletRequest(FlashServletContext ctx) Constructs a new servlet request object.
FlashServletRequest(FlashServletContext ctx, java.lang.String name) Constructs a new servlet request object.
FlashServletRequest(FlashServletRequest fsr) Constructs a new servlet request object.

Method Summary

Modifier and Type	Method and Description
boolean	after(FlashServletRequest obj) Answers if this object is greater than the given object based on this object's compareTo method results.
boolean	before(FlashServletRequest obj) Answers if this object is less than the given object based on this object's compareTo method results.
int	compareTo(FlashServletRequest obj) Compares the given object to this object and determines if the given object is less than, equal to or greater than this object.
void	delParam(java.lang.String param) Deletes the parameter having the given name.
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
java.lang.String	getId() Returns the request's id.
java.lang.String	getInvokerId() Returns the request's invoker id (the id for the servlet that requested this servlet).
boolean	getIsExpired() Returns the request's is expired flag.
java.lang.String	getParam(java.lang.String param) Returns a parameter's value as an string.
java.util.ArrayList<?>	getParamArrayList(java.lang.String param) Returns a parameter's value as an array list.
java.math.BigDecimal	getParamBigDecimal(java.lang.String param) Returns a parameter's value as a big decimal.
boolean	getParamBoolean(java.lang.String param) Returns a parameter's value as a boolean.
java.util.Date	getParamDate(java.lang.String param) Returns a parameter's value as a date.
double	getParamDouble(java.lang.String param) Returns a parameter's value as a double.
int	getParamInteger(java.lang.String param) Returns a parameter's value as an int.
long	getParamLong(java.lang.String param) Returns a parameter's value as a long.
MappedAttributesObject	getParamMapped(java.lang.String param) Returns a parameter's value as a mapped attributes object.
java.lang.Object	getParamObject(java.lang.String param) Returns a parameter's value as an object.
java.util.HashMap<java.lang.String,java.lang.Object>	getParams() Returns a map of all parameter names and their associated values.
short	getParamShort(java.lang.String param) Returns a parameter's value as a short.
java.lang.String	getParamString(java.lang.String param) Returns a parameter's value as a string.
java.lang.String	getParamString(java.lang.String param, boolean trim) Returns a parameter's value as a string.
java.util.Vector<?>	getParamVector(java.lang.String param) Returns a parameter's value as a vector.
java.lang.String	getServletName() Returns the request's servlet name.
java.lang.String	getServletURL() Returns the request's servlet URL.
java.lang.String	getTriggerId() Returns the request's trigger id (the id for the servlet that initially triggered a function).
java.lang.String	getUserId() Returns the request's user id.
boolean	hasParam(java.lang.String param) Answers if a parameter with the given name exists.
boolean	matches(FlashServletRequest obj) Answers if this object is an exact match to the given object.
void	setId(java.lang.String value) Sets the request's id.
void	setInvokerId(java.lang.String value) Sets the request's invoker id (the id for the servlet that requested this servlet).
void	setIsExpired(boolean value) Sets the request's is expired flag.
void	setParam(java.lang.String param, java.util.ArrayList<?> value) Sets a parameter's value to an array list.
void	setParam(java.lang.String param, java.math.BigDecimal value) Sets a parameter's value to a big decimal.
void	setParam(java.lang.String param, boolean value) Sets a parameter's value to a boolean.
void	setParam(java.lang.String param, java.util.Date value) Sets a parameter's value to a date.
void	setParam(java.lang.String param, double value) Sets a parameter's value to a double.
void	setParam(java.lang.String param, int value) Sets a parameter's value to an int.
void	setParam(java.lang.String param, long value) Sets a parameter's value to a long.
void	setParam(java.lang.String param, MappedAttributesObject value) Sets a parameter's value to a mapped attributes object.
void	setParam(java.lang.String param, java.lang.Object value) Sets a parameter's value to an object.
void	setParam(java.lang.String param, short value) Sets a parameter's value to a short.
void	setParam(java.lang.String param, java.lang.String value) Sets a parameter's value to a string.
void	setParam(java.lang.String param, java.lang.String value, boolean trim) Sets a parameter's value to a string.
void	setParam(java.lang.String param, java.util.Vector<?> value) Sets a parameter's value to a vector.
void	setServletName(java.lang.String value) Sets the request's servlet name.
void	setTriggerId(java.lang.String value) Sets the request's trigger id (the id for the servlet that initially triggered a function).
void	setUserId(java.lang.String value) Sets the request's user id.
java.lang.String	toString() Returns a string representation of this request.

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

FlashServletRequest

public FlashServletRequest()

Constructs a new servlet request object. Sets the id to the current date and time in milliseconds. All other request values are set to an empty string.

FlashServletRequest

public FlashServletRequest(FlashServletContext ctx)

Constructs a new servlet request object. Sets the id to the current date and time in milliseconds and sets certain request values (such as user id) to values found in the given context. All all other request values are set to an empty string..

Parameters:

ctx - (FlashServletContext) The current servlet context. Pass a null if context values do not pertain to this instance.

FlashServletRequest

public FlashServletRequest(FlashServletContext ctx,
                           java.lang.String name)

Constructs a new servlet request object. Sets the id to the current date and time in milliseconds, sets certain request values (such as user id) to values found in the given context and sets the servlet name to the given name. All other request values are set to an empty string.

Parameters:

ctx - (FlashServletContext) The current servlet context. Pass a null if context values do not pertain to this instance.

name - (String) The servlet name.

FlashServletRequest

public FlashServletRequest(FlashServletRequest fsr)

Constructs a new servlet request object. Sets the id to the current date and time in milliseconds and sets all other request and parameter values to the same as the given servlet request. In other words, except for the id, this instance is a copy of the given request.

Parameters:

fsr - (FlashServletRequest) The servlet request on which to base this servlet request.

Method Detail

compareTo

public int compareTo(FlashServletRequest obj)

Compares the given object to this object and determines if the given object is less than, equal to or greater than this object. Comparison is based on hash code fields that were defined in the object's constructor.

NOTE: This compareTo performs the opposite comparison to what is typically performed by other Comparable objects. The result here is based on how the given object compares to this object vs. how this object compares to the given object. This reversal in the comparison is being done intentionally so the TreeSet maintained by the Stack inner class in FlashServlet will be in reverse order of actual occurence (i.e. newer requests in the stack will appear in the TreeSet before older requests in the stack).

Specified by:

compareTo in interface java.lang.Comparable<FlashServletRequest>

Parameters:

obj - (FlashServletRequest) The object to compare with this object.

Returns:

int - The result of the comparison: a negative integer if less than, a positive integer if greater than, a zero if equal.

equals

public boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal. Equality is based on hash code fields that were defined in the object's constructor.

Specified by:

equals in class MappedAttributesObject

Parameters:

obj - (Object) The object to compare with this object.

Returns:

boolean - true if the specified object is equal to this object, otherwise false.

after

public boolean after(FlashServletRequest obj)

Answers if this object is greater than the given object based on this object's compareTo method results.

Parameters:

obj - (FlashServletRequest) The object to compare with this object.

Returns:

boolean - true if this object is greater than the given object, otherwise false.

before

public boolean before(FlashServletRequest obj)

Answers if this object is less than the given object based on this object's compareTo method results.

Parameters:

obj - (FlashServletRequest) The object to compare with this object.

Returns:

boolean - true if this object is less than the given object, otherwise false.

matches

public boolean matches(FlashServletRequest obj)

Answers if this object is an exact match to the given object. All values contained within each object (except request id) must match in order to be considered exact matches.

Parameters:

obj - (FlashServletRequest) The object to compare with this object.

Returns:

boolean - true if this object is an exact match to the given object, otherwise false.

getId

public java.lang.String getId()

Returns the request's id.

Returns:

String - The request's id.

setId

public void setId(java.lang.String value)

Sets the request's id.

Parameters:

value - (String) The request's id.

getServletName

public java.lang.String getServletName()

Returns the request's servlet name.

Note that the name could be prefixed with admin/, sat/, sfi/ or other subpackage prefix.

Returns:

String - The request's servlet name.

setServletName

public void setServletName(java.lang.String value)

Sets the request's servlet name.

Note that the name could be prefixed with admin/, sat/, sfi/ or other subpackage prefix.

Parameters:

value - (String) The request's servlet name.

getServletURL

public java.lang.String getServletURL()

Returns the request's servlet URL. This is a concatentation of the servlet name and the request id as a parameter (name?req=id).

Returns:

String - The request's servlet name.

getUserId

public java.lang.String getUserId()

Returns the request's user id.

Returns:

String - The request's user id.

setUserId

public void setUserId(java.lang.String value)

Sets the request's user id.

Parameters:

value - (String) The request's user id.

getInvokerId

public java.lang.String getInvokerId()

Returns the request's invoker id (the id for the servlet that requested this servlet).

Returns:

String - The request's invoker id.

setInvokerId

public void setInvokerId(java.lang.String value)

Sets the request's invoker id (the id for the servlet that requested this servlet).

Parameters:

value - (String) The request's invoker id.

getTriggerId

public java.lang.String getTriggerId()

Returns the request's trigger id (the id for the servlet that initially triggered a function). Some functions within Flash can be triggered from a multiple number of servlets (such as account maintenance functions). This id points to the triggering servlet, which may or may not be the same as the invoker id.

Returns:

String - The request's trigger id.

setTriggerId

public void setTriggerId(java.lang.String value)

Sets the request's trigger id (the id for the servlet that initially triggered a function). Some functions within Flash can be triggered from a multiple number of servlets (such as account maintenance functions). This id points to the triggering servlet, which may or may not be the same as the invoker id.

Parameters:

value - (String) The request's trigger id.

getIsExpired

public boolean getIsExpired()

Returns the request's is expired flag.

Returns:

boolean - The request's is expired flag.

setIsExpired

public void setIsExpired(boolean value)

Sets the request's is expired flag.

Parameters:

value - (boolean) The request's is expired flag.

delParam

public void delParam(java.lang.String param)

Deletes the parameter having the given name.

Parameters:

param - (String) The name of the parameter to delete.

getParam

public java.lang.String getParam(java.lang.String param)

Returns a parameter's value as an string. Same as getParamString except returns null if a value for the parameter name does not exist.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

String - The specified parameter's value. Returns null if a value for the parameter name does not exist.

getParamArrayList

public java.util.ArrayList<?> getParamArrayList(java.lang.String param)

Returns a parameter's value as an array list.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

ArrayList - The specified parameter's value.

getParamBigDecimal

public java.math.BigDecimal getParamBigDecimal(java.lang.String param)

Returns a parameter's value as a big decimal.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

BigDecimal - The specified parameter's value.

getParamBoolean

public boolean getParamBoolean(java.lang.String param)

Returns a parameter's value as a boolean.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

boolean - The specified parameter's value.

getParamDate

public java.util.Date getParamDate(java.lang.String param)

Returns a parameter's value as a date.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

java.util.Date - The specified parameter's value.

getParamDouble

public double getParamDouble(java.lang.String param)

Returns a parameter's value as a double.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

double - The specified parameter's value.

getParamInteger

public int getParamInteger(java.lang.String param)

Returns a parameter's value as an int.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

int - The specified parameter's value.

getParamLong

public long getParamLong(java.lang.String param)

Returns a parameter's value as a long.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

long - The specified parameter's value.

getParamMapped

public MappedAttributesObject getParamMapped(java.lang.String param)

Returns a parameter's value as a mapped attributes object.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

MappedAttributesObject - The specified parameter's value.

getParamObject

public java.lang.Object getParamObject(java.lang.String param)

Returns a parameter's value as an object.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

Object - The specified parameter's value.

getParamShort

public short getParamShort(java.lang.String param)

Returns a parameter's value as a short.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

short - The specified parameter's value.

getParamString

public java.lang.String getParamString(java.lang.String param)

Returns a parameter's value as a string. Assumes the returned value should be trimmed.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

String - The specified parameter's value.

getParamString

public java.lang.String getParamString(java.lang.String param,
                                       boolean trim)

Returns a parameter's value as a string.

Parameters:

param - (String) The name of the parameter to retrieve.

trim - (boolean) true if the returned value should be trimmed, otherwise false.

Returns:

String - The specified parameter's value.

getParamVector

public java.util.Vector<?> getParamVector(java.lang.String param)

Returns a parameter's value as a vector.

Parameters:

param - (String) The name of the parameter to retrieve.

Returns:

Vector - The specified parameter's value.

getParams

public java.util.HashMap<java.lang.String,java.lang.Object> getParams()

Returns a map of all parameter names and their associated values.

Returns:

HashMap - The map of names and values.

hasParam

public boolean hasParam(java.lang.String param)

Answers if a parameter with the given name exists.

Parameters:

param - (String) The name of the parameter to check.

Returns:

boolean - true if the parameter exists, otherwise false.

setParam

public void setParam(java.lang.String param,
                     java.util.ArrayList<?> value)

Sets a parameter's value to an array list.

Parameters:

param - (String) The name of the parameter to set.

value - (ArrayList) The value to set.

setParam

public void setParam(java.lang.String param,
                     java.math.BigDecimal value)

Sets a parameter's value to a big decimal.

Parameters:

param - (String) The name of the parameter to set.

value - (BigDecimal) The value to set.

setParam

public void setParam(java.lang.String param,
                     boolean value)

Sets a parameter's value to a boolean.

Parameters:

param - (String) The name of the parameter to set.

value - (boolean) The value to set.

setParam

public void setParam(java.lang.String param,
                     java.util.Date value)

Sets a parameter's value to a date.

Parameters:

param - (String) The name of the parameter to set.

value - (java.util.Date) The value to set.

setParam

public void setParam(java.lang.String param,
                     double value)

Sets a parameter's value to a double.

Parameters:

param - (String) The name of the parameter to set.

value - (double) The value to set.

setParam

public void setParam(java.lang.String param,
                     int value)

Sets a parameter's value to an int.

Parameters:

param - (String) The name of the parameter to set.

value - (int) The value to set.

setParam

public void setParam(java.lang.String param,
                     long value)

Sets a parameter's value to a long.

Parameters:

param - (String) The name of the parameter to set.

value - (long) The value to set.

setParam

public void setParam(java.lang.String param,
                     MappedAttributesObject value)

Sets a parameter's value to a mapped attributes object.

Parameters:

param - (String) The name of the parameter to set.

value - (MappedAttributesObject) The value to set.

setParam

public void setParam(java.lang.String param,
                     java.lang.Object value)

Sets a parameter's value to an object.

Parameters:

param - (String) The name of the parameter to set.

value - (Object) The value to set.

setParam

public void setParam(java.lang.String param,
                     short value)

Sets a parameter's value to a short.

Parameters:

param - (String) The name of the parameter to set.

value - (short) The value to set.

setParam

public void setParam(java.lang.String param,
                     java.lang.String value)

Sets a parameter's value to a string. Assumes the string value should be trimmed.

Parameters:

param - (String) The name of the parameter to set.

value - (string) The value to set.

setParam

public void setParam(java.lang.String param,
                     java.lang.String value,
                     boolean trim)

Sets a parameter's value to a string.

Parameters:

param - (String) The name of the parameter to set.

value - (string) The value to set.

trim - (boolean) true if the string value should be trimmed, otherwise false.

setParam

public void setParam(java.lang.String param,
                     java.util.Vector<?> value)

Sets a parameter's value to a vector.

Parameters:

param - (String) The name of the parameter to set.

value - (Vector) The value to set.

toString

public java.lang.String toString()

Returns a string representation of this request. Overrides toString in Object.

Overrides:

toString in class java.lang.Object

Returns:

String - The request's string (class.id.servlet).