Replacing ChannelParameters Spring beans

The ChannelParameters objects are used to describe and construct the message channels. The ChannelParameters contain information about the source file names, file formats, and how they are processed when loading into the datastore.

The ChannelParameters objects are defined as Spring beans and can be customized by adding new beans. These new beans can either create new ChannelParameters or replace existing ones.

The beans are identified by one of three annotations depending on which source they belong to:

For example the “sbmDeltaChannelParameter” bean is defined using:

	@Autowired
	ASensiSourceConfig sensiSourceConfig;

	@SensiSourceConfigChannelParametersBean
    @Qualifier(SP_QUALIFIER__SBM_DELTA_CHANNEL_PARAMETER)
    @ConditionalOnInMemoryDatabase
    public ACSVSourceConfig.ChannelParameters sbmDeltaChannelParameter() {
		return sensiSourceConfig.channelParametersBuilder(SbmDeltaFileConstants.TOPIC_SENSITIVITIES, SADatastoreConfig.SA_SENSITIVITIES_STORE_NAME, FRTBDataLoadConstants.SB_DELTA_SENSITIVITIES_FILE_PATTERN)
		.fileColumns(SbmDeltaFileConstants.ALL_FIELDS)
		.calculators(sensiSourceConfig.createDeltaCalculators())
		.tuplePublisherFactory(sensiSourceConfig::createSbmDeltaTuplePublisher).build();
	}

Replacing existing ChannelParameters beans

To replace an existing ChannelParameters bean, a new bean is created with the same qualifier. The @Primary annotation will ensure that the new bean is created instead of the old one.

It is often useful to use the old ChannelParameters' fields to fill fields which are unchanged by passing the old bean as a parameter of our new ChannelParameter.

For example, to replace the “sbmDeltaChannelParameter” bean above:

    @SensiSourceConfigChannelParametersBean
    @Qualifier(SP_QUALIFIER__SBM_DELTA_CHANNEL_PARAMETER)
    @ConditionalOnInMemoryDatabase
    @Primary
    public ACSVSourceConfig.ChannelParameters customSbmDeltaChannelParameter(ACSVSourceConfig.ChannelParameters sbmDeltaChannelParameter) {
    	return sbmDeltaChannelParameter.toBuilder()
        /* ... */
        .build();
    }

With the existence of this bean, the original bean (sbmDeltaChannelParameter) will not be created.

Creating new ChannelParameters beans

New ChannelParameters can be created and will be picked up automatically. Like the beans defined in ASourceConfig, ASensiSourceConfig, and AConfigurationSourceConfig, these beans should use one of the three annotations above and also provide a qualifier. For example, to load a custom file into a custom store:

	@Autowired
	ASourceConfig sourceConfig;

	@SourceConfigChannelParametersBean
	@Qualifier(SP_QUALIFIER__CUSTOM_STORE_CHANNEL_PARAMETER)
	public ACSVSourceConfig.ChannelParameters customStoreChannelParameter() {
		return sourceConfig.channelParametersBuilder("custom-topic", "custom_store", "custom.file-pattern")
        /* ... */
        .build();
	}

ChannelParameters fields

The ChannelParameters beans contain the following fields:

Available ChannelParameters Qualifiers

Below are all the qualifiers of existing ChannelParameters beans.