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

Class AbstractSFTPSubmitter

java.lang.Object

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

All Implemented Interfaces:

DataFeedFileSubmitter, org.springframework.core.Ordered

Direct Known Subclasses:

MerchantCenterSFTPSubmitter

public abstract class AbstractSFTPSubmitter
extends Object
implements DataFeedFileSubmitter

Common starting point for DataFeedFileSubmitter implementations that need to use SFTP.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractSFTPSubmitter.SFTPUploadConfiguration	Bundle of details required to set up an SFTP upload request.

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AbstractSFTPSubmitter(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected DataFeedFileSubmitResponseDetails	buildFailedResponse(List<String> errors)
protected abstract AbstractSFTPSubmitter.SFTPUploadConfiguration	buildSftpConfiguration(AbstractFileFeedPublisher.FilePublishContext filePublishContext)	Build a valid AbstractSFTPSubmitter.SFTPUploadConfiguration from the AbstractFileFeedPublisher.FilePublishContext.
protected DataFeedFileSubmitResponseDetails	buildSuccessfulResponse()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	initializeSSHClient(net.schmizz.sshj.SSHClient sshClient, AbstractSFTPSubmitter.SFTPUploadConfiguration sftpUploadConfiguration, AbstractFileFeedPublisher.FilePublishContext filePublishContext)
DataFeedFileSubmitResponseDetails	submit(AbstractFileFeedPublisher.FilePublishContext filePublishContext)	Reference: SSHJ SFTP upload example

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.datafeed.service.publisher.file.submitter.DataFeedFileSubmitter

canHandle, getOrder

Constructor Details

AbstractSFTPSubmitter

public AbstractSFTPSubmitter(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

submit

public DataFeedFileSubmitResponseDetails submit(AbstractFileFeedPublisher.FilePublishContext filePublishContext)

Reference: SSHJ SFTP upload example

Specified by:

submit in interface DataFeedFileSubmitter

Parameters:

filePublishContext - details around the file publish process

Returns:

details about the success/failure of the operation

initializeSSHClient

protected void initializeSSHClient(net.schmizz.sshj.SSHClient sshClient,
 AbstractSFTPSubmitter.SFTPUploadConfiguration sftpUploadConfiguration,
 AbstractFileFeedPublisher.FilePublishContext filePublishContext)

buildFailedResponse

protected DataFeedFileSubmitResponseDetails buildFailedResponse(List<String> errors)

buildSuccessfulResponse

protected DataFeedFileSubmitResponseDetails buildSuccessfulResponse()

buildSftpConfiguration

protected abstract AbstractSFTPSubmitter.SFTPUploadConfiguration buildSftpConfiguration(AbstractFileFeedPublisher.FilePublishContext filePublishContext)

Build a valid AbstractSFTPSubmitter.SFTPUploadConfiguration from the AbstractFileFeedPublisher.FilePublishContext.

Parameters:

filePublishContext - details around the file publish context

Returns:

a AbstractSFTPSubmitter.SFTPUploadConfiguration describing the SFTP upload that needs to be made

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()