FlashServlet.Context

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

All Implemented Interfaces:

BaseServletContext, FlashServletContext, java.io.Serializable

Direct Known Subclasses:

Logoff.Context, MainServlet.Context, ScriptRequest.Context

Enclosing class:

FlashServlet
```
public class FlashServlet.Context
extends BaseServlet.Context
implements FlashServletContext
```
Inner class used to store servlet context information. Subclasses BaseServlet.Context and adds variables unique to this application.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`FlashServletRequest`	`nextURL` The servlet request object used to invoke the next servlet for processing.
`protected JDBCConnectionInfo`	`reqDbConnectInfo` The current request's JDBC connection information object.
`private static long`	`serialVersionUID` The class' serialization version id.
`protected Cart`	`sessionCart` The current session's shopping cart.
`protected boolean`	`sessionLogon` A flag indicating user logon has occurred.
`protected SecurityProfile`	`sessionSecProfile` The current session's security profile.
`protected User`	`sessionUser` The current session's user.
`protected User`	`sessionUserSfi` The current session's SFI/CSR selected user.
`FlashServletRequest`	`thisURL` The current request's servlet request object.

Fields inherited from class com.dpslink.base.servlet.BaseServlet.Context
request, requestBrowser, requestFlag, response, responseFlag, session, sessionNextURL, templateData

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UserCatalogVerifier`	`getCatalogVerifier()` Returns the current session's user catalog verifier.
`java.sql.Connection`	`getDbConnection()` Returns the JDBC connection from the current request's JDBC connection information object.
`JDBCConnectionInfo`	`getDbConnectionInfo()` Returns the current request's JDBC connection information object.
`<DBOBJCTLR extends JDBCObjectController<? extends JDBCObject<?>>> DBOBJCTLR`	`getDbController(java.lang.Class<DBOBJCTLR> ctlrcls)` Returns the JDBC object controller for the given controller class.
`<DBOBJ extends JDBCObject<?>> DBOBJ`	`getDbObject(java.lang.Class<DBOBJ> objcls)` Returns the JDBC object for the given object class.
`UserFavoritesHandler`	`getFavoritesHandler()` Returns the current session's user favorites handler.
`<ERPTYPE extends ERPInterface> ERPTYPE`	`getInterface(java.lang.Class<ERPTYPE> type)` Returns the ERP interface for the given interface type.
`User`	`getLogonUser()` Returns the current logon user.
`FlashServletRequest`	`getServletRequest()` Returns the current request's servlet request object.
`FlashServlet.Stack`	`getServletStack()` Returns the current session's servlet request stack.
`Cart`	`getShoppingCart()` Returns the current shopping cart.
`SecurityProfile`	`getShoppingProfile()` Returns the security profile that governs how shopping & other functions are processed.
`User`	`getShoppingUser()` Returns the current shopping user.
`SiteActivity`	`getSiteActivity()` Returns the current session's site activity.
`UnitMeasureHandler`	`getUomHandler()` Returns the current session's unit of measure handler.
`boolean`	`isCustAdmin()` Answers if the logon user is a customer administrator.
`boolean`	`isDefaultUser()` Answers if the logon user is the default user (no one is logged on).
`boolean`	`isLoggedOn()` Answers if a successful logon has occurred during the current session.
`boolean`	`isPermitActive()` Answers if permit processing is in effect (active) based on the value of `Flash.PERMIT_ENABLED` and whether any shopping is currently taking place.
`boolean`	`isRetail()` Answers if the site is for a retail store.
`boolean`	`isSfiSelect()` Answers if the logon user is a sales rep user and there is no account currently selected.
`boolean`	`isSfiShopping()` Answers if the logon user is a sales rep user and there is an account currently selected.
`boolean`	`isShopping()` Answers if the logon user is a basic shopping user.
`boolean`	`isSiteAdmin()` Answers if the logon user is a site administrator.
`boolean`	`isWholesale()` Answers if the site is for a wholesale store.
`void`	`setLogonUser(User user)` Sets the current logon user.

Methods inherited from class com.dpslink.base.servlet.BaseServlet.Context
delAttr, getAttr, getAttrBigDecimal, getAttrBoolean, getAttrDouble, getAttrInteger, getAttrLong, getAttrString, getParam, getParamBigDecimal, getParamDate, getParamDouble, getParamInteger, getParamLong, getParams, getParamString, getRequest, getResponse, getSession, isPost, setAttr

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

Methods inherited from interface com.dpslink.base.servlet.BaseServletContext
delAttr, getAttr, getAttrBigDecimal, getAttrBoolean, getAttrDouble, getAttrInteger, getAttrLong, getAttrString, getParam, getParamBigDecimal, getParamDate, getParamDouble, getParamInteger, getParamLong, getParams, getParamString, getRequest, getResponse, getSession, isPost, setAttr

- Field Detail
  - serialVersionUID
```
private static final long serialVersionUID
```
    The class' serialization version id.
    
    See Also:
    
    Constant Field Values
  - sessionCart
```
protected Cart sessionCart
```
    The current session's shopping cart.
  - sessionLogon
```
protected boolean sessionLogon
```
    A flag indicating user logon has occurred.
  - sessionSecProfile
```
protected SecurityProfile sessionSecProfile
```
    The current session's security profile.
  - sessionUser
```
protected User sessionUser
```
    The current session's user.
  - sessionUserSfi
```
protected User sessionUserSfi
```
    The current session's SFI/CSR selected user.
  - reqDbConnectInfo
```
protected JDBCConnectionInfo reqDbConnectInfo
```
    The current request's JDBC connection information object. Obtained by confirmSession and returned by requestComplete.
  - thisURL
```
public FlashServletRequest thisURL
```
    The current request's servlet request object. Obtained from the stack or created and added to the stack by confirmSession.
  - nextURL
```
public FlashServletRequest nextURL
```
    The servlet request object used to invoke the next servlet for processing. Use of this field is optional; subclasses are not required to use it. The field is defined here simply as a matter of convenience.
- Constructor Detail
  - Context
```
protected Context(javax.servlet.http.HttpServletRequest rqst,
                  javax.servlet.http.HttpServletResponse resp)
```
    Constructs a new Context.
    
    Parameters:
    
    rqst - (HttpServletRequest) The servlet's incoming request.
    
    resp - (HttpServletResponse) The servlet's outgoing response.
- Method Detail
  - getCatalogVerifier
```
public UserCatalogVerifier getCatalogVerifier()
```
    Returns the current session's user catalog verifier.
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    
    Specified by:
    
    getCatalogVerifier in interface FlashServletContext
    
    Returns:
    
    UserCatalogVerifier - The user catalog verifier.
  - getDbConnection
```
public java.sql.Connection getDbConnection()
```
    Returns the JDBC connection from the current request's JDBC connection information object. This is a shortcut convenience method for getDbConnectInfo().getConnection().
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    
    Specified by:
    
    getDbConnection in interface FlashServletContext
    
    Returns:
    
    Connection - The connection.
  - getDbConnectionInfo
```
public JDBCConnectionInfo getDbConnectionInfo()
```
    Returns the current request's JDBC connection information object. A JDBC connection is automatically obtained from the pool at the start of a request's processing and is automatically returned to the pool at the end of a request's processing.
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    
    Specified by:
    
    getDbConnectionInfo in interface FlashServletContext
    
    Returns:
    
    JDBCConnectionInfo - The connection information object.
  - getDbController
```
public <DBOBJCTLR extends JDBCObjectController<? extends JDBCObject<?>>> DBOBJCTLR getDbController(java.lang.Class<DBOBJCTLR> ctlrcls)
```
    Returns the JDBC object controller for the given controller class. This is a shortcut convenience method for getDbConnectInfo().getController().
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    
    Specified by:
    
    getDbController in interface FlashServletContext
    
    Parameters:
    
    ctlrcls - (Class) The class for the desired controller.
    
    Returns:
    
    JDBCObjectController - The JDBC object controller.
  - getDbObject
```
public <DBOBJ extends JDBCObject<?>> DBOBJ getDbObject(java.lang.Class<DBOBJ> objcls)
```
    Returns the JDBC object for the given object class.
    
    Specified by:
    
    getDbObject in interface FlashServletContext
    
    Parameters:
    
    objcls - (Class) The class for the desired object.
    
    Returns:
    
    JDBCObject - The JDBC object.
  - getFavoritesHandler
```
public UserFavoritesHandler getFavoritesHandler()
```
    Returns the current session's user favorites handler.
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    
    Specified by:
    
    getFavoritesHandler in interface FlashServletContext
    
    Returns:
    
    UserFavoritesHandler - The user favorites handler.
  - getInterface
```
public <ERPTYPE extends ERPInterface> ERPTYPE getInterface(java.lang.Class<ERPTYPE> type)
```
    Returns the ERP interface for the given interface type. Returns a cached instance of the interface if a cached instance exists; otherwise creates a new instance, adds the new instance to the cache and then returns the new instance. Sets the interface's context to this context.
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    
    Specified by:
    
    getInterface in interface FlashServletContext
    
    Parameters:
    
    type - (Class) The type for the desired ERP interface. Must be one of the constants defined in ERP.
    
    Returns:
    
    ERPInterface - The ERP interface or null if unable to create or obtain the requested ERP interface or if no interface is defined for the given type.
  - getLogonUser
```
public User getLogonUser()
```
    Returns the current logon user. For a retail site, returns the default user if logon has not yet occurred.
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    
    Specified by:
    
    getLogonUser in interface FlashServletContext
    
    Returns:
    
    User - The logon user.
  - setLogonUser
```
public void setLogonUser(User user)
```
    Sets the current logon user.
    
    Specified by:
    
    setLogonUser in interface FlashServletContext
    
    Parameters:
    
    user - (User) The logon user.
  - getServletRequest
```
public FlashServletRequest getServletRequest()
```
    Returns the current request's servlet request object.
    
    Specified by:
    
    getServletRequest in interface FlashServletContext
    
    Returns:
    
    FlashServletRequest - The servlet request object.
  - getServletStack
```
public FlashServlet.Stack getServletStack()
```
    Returns the current session's servlet request stack.
    
    Specified by:
    
    getServletStack in interface FlashServletContext
    
    Returns:
    
    Stack - The servlet request stack.
  - getShoppingCart
```
public Cart getShoppingCart()
```
    Returns the current shopping cart.
    
    Specified by:
    
    getShoppingCart in interface FlashServletContext
    
    Returns:
    
    Cart - The shopping cart.
  - getShoppingProfile
```
public SecurityProfile getShoppingProfile()
```
    Returns the security profile that governs how shopping & other functions are processed.
    - During public shopping (isShopping) this will either be the default user's security profile or the logon user's security profile.
    - During SFI/CSR shopping (isSfiShopping) this will be the rep's security profile.
    - During SFI/CSR account selection (isSfiSelect) this will be the rep's security profile.
    - During site admin (isSiteAdmin) this will be the admin user's security profile.
    - At any other time returns null.
    Specified by:
    
    getShoppingProfile in interface FlashServletContext
    
    Returns:
    
    SecurityProfile - The security profile.
  - getShoppingUser
```
public User getShoppingUser()
```
    Returns the current shopping user.
    - During public shopping (isShopping) returns the current logon user (same as getLogonUser).
    - During SFI/CSR shopping (isSfiShopping) returns the rep's selected user.
    - During SFI/CSR account selection (isSfiSelect) returns null.
    - During site admin (isSiteAdmin) returns null.
    - At any other time returns null.
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    Specified by:
    
    getShoppingUser in interface FlashServletContext
    
    Returns:
    
    User - The shopping user.
  - getSiteActivity
```
public SiteActivity getSiteActivity()
```
    Returns the current session's site activity.
    
    Specified by:
    
    getSiteActivity in interface FlashServletContext
    
    Returns:
    
    SiteActivity - The site activity.
  - getUomHandler
```
public UnitMeasureHandler getUomHandler()
```
    Returns the current session's unit of measure handler.
    DO NOT CACHE THE RETURNED VALUE. DO NOT USE THE RETURNED VALUE IN A THREAD OTHER THAN THE SERVLET'S THREAD.
    
    Specified by:
    
    getUomHandler in interface FlashServletContext
    
    Returns:
    
    UnitMeasureHandler - The unit of measure handler.
  - isCustAdmin
```
public boolean isCustAdmin()
```
    Answers if the logon user is a customer administrator.
    
    Specified by:
    
    isCustAdmin in interface FlashServletContext
    
    Returns:
    
    boolean - true if the logon user is a customer administrator, otherwise false.
  - isDefaultUser
```
public boolean isDefaultUser()
```
    Answers if the logon user is the default user (no one is logged on).
    
    Specified by:
    
    isDefaultUser in interface FlashServletContext
    
    Returns:
    
    boolean - true if the logon user is the default user, otherwise false.
  - isLoggedOn
```
public boolean isLoggedOn()
```
    Answers if a successful logon has occurred during the current session.
    
    Specified by:
    
    isLoggedOn in interface FlashServletContext
    
    Returns:
    
    boolean - true if a successful logon has occurred, otherwise false.
  - isPermitActive
```
public boolean isPermitActive()
```
    Answers if permit processing is in effect (active) based on the value of Flash.PERMIT_ENABLED and whether any shopping is currently taking place.
    
    Specified by:
    
    isPermitActive in interface FlashServletContext
    
    Returns:
    
    boolean - true if permit processing is active, otherwise false.
  - isRetail
```
public boolean isRetail()
```
    Answers if the site is for a retail store.
    
    Specified by:
    
    isRetail in interface FlashServletContext
    
    Returns:
    
    boolean - true if the site is for a retail store, otherwise false.
  - isSfiSelect
```
public boolean isSfiSelect()
```
    Answers if the logon user is a sales rep user and there is no account currently selected.
    
    Specified by:
    
    isSfiSelect in interface FlashServletContext
    
    Returns:
    
    boolean - true if the logon user is a sales rep user with no selected account, otherwise false.
  - isSfiShopping
```
public boolean isSfiShopping()
```
    Answers if the logon user is a sales rep user and there is an account currently selected.
    
    Specified by:
    
    isSfiShopping in interface FlashServletContext
    
    Returns:
    
    boolean - true if the logon user is a sales rep user with a selected account, otherwise false.
  - isShopping
```
public boolean isShopping()
```
    Answers if the logon user is a basic shopping user.
    
    Specified by:
    
    isShopping in interface FlashServletContext
    
    Returns:
    
    boolean - true if the logon user is a basic shopping user, otherwise false.
  - isSiteAdmin
```
public boolean isSiteAdmin()
```
    Answers if the logon user is a site administrator.
    
    Specified by:
    
    isSiteAdmin in interface FlashServletContext
    
    Returns:
    
    boolean - true if the logon user is a site administrator, otherwise false.
  - isWholesale
```
public boolean isWholesale()
```
    Answers if the site is for a wholesale store.
    
    Specified by:
    
    isWholesale in interface FlashServletContext
    
    Returns:
    
    boolean - true if the site is for a wholesale store, otherwise false.

Class FlashServlet.Context

Field Summary

Fields inherited from class com.dpslink.base.servlet.BaseServlet.Context

Constructor Summary

Method Summary

Methods inherited from class com.dpslink.base.servlet.BaseServlet.Context

Methods inherited from class java.lang.Object

Methods inherited from interface com.dpslink.base.servlet.BaseServletContext

Field Detail

serialVersionUID

sessionCart

sessionLogon

sessionSecProfile

sessionUser

sessionUserSfi

reqDbConnectInfo

thisURL

nextURL

Constructor Detail

Context

Method Detail

getCatalogVerifier

getDbConnection

getDbConnectionInfo

getDbController

getDbObject

getFavoritesHandler

getInterface

getLogonUser

setLogonUser

getServletRequest

getServletStack

getShoppingCart

getShoppingProfile

getShoppingUser

getSiteActivity

getUomHandler

isCustAdmin

isDefaultUser

isLoggedOn

isPermitActive

isRetail

isSfiSelect

isSfiShopping

isShopping

isSiteAdmin

isWholesale