Package com.broadleafcommerce.datafeed.service.publisher.configuration

Interface DataFeedPublicationConfiguration

All Known Implementing Classes:
AbstractDataFeedPublicationConfiguration, CommerceManagerFeedAPIPublicationConfiguration, MerchantCenterSFTPPublicationConfiguration
public interface DataFeedPublicationConfiguration
To publish data to a particular data feed (regardless of the provider), there are unique secret values (ex: API keys) and configuration that are required but cannot be persisted in a datastore. These need to be managed separately via application properties and environment variables by system administrators, and thus cannot be directly part of the admin-user configured/persisted DataFeedProcess entity.

This represents a non-persisted, identifiable abstraction of an individual data feed publication configuration. DataFeedProcess can subsequently reference specific configurations that will be included in its flow. The knowledge of how to use a particular DataFeedPublicationConfiguration requires a compatible DataFeedPublisher implementation.

It is important to note that despite the name, this is not related in any way to the Spring Configuration concept.

See Also:

  • Method Details

    • getId

      String getId()
      The unique identifier of this feed publication configuration in BLC. This will be used to associate feed processes with a configuration.
      Returns:
      the unique identifier for this specific publication configuration in BLC
      See Also:

    • getDisplayName

      String getDisplayName()
      A user-friendly display name for this configuration. Useful for helping admin users see what the configuration is for.
      Returns:
      a user-friendly display name for this configuration

    • getTenantIdHint

      String getTenantIdHint()
      Identifies the tenant that this configuration is for. Useful for preventing cross-tenant usage of a configuration.

      When creating a DataFeedProcess, the value of its tenant ID must match this value in order for this configuration to be used.

      Returns:
      the tenant ID that this configuration is for

    • getApplicationIdHint

      String getApplicationIdHint()
      Identifies the application that this configuration is for. Useful for preventing cross-application usage of a configuration.

      When creating a DataFeedProcess, the value of DataFeedProcess.getApplicationId() must match this value in order for this configuration to be used.

      Returns:
      the application ID that this configuration is for

    • getFeedProcessType

      String getFeedProcessType()
      Should contain a value from DefaultDataFeedProcessTypes describing what type of data feed process this configuration is for.

      When creating a DataFeedProcess, the value of DataFeedProcess.getProcessType() must match this value in order for this configuration to be used.

      Returns:
      the type of data feed process this configuration is for