com.dpslink.flash.util

Class ThreadServletContext

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.flash.util.ThreadServletContext

All Implemented Interfaces:

BaseServletContext, FlashServletContext, java.io.Serializable

Direct Known Subclasses:

ClientRequest.Context, OrderRequestAPI.Context, ProductLookup.Context

public class ThreadServletContext
extends MappedAttributesObject
implements FlashServletContext

A servlet context for background processing threads.

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
ThreadServletContext(FlashServletContext ctx) Constructs a new ThreadServletContext with no JDBC connection.
ThreadServletContext(FlashServletContext ctx, boolean dbaccess) Constructs a new ThreadServletContext and optionally obtains a JDBC connection.

Method Summary

Modifier and Type	Method and Description
void	delAttr(java.lang.String key) Deprecated.
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
void	freeDbConnection() Returns the context's JDBC connection to the connection pool.
java.lang.Object	getAttr(java.lang.String key) Deprecated.
java.math.BigDecimal	getAttrBigDecimal(java.lang.String key) Deprecated.
boolean	getAttrBoolean(java.lang.String key) Deprecated.
double	getAttrDouble(java.lang.String key) Deprecated.
int	getAttrInteger(java.lang.String key) Deprecated.
long	getAttrLong(java.lang.String key) Deprecated.
java.lang.String	getAttrString(java.lang.String key) Deprecated.
UserCatalogVerifier	getCatalogVerifier() Returns the context's user catalog verifier.
java.sql.Connection	getDbConnection() Returns the JDBC connection from the context's JDBC connection information object.
JDBCConnectionInfo	getDbConnectionInfo() Returns the context'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 context'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 context's logon user.
java.lang.String	getParam(java.lang.String name) Deprecated.
java.math.BigDecimal	getParamBigDecimal(java.lang.String name) Deprecated.
java.util.Date	getParamDate(java.lang.String name) Deprecated.
double	getParamDouble(java.lang.String name) Deprecated.
int	getParamInteger(java.lang.String name) Deprecated.
long	getParamLong(java.lang.String name) Deprecated.
java.lang.String[]	getParams(java.lang.String name) Deprecated.
java.lang.String	getParamString(java.lang.String name) Deprecated.
javax.servlet.http.HttpServletRequest	getRequest() Deprecated.
javax.servlet.http.HttpServletResponse	getResponse() Deprecated.
FlashServletRequest	getServletRequest() Returns the current request's servlet request object.
FlashServlet.Stack	getServletStack() Returns the current session's servlet request stack.
javax.servlet.http.HttpSession	getSession() Returns the current servlet session.
Cart	getShoppingCart() Returns the context's shopping cart.
SecurityProfile	getShoppingProfile() Returns the security profile that governs how shopping & other functions are processed.
User	getShoppingUser() Returns the context's shopping user.
SiteActivity	getSiteActivity() Returns the context's site activity.
UnitMeasureHandler	getUomHandler() Returns the context'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 session passed to the context's constructor (within the supplied context).
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	isPost() Deprecated.
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	setAttr(java.lang.String key, java.lang.Object value) Deprecated.
void	setLogonUser(User user) Sets the context's logon user.

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

Constructor Detail

ThreadServletContext

public ThreadServletContext(FlashServletContext ctx)

Constructs a new ThreadServletContext with no JDBC connection.

Parameters:

ctx - (FlashServletContext) The current servlet context.

ThreadServletContext

public ThreadServletContext(FlashServletContext ctx,
                            boolean dbaccess)

Constructs a new ThreadServletContext and optionally obtains a JDBC connection.

THREAD CLASSES THAT USE A JDBC CONNECTION MUST RETURN THE CONNECTION TO THE CONNECTION POOL PRIOR TO COMPLETING PROCESSING. SEE freeDbConnection.

Parameters:

ctx - (FlashServletContext) The current servlet context.

dbaccess - (boolean) true if the user of this thread servlet context requires access to the database, otherwise false.

Throws:

java.lang.NullPointerException - - if unable to obtain a JDBC connection.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal. Implements equals in MappedAttributesObject. This implementation always returns false.

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.

delAttr

@Deprecated
public void delAttr(java.lang.String key)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public java.lang.Object getAttr(java.lang.String key)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public java.math.BigDecimal getAttrBigDecimal(java.lang.String key)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public boolean getAttrBoolean(java.lang.String key)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public double getAttrDouble(java.lang.String key)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public int getAttrInteger(java.lang.String key)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public long getAttrLong(java.lang.String key)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public java.lang.String getAttrString(java.lang.String key)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public void setAttr(java.lang.String key,
                                 java.lang.Object value)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public java.lang.String getParam(java.lang.String name)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public java.lang.String[] getParams(java.lang.String name)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public java.math.BigDecimal getParamBigDecimal(java.lang.String name)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public java.util.Date getParamDate(java.lang.String name)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public double getParamDouble(java.lang.String name)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public int getParamInteger(java.lang.String name)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public long getParamLong(java.lang.String name)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public java.lang.String getParamString(java.lang.String name)

Deprecated.

Description copied from interface: BaseServletContext

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

@Deprecated
public javax.servlet.http.HttpServletRequest getRequest()

Deprecated.

Description copied from interface: BaseServletContext

Returns the current servlet HTTP request.

Specified by:

getRequest in interface BaseServletContext

Returns:

HttpServletRequest - The current servlet HTTP request.

getResponse

@Deprecated
public javax.servlet.http.HttpServletResponse getResponse()

Deprecated.

Description copied from interface: BaseServletContext

Returns the current servlet HTTP response.

Specified by:

getResponse in interface BaseServletContext

Returns:

HttpServletResponse - The current servlet HTTP response.

isPost

@Deprecated
public boolean isPost()

Deprecated.

Description copied from interface: BaseServletContext

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.

getSession

public javax.servlet.http.HttpSession getSession()

Returns the current servlet session.

Specified by:

getSession in interface BaseServletContext

Returns:

HttpSession - The current servlet session.

getCatalogVerifier

public UserCatalogVerifier getCatalogVerifier()

Returns the context's user catalog verifier. Implements getCatalogVerifier in FlashServletContext.

Specified by:

getCatalogVerifier in interface FlashServletContext

Returns:

UserCatalogVerifier - The user catalog verifier.

getDbConnection

public java.sql.Connection getDbConnection()

Returns the JDBC connection from the context's JDBC connection information object. Implements getDbConnection in FlashServletContext.

Specified by:

getDbConnection in interface FlashServletContext

Returns:

Connection - The connection.

getDbConnectionInfo

public JDBCConnectionInfo getDbConnectionInfo()

Returns the context's JDBC connection information object. Implements getDbConnectionInfo in FlashServletContext.

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. Implements getDbController in FlashServletContext.

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. Implements getDbObject in FlashServletContext.

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 context's user favorites handler. Implements getFavoritesHandler in FlashServletContext.

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. Implements getInterface in FlashServletContext.

Specified by:

getInterface in interface FlashServletContext

Parameters:

type - (Class) The type for the desired ERP interface. Must be one of the constants defined in ERPFactory.

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 context's logon user. For a retail site, returns the default user if logon has not yet occurred. Implements getLogonUser in FlashServletContext.

Specified by:

getLogonUser in interface FlashServletContext

Returns:

User - The logon user.

setLogonUser

public void setLogonUser(User user)

Sets the context's 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:

FlashServlet.Stack - The servlet request stack.

getShoppingCart

public Cart getShoppingCart()

Returns the context's shopping cart. Implements getShoppingCart in FlashServletContext.

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.

Implements getShoppingProfile in FlashServletContext.

Specified by:

getShoppingProfile in interface FlashServletContext

Returns:

SecurityProfile - The security profile.

getShoppingUser

public User getShoppingUser()

Returns the context's shopping user. Implements getShoppingUser in FlashServletContext.

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

Implements getShoppingUser in FlashServletContext.

Specified by:

getShoppingUser in interface FlashServletContext

Returns:

User - The shopping user.

getSiteActivity

public SiteActivity getSiteActivity()

Returns the context's site activity. Implements getSiteActivity in FlashServletContext.

Specified by:

getSiteActivity in interface FlashServletContext

Returns:

SiteActivity - The site activity.

getUomHandler

public UnitMeasureHandler getUomHandler()

Returns the context's unit of measure handler. Implements getUomHandler in FlashServletContext.

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. Implements isCustAdmin in FlashServletContext.

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). Implements isDefaultUser in FlashServletContext.

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 session passed to the context's constructor (within the supplied context). Implements isLoggedOn in FlashServletContext.

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. Implements isRetail in FlashServletContext.

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. Implements isSfiSelect in FlashServletContext.

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. Implements isSfiShopping in FlashServletContext.

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. Implements isShopping in FlashServletContext.

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. Implements isSiteAdmin in FlashServletContext.

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. Implements isWholesale in FlashServletContext.

Specified by:

isWholesale in interface FlashServletContext

Returns:

boolean - true if the site is for a wholesale store, otherwise false.

freeDbConnection

public void freeDbConnection()

Returns the context's JDBC connection to the connection pool.