BaseServlet.Context

java.lang.Object
- com.dpslink.base.servlet.BaseServlet.Context

All Implemented Interfaces:

BaseServletContext, java.io.Serializable

Direct Known Subclasses:

FlashServlet.Context

Enclosing class:

BaseServlet
```
protected class BaseServlet.Context
extends java.lang.Object
implements BaseServletContext
```
Inner class used to store servlet context information. Subclasses of BaseServlet can extend this class to add their own context variables.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected javax.servlet.http.HttpServletRequest`	`request` The current HTTP request object.
`int`	`requestBrowser` The current user agent type.
`int`	`requestFlag` The current request flag.
`protected javax.servlet.http.HttpServletResponse`	`response` The current HTTP response object.
`int`	`responseFlag` The current response flag.
`private static long`	`serialVersionUID` The class' serialization version id.
`javax.servlet.http.HttpSession`	`session` The current servlet session.
`java.util.Hashtable<java.lang.String,java.lang.String>`	`sessionNextURL` The current session's set of next URL values.
`org.apache.velocity.VelocityContext`	`templateData` The current set of Velocity template data.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Context(javax.servlet.http.HttpServletRequest rqst, javax.servlet.http.HttpServletResponse resp)` Constructs a new servlet context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delAttr(java.lang.String key)` A shortcut convenience method that removes an attribute value from the current session.
`java.lang.Object`	`getAttr(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session.
`java.math.BigDecimal`	`getAttrBigDecimal(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `BigDecimal`.
`boolean`	`getAttrBoolean(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `boolean`.
`double`	`getAttrDouble(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `double`.
`int`	`getAttrInteger(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as an `int`.
`long`	`getAttrLong(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `long`.
`java.lang.String`	`getAttrString(java.lang.String key)` A shortcut convenience method that returns an attribute value from the current session as a `String`.
`java.lang.String`	`getParam(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request.
`java.math.BigDecimal`	`getParamBigDecimal(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `BigDecimal`.
`java.util.Date`	`getParamDate(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `java.util.Date`.
`double`	`getParamDouble(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `double`.
`int`	`getParamInteger(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as an `int`.
`long`	`getParamLong(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `long`.
`java.lang.String[]`	`getParams(java.lang.String name)` A shortcut convenience method that returns an array of parameter values from the current request.
`java.lang.String`	`getParamString(java.lang.String name)` A shortcut convenience method that returns a parameter value from the current request as a `String`.
`javax.servlet.http.HttpServletRequest`	`getRequest()` Returns the current servlet HTTP request.
`javax.servlet.http.HttpServletResponse`	`getResponse()` Returns the current servlet HTTP response.
`javax.servlet.http.HttpSession`	`getSession()` Returns the current servlet session.
`boolean`	`isPost()` Answers if a form has been posted by checking the current HTTP request's method for "POST".
`void`	`setAttr(java.lang.String key, java.lang.Object value)` A shortcut convenience method that sets an attribute value in the current session.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    The class' serialization version id.
    
    See Also:
    
    Constant Field Values
  - request
```
protected javax.servlet.http.HttpServletRequest request
```
    The current HTTP request object.
  - response
```
protected javax.servlet.http.HttpServletResponse response
```
    The current HTTP response object.
  - requestFlag
```
public int requestFlag
```
    The current request flag. This value will be either RQST_NULL or RQST_AJAX. The default is RQST_NULL.
  - responseFlag
```
public int responseFlag
```
    The current response flag. This value will be either RESP_NULL or RESP_REDIRECTED. The default is RESP_NULL.
  - templateData
```
public org.apache.velocity.VelocityContext templateData
```
    The current set of Velocity template data.
  - session
```
public javax.servlet.http.HttpSession session
```
    The current servlet session.
  - sessionNextURL
```
public java.util.Hashtable<java.lang.String,java.lang.String> sessionNextURL
```
    The current session's set of next URL values.
  - requestBrowser
```
public int requestBrowser
```
    The current user agent type. This value will be either BROWSER_IE, BROWSER_NN or BROWSER_XX. The default is BROWSER_XX.
- Constructor Detail
  - Context
```
protected Context(javax.servlet.http.HttpServletRequest rqst,
                  javax.servlet.http.HttpServletResponse resp)
```
    Constructs a new servlet context.
    
    Parameters:
    
    rqst - (HttpServletRequest) The servlet's incoming request.
    
    resp - (HttpServletResponse) The servlet's outgoing response.
- Method Detail
  - delAttr
```
public void delAttr(java.lang.String key)
```
    A shortcut convenience method that removes an attribute value from the current session.
    
    Specified by:
    
    delAttr in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key for the attribute value to remove.
  - getAttr
```
public java.lang.Object getAttr(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session.
    
    Specified by:
    
    getAttr in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    Object - The value associated with the given key. Returns null if a value for the key does not exist.
  - getAttrBigDecimal
```
public java.math.BigDecimal getAttrBigDecimal(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a BigDecimal.
    
    Specified by:
    
    getAttrBigDecimal in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    BigDecimal - The value associated with the given key. Returns null if a value for the key does not exist or if the key's value could not be converted to a BigDecimal.
  - getAttrBoolean
```
public boolean getAttrBoolean(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a boolean.
    
    Specified by:
    
    getAttrBoolean in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    boolean - The value associated with the given key. Returns false if a value for the key does not exist or if the key's value could not be converted to a boolean.
  - getAttrDouble
```
public double getAttrDouble(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a double.
    
    Specified by:
    
    getAttrDouble in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    double - The value associated with the given key. Returns zero if a value for the key does not exist or if the key's value could not be converted to a double.
  - getAttrInteger
```
public int getAttrInteger(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as an int.
    
    Specified by:
    
    getAttrInteger in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    int - The value associated with the given key. Returns zero if a value for the key does not exist or if the key's value could not be converted to an integer.
  - getAttrLong
```
public long getAttrLong(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a long.
    
    Specified by:
    
    getAttrLong in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    long - The value associated with the given key. Returns zero if a value for the key does not exist or if the key's value could not be converted to a long.
  - getAttrString
```
public java.lang.String getAttrString(java.lang.String key)
```
    A shortcut convenience method that returns an attribute value from the current session as a String.
    
    Specified by:
    
    getAttrString in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key for the desired attribute value.
    
    Returns:
    
    String - The value associated with the given key. Returns an empty string if a value for the key does not exist.
  - setAttr
```
public void setAttr(java.lang.String key,
                    java.lang.Object value)
```
    A shortcut convenience method that sets an attribute value in the current session.
    
    Specified by:
    
    setAttr in interface BaseServletContext
    
    Parameters:
    
    key - (String) The key associated with the value.
    
    value - (Object) The attribute value to set.
  - getParam
```
public java.lang.String getParam(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request.
    
    Specified by:
    
    getParam in interface BaseServletContext
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    String - The value associated with the given parameter name. Returns null if a value for the parameter name does not exist.
  - getParams
```
public java.lang.String[] getParams(java.lang.String name)
```
    A shortcut convenience method that returns an array of parameter values from the current request.
    
    Specified by:
    
    getParams in interface BaseServletContext
    
    Parameters:
    
    name - (String) The name of the desired parameter values.
    
    Returns:
    
    String[] - The values associated with the given parameter name. Returns null if a value for the parameter name does not exist.
  - getParamBigDecimal
```
public java.math.BigDecimal getParamBigDecimal(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a BigDecimal.
    
    Specified by:
    
    getParamBigDecimal in interface BaseServletContext
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    BigDecimal - The value associated with the given parameter name. Returns zero if a value for the parameter name does not exist or if the parameter value could not be converted to a BigDecimal.
  - getParamDate
```
public java.util.Date getParamDate(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a java.util.Date.
    
    Specified by:
    
    getParamDate in interface BaseServletContext
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    Date - The value associated with the given parameter name. Returns null if a value for the parameter name does not exist or if the parameter value could not be converted to a date.
  - getParamDouble
```
public double getParamDouble(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a double.
    
    Specified by:
    
    getParamDouble in interface BaseServletContext
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    double - The value associated with the given parameter name. Returns zero if a value for the parameter name does not exist or if the parameter value could not be converted to a double.
  - getParamInteger
```
public int getParamInteger(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as an int.
    
    Specified by:
    
    getParamInteger in interface BaseServletContext
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    int - The value associated with the given parameter name. Returns zero if a value for the parameter name does not exist or if the parameter value could not be converted to an int.
  - getParamLong
```
public long getParamLong(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a long.
    
    Specified by:
    
    getParamLong in interface BaseServletContext
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    long - The value associated with the given parameter name. Returns zero if a value for the parameter name does not exist or if the parameter value could not be converted to a long.
  - getParamString
```
public java.lang.String getParamString(java.lang.String name)
```
    A shortcut convenience method that returns a parameter value from the current request as a String.
    
    Specified by:
    
    getParamString in interface BaseServletContext
    
    Parameters:
    
    name - (String) The name of the desired parameter value.
    
    Returns:
    
    String - The value associated with the given parameter name. Returns an empty string if a value for the parameter name does not exist.
  - getRequest
```
public javax.servlet.http.HttpServletRequest getRequest()
```
    Returns the current servlet HTTP request.
    
    Specified by:
    
    getRequest in interface BaseServletContext
    
    Returns:
    
    HttpServletRequest - The current servlet HTTP request.
  - getResponse
```
public javax.servlet.http.HttpServletResponse getResponse()
```
    Returns the current servlet HTTP response.
    
    Specified by:
    
    getResponse in interface BaseServletContext
    
    Returns:
    
    HttpServletResponse - The current servlet HTTP response.
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Returns the current servlet session.
    
    Specified by:
    
    getSession in interface BaseServletContext
    
    Returns:
    
    HttpSession - The current servlet session.
  - isPost
```
public boolean isPost()
```
    Answers if a form has been posted by checking the current HTTP request's method for "POST".
    
    Specified by:
    
    isPost in interface BaseServletContext
    
    Returns:
    
    boolean - true if a form has been posted, otherwise false.

Class BaseServlet.Context

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

request

response

requestFlag

responseFlag

templateData

session

sessionNextURL

requestBrowser

Constructor Detail

Context

Method Detail

delAttr

getAttr

getAttrBigDecimal

getAttrBoolean

getAttrDouble

getAttrInteger

getAttrLong

getAttrString

setAttr

getParam

getParams

getParamBigDecimal

getParamDate

getParamDouble

getParamInteger

getParamLong

getParamString

getRequest

getResponse

getSession

isPost