Package com.atlassian.jira.bc.safeguards.issue.comment

Class DefaultCommentsPerIssueLimitValidator

java.lang.Object

com.atlassian.jira.bc.safeguards.issue.comment.DefaultCommentsPerIssueLimitValidator

All Implemented Interfaces:

CommentsPerIssueLimitValidator, SafeguardValidator<CommentsPerIssueValidationRequest>

public class DefaultCommentsPerIssueLimitValidator
extends Object
implements CommentsPerIssueLimitValidator

Default implementation of CommentsPerIssueLimitValidator.

Checks that the target issue contains less comments than configured limit.

Enabled/Disabled by using the feature flag 'com.atlassian.jira.safeguards'

The limit on allowed comments per issue is configured by the Application Property 'jira.safeguards.issue.comments'

Since:

9.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NOT_SPECIFIED_USER

Constructor Summary

Constructors

Constructor

Description

DefaultCommentsPerIssueLimitValidator(CommentSearchManager commentSearchManager, FeatureManager featureManager, JiraAuthenticationContext jiraAuthenticationContext, RestrictedUsersComponent restrictedUsersComponent, SafeguardsManager safeguardsManager, LegacyCommentsPerIssueLimitNotifier legacyNotifier, SafeguardEventHelper notificationHelper, com.atlassian.audit.core.spi.service.IpAddressProvider ipAddressProvider)

Method Summary

Modifier and Type	Method	Description
List<Issue>	getInvalidIssues(List<Issue> issues)	Validates comment limits for all provided issues and returns issues that failed.
long	getLimit()	Returns the configured limit value for this safeguard (or a sentinel value when undefined).
boolean	isEnabled()	Indicates whether the safeguard feature (and specific safeguard) is enabled.
boolean	isValid(CommentsPerIssueValidationRequest request)	Performs validation for the provided request.
void	validate(CommentsPerIssueValidationRequest request)	Validates the request and throws an exception if invalid.

Methods inherited from class java.lang.Object

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

Field Details

NOT_SPECIFIED_USER

public static final String NOT_SPECIFIED_USER

See Also:

• Constant Field Values

Constructor Details

DefaultCommentsPerIssueLimitValidator

public DefaultCommentsPerIssueLimitValidator(CommentSearchManager commentSearchManager,
 FeatureManager featureManager,
 JiraAuthenticationContext jiraAuthenticationContext,
 RestrictedUsersComponent restrictedUsersComponent,
 SafeguardsManager safeguardsManager,
 LegacyCommentsPerIssueLimitNotifier legacyNotifier,
 SafeguardEventHelper notificationHelper,
 com.atlassian.audit.core.spi.service.IpAddressProvider ipAddressProvider)

Method Details

isValid

public boolean isValid(@Nonnull
 CommentsPerIssueValidationRequest request)

Description copied from interface: SafeguardValidator

Performs validation for the provided request. Implementations may also perform side effects like logging/notification when appropriate.

Specified by:

isValid in interface SafeguardValidator<CommentsPerIssueValidationRequest>

Returns:

true if valid (i.e., operation should be allowed)

validate

public void validate(@Nonnull
 CommentsPerIssueValidationRequest request)
              throws CommentsPerIssueLimitExceededException

Description copied from interface: CommentsPerIssueLimitValidator

Validates the request and throws an exception if invalid.

Specified by:

validate in interface CommentsPerIssueLimitValidator

Throws:

CommentsPerIssueLimitExceededException

getLimit

public long getLimit()

Description copied from interface: CommentsPerIssueLimitValidator

Returns the configured limit value for this safeguard (or a sentinel value when undefined).

Specified by:

getLimit in interface CommentsPerIssueLimitValidator

isEnabled

public boolean isEnabled()

Description copied from interface: SafeguardValidator

Indicates whether the safeguard feature (and specific safeguard) is enabled.

Specified by:

isEnabled in interface SafeguardValidator<CommentsPerIssueValidationRequest>

getInvalidIssues

@Nonnull
public List<Issue> getInvalidIssues(@Nonnull
 List<Issue> issues)

Description copied from interface: CommentsPerIssueLimitValidator

Validates comment limits for all provided issues and returns issues that failed. This method is a recommended way to validate a collection of issues due to performance optimizations. This method doesn't trigger any notification or logging.

Specified by:

getInvalidIssues in interface CommentsPerIssueLimitValidator

Parameters:

issues - list of issues

Returns:

list of issues for which validation failed