org.jvending.provisioning.stocking.handler
Interface StockingHandlerConfig

public interface StockingHandlerConfig

Contains configuration information for the stocking handler, which is obtained from the stocking-handlers.xml file.

Since:

2.0.0

Author:

Shane Isbell

Method Summary

StockingPolicy	getContentPolicy() Returns a StockingPolicy for the content contained within the PAR file.
StockingPolicy	getCopyrightPolicy() Returns a StockingPolicy for the copyrights contained with the PAR file.
DataSink	getDataSink() Returns a DataSink that will be used as the sink for thr PAR file.
java.util.List	getDescriptorHandlers() Returns a list of DescriptorHandler instances.
StockingPolicy	getDescriptorPolicy() Returns a StockingPolicy for the descriptor files contained withing the PAR file.
StockingPolicy	getIconPolicy() Returns a StockingPolicy for the icons contained with the PAR file.
java.lang.String	getInitParameter(java.lang.String name) Returns the value of an initialization parameter for the given name.
java.util.Set	getInitParameterNames() Returns a set of initialization parameter names
StockingPolicy	getPreviewPolicy() Returns a StockingPolicy for the previews contained with the PAR file.
StockingContext	getStockingContext() Returns the StockingContext
java.util.List	getStockingFilters() Returns a list of StockingFilterinstances.
java.lang.String	getStockingHandlerName() Returns the name of the StockingHandler that this configuration file belongs to.

Method Detail

getInitParameter

java.lang.String getInitParameter(java.lang.String name)

Returns the value of an initialization parameter for the given name.

Parameters:

name - of the parameter

Returns:

the value of an initialization parameter for the given name.

getInitParameterNames

java.util.Set getInitParameterNames()

Returns a set of initialization parameter names

Returns:

a set of initialization parameter names

getStockingContext

StockingContext getStockingContext()

Returns the StockingContext

Returns:

the StockingContext

getStockingFilters

java.util.List getStockingFilters()

Returns a list of StockingFilterinstances.

Returns:

a list of StockingFilterinstances.

getDescriptorHandlers

java.util.List getDescriptorHandlers()

Returns a list of DescriptorHandler instances.

Returns:

a list of DescriptorHandler instances.

getDataSink

DataSink getDataSink()

Returns a DataSink that will be used as the sink for thr PAR file.

Returns:

a DataSink that will be used as the sink for thr PAR file.

getStockingHandlerName

java.lang.String getStockingHandlerName()

Returns the name of the StockingHandler that this configuration file belongs to.

Returns:

the name of the StockingHandler that this configuration file belongs to.

getContentPolicy

StockingPolicy getContentPolicy()

Returns a StockingPolicy for the content contained within the PAR file. Content refers to the primary content bundle that is to be delivered to the user, not meta-data associated with that content.

Returns:

a StockingPolicy for the content contained within the PAR file.

getDescriptorPolicy

StockingPolicy getDescriptorPolicy()

Returns a StockingPolicy for the descriptor files contained withing the PAR file. Typically, this will be a policy for how to handle a JAD or JNLP file, but may also include custom descriptor types.

Returns:

a StockingPolicy for the descriptor files contained withing the PAR file.

getIconPolicy

StockingPolicy getIconPolicy()

Returns a StockingPolicy for the icons contained with the PAR file.

Returns:

a StockingPolicy for the icons contained with the PAR file.

getPreviewPolicy

StockingPolicy getPreviewPolicy()

Returns a StockingPolicy for the previews contained with the PAR file.

Returns:

a StockingPolicy for the previews contained with the PAR file.

getCopyrightPolicy

StockingPolicy getCopyrightPolicy()

Returns a StockingPolicy for the copyrights contained with the PAR file. Copyrights can be an icon or text, so they need to be managed as any other binary. Sometimes the copyright is written directly within the provisioning.xml file, in which case this policy will be ignored.

Returns:

a StockingPolicy for the copyrights contained with the PAR file.