com.atlassian.bitbucket.idx

Interface CommitPropertyConfiguration

public interface CommitPropertyConfiguration

Property configuration for any commit indexer.

Method Summary

Modifier and Type	Method and Description
Collection<String>	getPropertiesToPreload(com.atlassian.bitbucket.repository.Repository repository)
default Map<String,Map<String,Object>>	processProperties(Map<String,Map<String,Object>> commitIdToProperties) Go through the provided commitIdToProperties and process each of the commit ID's properties that are supplied.

Method Detail

getPropertiesToPreload

@Nonnull
Collection<String> getPropertiesToPreload(com.atlassian.bitbucket.repository.Repository repository)

Parameters:

repository - the repository

Returns:

a collection of property keys to preload on every commit request. Properties can be loaded on demand via rest using the expand query string. They can also be fetched programatically via the CommitIndex

processProperties

@Nonnull
default Map<String,Map<String,Object>> processProperties(@Nonnull
                                                                  Map<String,Map<String,Object>> commitIdToProperties)

Go through the provided commitIdToProperties and process each of the commit ID's properties that are supplied. The processing on the properties is done to match the desired representation of the properties for consumption. Our processing of these commit ID's properties is performed this way for efficiency reasons and to not have to call this method for each commit that needs to have its properties processed.

Parameters:

commitIdToProperties - the commit IDs along with their respective properties

Returns:

the processed properties

Since:

8.13.1