Package com.broadleafcommerce.datafeed.service.publisher.file.submitter

Interface DataFeedFileSubmitter

All Superinterfaces:

org.springframework.core.Ordered

All Known Implementing Classes:

AbstractSFTPSubmitter, CommerceManagerFeedAPISubmitter, MerchantCenterSFTPSubmitter

public interface DataFeedFileSubmitter
extends org.springframework.core.Ordered

By default, AbstractFileFeedPublisher implementations will inject and delegate to components of this type.

Capable of taking a source data file (ex: AbstractFileFeedPublisher.FilePublishContext.getLocalOutputFile()) and submitting it to a destination.

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(DataFeedPublishRequestDetails requestDetails)	Reports whether this component can handle processing a file submission for the given DataFeedPublishRequestDetails.
default int	getOrder()
DataFeedFileSubmitResponseDetails	submit(AbstractFileFeedPublisher.FilePublishContext filePublishContext)	Submits AbstractFileFeedPublisher.FilePublishContext.getLocalOutputFile() to the appropriate destination.

Method Details

canHandle

boolean canHandle(DataFeedPublishRequestDetails requestDetails)

Reports whether this component can handle processing a file submission for the given DataFeedPublishRequestDetails.

Parameters:

requestDetails - request details around the publish process

Returns:

true if this component can handle the submission for the given file, false otherwise

submit

DataFeedFileSubmitResponseDetails submit(AbstractFileFeedPublisher.FilePublishContext filePublishContext)

Submits AbstractFileFeedPublisher.FilePublishContext.getLocalOutputFile() to the appropriate destination.

Parameters:

filePublishContext - details around the file publish process

Returns:

details about the success/failure of the operation

getOrder

default int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered