org.jvending.provisioning.stocking
Interface StockingContext

public interface StockingContext

Provides stocking services for the provisioning framework. There is only one instance of this class within the framework. It is stored as a ServletContext attribute with the name "org.jvending.provisioning.stocking.StockingContext"

Since:

2.0.0

Author:

Shane Isbell

Method Summary

void	destroy() Called when the provisioning framework takes the StockingContext out of service.
ProviderContext	getProviderContext(javax.servlet.http.HttpServletRequest request) Obtains a ProviderContext
javax.servlet.ServletContext	getServletContext() Accessor for the ServletContext
StockingComponent	getStockingComponent() Accessor for the StockingComponent
StockingHandler	getStockingHandler(java.lang.String name) Accessor for the StockingHandler
void	init(javax.servlet.ServletContext servletContext) Called by the provisioning framework when the StockingContext is put into service.

Method Detail

getServletContext

javax.servlet.ServletContext getServletContext()

Accessor for the ServletContext

Returns:

ServletContext

getStockingHandler

StockingHandler getStockingHandler(java.lang.String name)
                                   throws StockingException

Accessor for the StockingHandler

Parameters:

name - of the StockingHandler. It matches with the stocking-handler-name tag within the stocking-handlers.xml file.

Returns:

StockingHandler

Throws:

StockingException

getStockingComponent

StockingComponent getStockingComponent()

Accessor for the StockingComponent

Returns:

StockingComponent

init

void init(javax.servlet.ServletContext servletContext)

Called by the provisioning framework when the StockingContext is put into service.

Parameters:

servletContext -

destroy

void destroy()

Called when the provisioning framework takes the StockingContext out of service.

getProviderContext

ProviderContext getProviderContext(javax.servlet.http.HttpServletRequest request)

Obtains a ProviderContext

Parameters:

request -

Returns:

ProviderContext