org.jvending.provisioning.stocking.filter
Interface FilterTask

public interface FilterTask

Represents the task of filtering a PAR file within a provider context.

Since:

2.0.0

Author:

Shane Isbell

Method Summary

java.util.Map	getContent() Returns a map of all of the content within the PAR file.
java.lang.String	getFilterID() Returns a unique ID for this task.
ProviderContext	getProviderContext() Returns the ProviderContext for this task.
ProvisioningArchive	getProvisioningArchive() Returns an unmarshalled version of the provisioning.xml file.
StockingHandlerConfig	getStockingHandlerConfig() Returns the StockingHandlerConfig for this task.

Method Detail

getProviderContext

ProviderContext getProviderContext()

Returns the ProviderContext for this task.

Returns:

the ProviderContext for this task.

getFilterID

java.lang.String getFilterID()

Returns a unique ID for this task.

Returns:

a unique ID for this task.

getContent

java.util.Map getContent()

Returns a map of all of the content within the PAR file. The key to each entry is the entry name within the PAR file. For instance, the provisioning archive can be obtained by FilterTask.getContent().get("META-INF/provisioning.xml") The returned value must be cast as byte[]

Returns:

a map of all of the content within the PAR file.

getProvisioningArchive

ProvisioningArchive getProvisioningArchive()

Returns an unmarshalled version of the provisioning.xml file. The object structure is directly based on http://java.sun.com/xml/ns/j2ee-cp Provisioning_1_0.xsd.

Returns:

an unmarshalled version of the provisioning.xml file.

getStockingHandlerConfig

StockingHandlerConfig getStockingHandlerConfig()

Returns the StockingHandlerConfig for this task.

Returns:

the StockingHandlerConfig for this task.