net.nemerosa.ontrack.model.buildfilter

Interface BuildFilterService

public interface BuildFilterService

Management of build filters.

Method Summary

Modifier and Type	Method and Description
void	copyToBranch(ID sourceBranchId, ID targetBranchId) Copies all the filters from one branch to another
BuildFilterProviderData<?>	defaultFilterProviderData() Gets the default filter to use when none is defined.
Ack	deleteFilter(ID branchId, java.lang.String name) Deletes a filter for a branch.
java.util.Collection<BuildFilterForm>	getBuildFilterForms(ID branchId) Gets the list of forms to create new filters
<T> BuildFilterProviderData<T>	getBuildFilterProviderData(java.lang.String filterType, com.fasterxml.jackson.databind.JsonNode parameters) Gets a build filter provider for the given type.
<T> BuildFilterProviderData<T>	getBuildFilterProviderData(java.lang.String filterType, T parameters) Gets a build filter provider for the given type.
java.util.Collection<BuildFilterResource<?>>	getBuildFilters(ID branchId) Gets the list of all existing filters.
BuildFilterForm	getEditionForm(ID branchId, java.lang.String name) Gets the form to edit an existing filter.
BuildFilterProviderData<?>	lastPromotedBuildsFilterData() Builds a last promotion filter
Ack	saveFilter(ID branchId, boolean shared, java.lang.String name, java.lang.String type, com.fasterxml.jackson.databind.JsonNode parameters) Saves a filter for a branch.
StandardFilterProviderDataBuilder	standardFilterProviderData(int count) Builds a standard build filter
BuildFilterProviderData<?>	standardFilterProviderData(com.fasterxml.jackson.databind.JsonNode node) Builds a standard build filter given its parameters as a JSON node

Method Detail

defaultFilterProviderData

BuildFilterProviderData<?> defaultFilterProviderData()

Gets the default filter to use when none is defined.

lastPromotedBuildsFilterData

BuildFilterProviderData<?> lastPromotedBuildsFilterData()

Builds a last promotion filter

standardFilterProviderData

StandardFilterProviderDataBuilder standardFilterProviderData(int count)

Builds a standard build filter

standardFilterProviderData

BuildFilterProviderData<?> standardFilterProviderData(com.fasterxml.jackson.databind.JsonNode node)

Builds a standard build filter given its parameters as a JSON node

getBuildFilters

java.util.Collection<BuildFilterResource<?>> getBuildFilters(ID branchId)

Gets the list of all existing filters.

Parameters:

branchId - Branch to get the filters for

Returns:

List of filters

getBuildFilterForms

java.util.Collection<BuildFilterForm> getBuildFilterForms(ID branchId)

Gets the list of forms to create new filters

Parameters:

branchId - Branch to get the forms for

Returns:

List of forms

getBuildFilterProviderData

<T> BuildFilterProviderData<T> getBuildFilterProviderData(java.lang.String filterType,
                                                          com.fasterxml.jackson.databind.JsonNode parameters)

Gets a build filter provider for the given type.

Parameters:

filterType - Qualified type for the filter

parameters - Parameters for the filter

Returns:

Actual filter to use

Throws:

BuildFilterProviderNotFoundException - If the type cannot be resolved

BuildFilterProviderDataParsingException - If the parameters cannot be parsed

getBuildFilterProviderData

<T> BuildFilterProviderData<T> getBuildFilterProviderData(java.lang.String filterType,
                                                          T parameters)

Gets a build filter provider for the given type.

Parameters:

filterType - Qualified type for the filter

parameters - Parameters for the filter

Returns:

Actual filter to use

Throws:

BuildFilterProviderNotFoundException - If the type cannot be resolved

BuildFilterProviderDataParsingException - If the parameters cannot be parsed

getEditionForm

BuildFilterForm getEditionForm(ID branchId,
                               java.lang.String name)
                        throws BuildFilterNotFoundException,
                               BuildFilterNotLoggedException

Gets the form to edit an existing filter.

Parameters:

branchId - Branch to get the form on

name - name of the filter on the branch

Returns:

An edition form

Throws:

BuildFilterNotFoundException - If the filter is not defined

BuildFilterNotLoggedException - If the user is not logged

saveFilter

Ack saveFilter(ID branchId,
               boolean shared,
               java.lang.String name,
               java.lang.String type,
               com.fasterxml.jackson.databind.JsonNode parameters)

Saves a filter for a branch. This method does nothing if the user is not logged, or if the filter type is not found, or if the parameters are not valid.

Parameters:

branchId - Branch to save the filter for

shared - If the filter must be shared in the branch (needs specific authorisation)

name - Name of the filter

type - Type of the filter

parameters - Parameters for the filter

deleteFilter

Ack deleteFilter(ID branchId,
                 java.lang.String name)

Deletes a filter for a branch. This method does nothing if the user is not logged, or if the filter is not found.

Parameters:

branchId - Branch to save the filter for

name - Name of the filter

copyToBranch

void copyToBranch(ID sourceBranchId,
                  ID targetBranchId)

Copies all the filters from one branch to another