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

Class DataFeedPublicationConfigurationService

java.lang.Object

com.broadleafcommerce.datafeed.service.publisher.configuration.DataFeedPublicationConfigurationService

public class DataFeedPublicationConfigurationService
extends Object

This is a centralized service component that provides access to DataFeedPublicationConfiguration instances.

Constructor Summary

Constructors

Constructor	Description
DataFeedPublicationConfigurationService(List<DataFeedPublicationConfigurationContributor> configurationContributors)

Method Summary

Modifier and Type	Method	Description
List<DataFeedPublicationConfiguration>	getAllByFeedProcessTypeWithContextFiltration(@NonNull String feedProcessType, @NonNull String tenantId, @NonNull String applicationId)	Fetches the DataFeedPublicationConfiguration matching the given DataFeedPublicationConfiguration.getFeedProcessType() and filters out the result if it does not exactly match the provided context.
Optional<DataFeedPublicationConfiguration>	getById(String dataFeedPublicationConfigurationId)	Fetches the DataFeedPublicationConfiguration matching the given DataFeedPublicationConfiguration.getId().
Optional<DataFeedPublicationConfiguration>	getByIdWithContextFiltration(@NonNull String dataFeedPublicationConfigurationId, @NonNull String tenantId)	Similar to getById(String), but filters out the result if it does not exactly match the provided context.
Optional<DataFeedPublicationConfiguration>	getByIdWithContextFiltration(String dataFeedPublicationConfigurationId, @NonNull String tenantId, @NonNull String applicationId)	Similar to getById(String), but filters out the result if it does not exactly match the provided context.
protected Map<String,DataFeedPublicationConfiguration>	getPublicationConfigurationsById()	An immutable map of DataFeedPublicationConfiguration by DataFeedPublicationConfiguration.getId().
protected void	processConfigurationFromContributor(DataFeedPublicationConfiguration configurationFromContributor, Map<String,DataFeedPublicationConfiguration> targetMap)	Validates the given DataFeedPublicationConfiguration and adds it to the targetMap if valid.
protected Map<String,DataFeedPublicationConfiguration>	processContributors(List<DataFeedPublicationConfigurationContributor> configurationContributors)	Invokes any given DataFeedPublicationConfigurationContributor components and validates + loads their contributed DataFeedPublicationConfiguration instances into a map by their IDs.
protected List<String>	validateContributedConfiguration(DataFeedPublicationConfiguration configuration)	Validates the given DataFeedPublicationConfiguration and returns error(s) if any were encountered.

Methods inherited from class java.lang.Object

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

Constructor Details

DataFeedPublicationConfigurationService

public DataFeedPublicationConfigurationService(@Nullable
 List<DataFeedPublicationConfigurationContributor> configurationContributors)

Method Details

processContributors

protected Map<String,DataFeedPublicationConfiguration> processContributors(@Nullable
 List<DataFeedPublicationConfigurationContributor> configurationContributors)

Invokes any given DataFeedPublicationConfigurationContributor components and validates + loads their contributed DataFeedPublicationConfiguration instances into a map by their IDs.

Parameters:

configurationContributors - contributors from which to get DataFeedPublicationConfiguration instances

Returns:

a map of DataFeedPublicationConfiguration instances by ID

processConfigurationFromContributor

protected void processConfigurationFromContributor(DataFeedPublicationConfiguration configurationFromContributor,
 Map<String,DataFeedPublicationConfiguration> targetMap)

Validates the given DataFeedPublicationConfiguration and adds it to the targetMap if valid.

Parameters:

configurationFromContributor - the configuration to process

targetMap - the map to add the configuration to (by id) if validations pass

validateContributedConfiguration

protected List<String> validateContributedConfiguration(DataFeedPublicationConfiguration configuration)

Validates the given DataFeedPublicationConfiguration and returns error(s) if any were encountered.

Parameters:

configuration - the configuration to validate

Returns:

empty list if no errors were found, else a list containing validation errors

getById

public Optional<DataFeedPublicationConfiguration> getById(String dataFeedPublicationConfigurationId)

Fetches the DataFeedPublicationConfiguration matching the given DataFeedPublicationConfiguration.getId().

This method does not perform any context-based filtration on fields such as DataFeedPublicationConfiguration.getApplicationIdHint() or DataFeedPublicationConfiguration.getTenantIdHint().

Parameters:

dataFeedPublicationConfigurationId - the ID of the configuration to fetch

Returns:

an Optional containing the configuration matching the given ID if found, Optional.empty() otherwise

See Also:

• getByIdWithContextFiltration(String, String, String)

getByIdWithContextFiltration

public Optional<DataFeedPublicationConfiguration> getByIdWithContextFiltration(String dataFeedPublicationConfigurationId,
 @NonNull
 @NonNull String tenantId,
 @NonNull
 @NonNull String applicationId)

Similar to getById(String), but filters out the result if it does not exactly match the provided context.

Parameters:

dataFeedPublicationConfigurationId - the ID of the configuration to fetch

tenantId - the tenant ID to match against DataFeedPublicationConfiguration.getTenantIdHint()

applicationId - the application ID to match against DataFeedPublicationConfiguration.getApplicationIdHint()

Returns:

an Optional containing the configuration matching the given ID if found, Optional.empty() otherwise

See Also:

• getById(String)

getAllByFeedProcessTypeWithContextFiltration

public List<DataFeedPublicationConfiguration> getAllByFeedProcessTypeWithContextFiltration(@NonNull
 @NonNull String feedProcessType,
 @NonNull
 @NonNull String tenantId,
 @NonNull
 @NonNull String applicationId)

Fetches the DataFeedPublicationConfiguration matching the given DataFeedPublicationConfiguration.getFeedProcessType() and filters out the result if it does not exactly match the provided context.

Parameters:

feedProcessType - the process type

tenantId - the tenant ID to match against DataFeedPublicationConfiguration.getTenantIdHint()

applicationId - the application ID to match against DataFeedPublicationConfiguration.getApplicationIdHint()

Returns:

an Optional containing the configuration matching the given process type if found, Optional.empty() otherwise

getByIdWithContextFiltration

public Optional<DataFeedPublicationConfiguration> getByIdWithContextFiltration(@NonNull
 @NonNull String dataFeedPublicationConfigurationId,
 @NonNull
 @NonNull String tenantId)

Similar to getById(String), but filters out the result if it does not exactly match the provided context.

Parameters:

dataFeedPublicationConfigurationId - the ID of the configuration to fetch

tenantId - the tenant ID to match against DataFeedPublicationConfiguration.getTenantIdHint()

Returns:

an Optional containing the configuration matching the given ID if found, Optional.empty() otherwise

getPublicationConfigurationsById

protected Map<String,DataFeedPublicationConfiguration> getPublicationConfigurationsById()

An immutable map of DataFeedPublicationConfiguration by DataFeedPublicationConfiguration.getId().