com.atlassian.jira.plugin.jql.function

Interface ClauseSanitisingJqlFunction

All Known Implementing Classes:

AbstractVersionsFunction, AllReleasedVersionsFunction, AllUnreleasedVersionsFunction, EarliestUnreleasedVersionFunction, LatestReleasedVersionFunction, LinkedIssuesFunction

@PublicSpi
public interface ClauseSanitisingJqlFunction

An additional interface which can be implemented by JqlFunction classes in order to indicate to the JqlOperandResolver that their arguments are able to be sanitised if necessary.

This was not added to the JqlFunction interface as the default behaviour is not to care about sanitising, and we didn't want to bloat the plugin point.

Since:

v4.0

See Also:

JqlFunction, JqlOperandResolver.sanitiseFunctionOperand(ApplicationUser, com.atlassian.query.operand.FunctionOperand)

Method Summary

Modifier and Type	Method and Description
FunctionOperand	sanitiseOperand(ApplicationUser searcher, FunctionOperand operand) Sanitise a function operand for the specified user, so that information is not leaked.

Method Detail

sanitiseOperand

@Nonnull
FunctionOperand sanitiseOperand(ApplicationUser searcher,
                                         @Nonnull
                                         FunctionOperand operand)

Sanitise a function operand for the specified user, so that information is not leaked.

Parameters:

searcher - the user performing the search

operand - the operand to sanitise; will only be sanitised if valid

Returns:

the sanitised operand; never null.