Package com.almworks.jira.structure.api.settings

Interface AttributeSensitivitySettings

All Known Implementing Classes:

ImmutableAttributeSensitivitySettingsBean

public interface AttributeSensitivitySettings

Attribute sensitivity settings govern which attributes will be considered sensitive when calculating a multi-row aggregate value (by an aggregate, a propagate, or a scanning loader). This plays a role when a user does not have view access to some of the items in the forest, yet they look at a total or some other aggregate value.

As an example let's consider aggregate attribute Total Story Points, calculating over a folder, which contains issues X, Y, and Z. The current user does not have access to Z, so they only see the folder, X, and Y.

If the aggregated attribute - Story Points - is sensitive, then the value for the folder will be calculated only over those issues that the user can actually observe, in this case, X and Y. Another user, who has access to all issues, will see a total of X, Y, and Z - potentially a different number.

If the aggregated attribute is non-sensitive, the total for the folder will show the same number for all users, even if they don't have access to some of the sub-items. Note that the inaccessible item is not disclosed to the user in any case.

These settings allow Jira admins to set the default mode (see getSensitivityMode()) and exceptions (see getNonSensitiveAttributes()).

See Also:

• StructureConfiguration.getAttributeSensitivitySettings()
• StructureConfiguration.setAttributeSensitivitySettings(com.almworks.jira.structure.api.settings.AttributeSensitivitySettings)
• ImmutableAttributeSensitivitySettingsBean

Method Summary

Modifier and Type	Method	Description
Set<AttributeSpec<?>>	getNonSensitiveAttributes()	Returns attributes that were explicitly set to be non-sensitive, regardless of the default mode.
AttributeSensitivityMode	getSensitivityMode()	Returns the default sensitivity mode.

Method Details

getSensitivityMode

@NotNull
AttributeSensitivityMode getSensitivityMode()

Returns the default sensitivity mode.

Returns:

sensitivity mode

getNonSensitiveAttributes

@NotNull
Set<AttributeSpec<?>> getNonSensitiveAttributes()

Returns attributes that were explicitly set to be non-sensitive, regardless of the default mode.

Note that if the mode is AttributeSensitivityMode.PERMISSIVE, this method may still return some attributes, although that will not have any additional effect - everything is non-sensitive by mode.

Returns:

a list of attributes set to be non-sensitive