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

Class AbstractDataFeedPublicationConfiguration

java.lang.Object

com.broadleafcommerce.datafeed.service.publisher.configuration.AbstractDataFeedPublicationConfiguration

All Implemented Interfaces:

DataFeedPublicationConfiguration

Direct Known Subclasses:

CommerceManagerFeedAPIPublicationConfiguration, MerchantCenterSFTPPublicationConfiguration

public abstract class AbstractDataFeedPublicationConfiguration
extends Object
implements DataFeedPublicationConfiguration

A commonly useful base starting point for implementations of DataFeedPublicationConfiguration.

See Also:

• AbstractDataFeedPublicationConfigurationProperties

Constructor Summary

Constructors

Constructor	Description
AbstractDataFeedPublicationConfiguration()

Method Summary

Modifier and Type	Method	Description
protected List<Locale>	convertToLocales(List<String> localeLanguageTags)	Builds a list of Locale from the given localeLanguageTags.
String	getApplicationIdHint()	Identifies the application that this configuration is for.
String	getDisplayName()	A user-friendly display name for this configuration.
String	getFeedProcessType()	Should contain a value from DefaultDataFeedProcessTypes describing what type of data feed process this configuration is for.
String	getId()	The unique identifier of this feed publication configuration in BLC.
List<Locale>	getIncludedLocales()	This is a common (but not required) element in many implementations.
String	getTenantIdHint()	Identifies the tenant that this configuration is for.
void	initializeFromProperties(AbstractDataFeedPublicationConfigurationProperties properties)	Helpful method to quickly initialize basic properties from AbstractDataFeedPublicationConfigurationProperties, if using such a setup.
void	setApplicationIdHint(String applicationIdHint)
void	setDisplayName(String displayName)
void	setFeedProcessType(String feedProcessType)
void	setId(String id)
void	setIncludedLocales(List<Locale> includedLocales)	This is a common (but not required) element in many implementations.
void	setTenantIdHint(String tenantIdHint)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractDataFeedPublicationConfiguration

public AbstractDataFeedPublicationConfiguration()

Method Details

initializeFromProperties

public void initializeFromProperties(AbstractDataFeedPublicationConfigurationProperties properties)

Helpful method to quickly initialize basic properties from AbstractDataFeedPublicationConfigurationProperties, if using such a setup.

Parameters:

properties - the source instance to initialize from

Throws:

IllegalArgumentException - if there was an error with the input properties

convertToLocales

@Nullable
protected List<Locale> convertToLocales(@Nullable
 List<String> localeLanguageTags)

Builds a list of Locale from the given localeLanguageTags.

Parameters:

localeLanguageTags - a list of valid locales in IETF BCP 47 language tag format

Returns:

a list of Locale instances, or null if the input was null

Throws:

IllegalArgumentException - if there was an error processing the input tags

setId

public void setId(String id)

See Also:

• DataFeedPublicationConfiguration.getId()

setDisplayName

public void setDisplayName(String displayName)

See Also:

• DataFeedPublicationConfiguration.getDisplayName()

setTenantIdHint

public void setTenantIdHint(String tenantIdHint)

See Also:

• DataFeedPublicationConfiguration.getTenantIdHint()

setApplicationIdHint

public void setApplicationIdHint(String applicationIdHint)

See Also:

• DataFeedPublicationConfiguration.getApplicationIdHint()

setFeedProcessType

public void setFeedProcessType(String feedProcessType)

See Also:

• DataFeedPublicationConfiguration.getFeedProcessType()

setIncludedLocales

public void setIncludedLocales(@Nullable
 List<Locale> includedLocales)

This is a common (but not required) element in many implementations. This should be a list of locales whose data should be included in the feed. This can influence which data is included and how it is transformed.

getId

public String getId()

Description copied from interface: DataFeedPublicationConfiguration

The unique identifier of this feed publication configuration in BLC. This will be used to associate feed processes with a configuration.

Specified by:

getId in interface DataFeedPublicationConfiguration

Returns:

the unique identifier for this specific publication configuration in BLC

See Also:

• DataFeedPublicationConfiguration.getId()

getDisplayName

public String getDisplayName()

Description copied from interface: DataFeedPublicationConfiguration

A user-friendly display name for this configuration. Useful for helping admin users see what the configuration is for.

Specified by:

getDisplayName in interface DataFeedPublicationConfiguration

Returns:

a user-friendly display name for this configuration

See Also:

• DataFeedPublicationConfiguration.getDisplayName()

getTenantIdHint

public String getTenantIdHint()

Description copied from interface: DataFeedPublicationConfiguration

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.

Specified by:

getTenantIdHint in interface DataFeedPublicationConfiguration

Returns:

the tenant ID that this configuration is for

See Also:

• DataFeedPublicationConfiguration.getTenantIdHint()

getApplicationIdHint

public String getApplicationIdHint()

Description copied from interface: DataFeedPublicationConfiguration

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.

Specified by:

getApplicationIdHint in interface DataFeedPublicationConfiguration

Returns:

the application ID that this configuration is for

See Also:

• DataFeedPublicationConfiguration.getApplicationIdHint()

getFeedProcessType

public String getFeedProcessType()

Description copied from interface: DataFeedPublicationConfiguration

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.

Specified by:

getFeedProcessType in interface DataFeedPublicationConfiguration

Returns:

the type of data feed process this configuration is for

See Also:

• DataFeedPublicationConfiguration.getFeedProcessType()

getIncludedLocales

@Nullable
public List<Locale> getIncludedLocales()

This is a common (but not required) element in many implementations. This should be a list of locales whose data should be included in the feed. This can influence which data is included and how it is transformed.