org.conqat.engine.service.findings.FindingBlacklistRequestBody Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of teamscale-commons Show documentation

Provides common DTOs for Teamscale

There is a newer version: 2025.1.0-rc2

package org.conqat.engine.service.findings;

import java.util.List;

import org.checkerframework.checker.nullness.qual.Nullable;
import org.conqat.engine.service.shared.data.FindingBlacklistInfo;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Class encapsulating the body content of the request to mark findings as
 * tolerated/false-positive.
 * 
 * This class is used as DTO during communication with IDE clients via
 * {@link com.teamscale.ide.commons.client.IIdeServiceClient}, special care has
 * to be taken when changing its signature!
 */
public class FindingBlacklistRequestBody {
	private static final String BLACKLIST_INFO_PROPERTY_NAME = "blacklistInfo";
	private static final String FINDING_ID_LIST_PROPERTY_NAME = "findingIds";

	@JsonProperty(BLACKLIST_INFO_PROPERTY_NAME)
	@Nullable
	private final FindingBlacklistInfo blacklistInfo;

	@JsonProperty(FINDING_ID_LIST_PROPERTY_NAME)
	private List findingIds;

	@JsonCreator
	public FindingBlacklistRequestBody(@JsonProperty(BLACKLIST_INFO_PROPERTY_NAME) FindingBlacklistInfo blacklistInfo,
			@JsonProperty(FINDING_ID_LIST_PROPERTY_NAME) List findingIds) {
		this.blacklistInfo = blacklistInfo;
		this.findingIds = findingIds;
	}

	/** @see #blacklistInfo */
	@Nullable
	public FindingBlacklistInfo getBlacklistInfo() {
		return blacklistInfo;
	}

	/** @see #findingIds */
	public List getFindingIds() {
		return findingIds;
	}
}