de.hybris.platform.print.comet

Class DefaultPublicationController

java.lang.Object

de.hybris.platform.print.comet.DefaultPublicationController

All Implemented Interfaces:

PublicationController

public class DefaultPublicationController
extends Object
implements PublicationController

Manages Werk II Comet requests and creates related responses.

Constructor Summary

Constructors

Constructor and Description
DefaultPublicationController()

Method Summary

Modifier and Type	Method and Description
CometBinary	getBinaryFile(String fileId) Returns a media that contains the requested file
CallProcessor	getCometCallProcessor(String method) Returns the CallProcessor that is registered for the given method
ElementlistProcessor	getElementListProcessor(String method) Returns the ElementlistProcessor that is registered for the given method
ListProcessor	getListProcessor(String method) Returns the ListProcessor that is registered for the given method
String	getMessage(int messageCode) Returns a (localized) error message for the given error code
void	getNextHotfolder(String program, int status, int id) Returns the next hotfolder that AutoComet shall observe for AutoCometJobs
AutoCometJob	getNextJob(String program, int status) Returns the next AutoCometJob
CometProduct[]	getProductList(Map<String,CometCondition> parameters) Returns an Array of list entries that will be displayed in the Comet product tree.
ProductListProcessor	getProductListProcessor(String method)
static boolean	hasSubItems(Item item)
static boolean	hasSubItems(SessionContext ctx, Item item) Verifies if the given item has sub ordinated items
void	putBinaryFile(String fileId, CometBinary file) Stores the content of the given file
void	registerCallProcessor(CallProcessor processor) Adds the given CallProcessor
void	registerElementlistProcessor(ElementlistProcessor processor) Register the given ElementlistProcessor for the given method
void	registerListProcessor(ListProcessor processor) Register the given ListProcessor
void	registerProductListProcessor(ProductListProcessor processor) Register the given ProductListProcessor for the given method
void	setCallProcessors(Collection<CallProcessor> processors)
void	setDone(int id, int status, Date starttime, Date endtime, int exitValue) Reports the end of the execution of an AutoCometJob
void	setElementlistProcessors(Collection<ElementlistProcessor> processors)
void	setListProcessors(Collection<ListProcessor> processors)
void	setProductListProcessors(Collection<ProductListProcessor> processors)
void	setStart(int id, Date starttime, int status) Reports the execution start of an AutoCometJob
void	setStatus(int id, int status) Sets the current status of an AutoCometJob

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPublicationController

public DefaultPublicationController()

Method Detail

getProductList

public CometProduct[] getProductList(Map<String,CometCondition> parameters)
                              throws CometException

Returns an Array of list entries that will be displayed in the Comet product tree.

Specified by:

getProductList in interface PublicationController

Parameters:

parameters - The search/request conditions

Returns:

An Array of list entries that will be displayed in the Comet product tree.

Throws:

CometException

getListProcessor

public ListProcessor getListProcessor(String method)
                               throws UnknownProcessorException

Description copied from interface: PublicationController

Returns the ListProcessor that is registered for the given method

Specified by:

getListProcessor in interface PublicationController

Parameters:

method - The name of the method for which to get an IListProcessor

Returns:

The related IListProcessor

Throws:

UnknownProcessorException

getElementListProcessor

public ElementlistProcessor getElementListProcessor(String method)
                                             throws UnknownProcessorException

Description copied from interface: PublicationController

Returns the ElementlistProcessor that is registered for the given method

Specified by:

getElementListProcessor in interface PublicationController

Parameters:

method - The name of the method for which to get an IElementlistProcessor

Returns:

The related IElementlistProcessor

Throws:

UnknownProcessorException

getCometCallProcessor

public CallProcessor getCometCallProcessor(String method)
                                    throws UnknownProcessorException

Description copied from interface: PublicationController

Returns the CallProcessor that is registered for the given method

Specified by:

getCometCallProcessor in interface PublicationController

Parameters:

method - The name of the method for which to get an ICallProcessor

Returns:

The related ICallProcessor

Throws:

UnknownProcessorException

getProductListProcessor

public ProductListProcessor getProductListProcessor(String method)
                                             throws UnknownProcessorException

Throws:

UnknownProcessorException

getBinaryFile

public CometBinary getBinaryFile(String fileId)
                          throws CometException

Description copied from interface: PublicationController

Returns a media that contains the requested file

Specified by:

getBinaryFile in interface PublicationController

Parameters:

fileId - The file name for which to get the content

Returns:

The content of the requested file

Throws:

CometException - If an error occurs while getting the file

putBinaryFile

public void putBinaryFile(String fileId,
                          CometBinary file)
                   throws CometException

Description copied from interface: PublicationController

Stores the content of the given file

Specified by:

putBinaryFile in interface PublicationController

Parameters:

fileId - The filename of related content

file - The content that shall be stored

Throws:

CometException - If an error occurs while storing the file

getMessage

public String getMessage(int messageCode)

Returns a (localized) error message for the given error code

Specified by:

getMessage in interface PublicationController

Parameters:

messageCode - The error code for which to get the respective message

Returns:

The (localized) error message for the given error code

setCallProcessors

public void setCallProcessors(Collection<CallProcessor> processors)

Specified by:

setCallProcessors in interface PublicationController

setElementlistProcessors

public void setElementlistProcessors(Collection<ElementlistProcessor> processors)

Specified by:

setElementlistProcessors in interface PublicationController

setListProcessors

public void setListProcessors(Collection<ListProcessor> processors)

Specified by:

setListProcessors in interface PublicationController

setProductListProcessors

public void setProductListProcessors(Collection<ProductListProcessor> processors)

Specified by:

setProductListProcessors in interface PublicationController

registerCallProcessor

public void registerCallProcessor(CallProcessor processor)
                           throws JaloInvalidParameterException

Adds the given CallProcessor

Throws:

JaloInvalidParameterException - If an error occurs while registering the CallProcessor

registerListProcessor

public void registerListProcessor(ListProcessor processor)
                           throws JaloInvalidParameterException

Register the given ListProcessor

Throws:

JaloInvalidParameterException - If an error occurs while registering the IListProcessor

registerElementlistProcessor

public void registerElementlistProcessor(ElementlistProcessor processor)
                                  throws JaloInvalidParameterException

Register the given ElementlistProcessor for the given method

Throws:

JaloInvalidParameterException - If an error occurs while registering the IElementlistProcessor

registerProductListProcessor

public void registerProductListProcessor(ProductListProcessor processor)
                                  throws JaloInvalidParameterException

Register the given ProductListProcessor for the given method

Parameters:

processor - The ProductListProcessor that is able to process requests of the specified method.

Throws:

JaloInvalidParameterException - If an error occurs while registering the ProductListProcessor

getNextHotfolder

public void getNextHotfolder(String program,
                             int status,
                             int id)
                      throws CometException

Description copied from interface: PublicationController

Returns the next hotfolder that AutoComet shall observe for AutoCometJobs

Specified by:

getNextHotfolder in interface PublicationController

Parameters:

program - Unused (TODO: what is this?)

status - Unused (TODO: what is this?)

id - Unused (TODO: what is this?)

Throws:

CometException - If an error occurs while getting the next hot folder

getNextJob

public AutoCometJob getNextJob(String program,
                               int status)

Description copied from interface: PublicationController

Returns the next AutoCometJob

Specified by:

getNextJob in interface PublicationController

Parameters:

program - Unused (TODO: what is this?)

status - Unused (TODO: what is this?)

Returns:

The next AutoCometJob

setStart

public void setStart(int id,
                     Date starttime,
                     int status)
              throws CometException

Description copied from interface: PublicationController

Reports the execution start of an AutoCometJob

Specified by:

setStart in interface PublicationController

Parameters:

id - The ID of the AutoCometJob that's execution has started

starttime - The time, when the execution has started

status - The AutoCometJob's current status

Throws:

CometException - If an error occurs while starting an AutoCometJob

setStatus

public void setStatus(int id,
                      int status)
               throws CometException

Description copied from interface: PublicationController

Sets the current status of an AutoCometJob

Specified by:

setStatus in interface PublicationController

Parameters:

id - The ID of the AutoCometJob that's status becomes reported

status - The AutoCometJob's current status

Throws:

CometException - If an error occurs while setting the status to an AutoCometJob

setDone

public void setDone(int id,
                    int status,
                    Date starttime,
                    Date endtime,
                    int exitValue)
             throws CometException

Description copied from interface: PublicationController

Reports the end of the execution of an AutoCometJob

Specified by:

setDone in interface PublicationController

Parameters:

id - The ID of the AutoCometJob that's execution has ended

status - The AutoCometJob's current status

starttime - The time, when the execution has started

endtime - The time, when the execution has ended

exitValue - The result code

Throws:

CometException - If an error occurs while finalize an AutoCometJob

hasSubItems

public static boolean hasSubItems(Item item)
                           throws InvalidParameterException

Throws:

InvalidParameterException

hasSubItems

public static boolean hasSubItems(SessionContext ctx,
                                  Item item)
                           throws InvalidParameterException

Verifies if the given item has sub ordinated items

Parameters:

ctx - The SessionContext

item - The item for which to search for sub ordinated items

Returns:

TRUE if this item has sub ordinated items

Throws:

InvalidParameterException - If item is unspecified