com.atlassian.jira.util

Class AccessDisablingHelperConfig.EndpointDisablingConfigBuilder

java.lang.Object

com.atlassian.jira.util.AccessDisablingHelperConfig.EndpointDisablingConfigBuilder

Enclosing class:

AccessDisablingHelperConfig

public static class AccessDisablingHelperConfig.EndpointDisablingConfigBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
AccessDisablingHelperConfig.EndpointDisablingConfigBuilder	blockAccessSinceVersion(String blockAccessSince)
AccessDisablingHelperConfig.EndpointDisablingConfigBuilder	blockAnonymous(boolean blockAnonymous)
AccessDisablingHelperConfig.EndpointDisablingConfigBuilder	blockAnyoneNotFulfillingCondition(Predicate<ApplicationUser> condition)
AccessDisablingHelperConfig.EndpointDisablingConfigBuilder	blockForAnyoneWithoutPermission(GlobalPermissionKey permissionKey)
AccessDisablingHelperConfig	build() Validate settings and builds new config object
AccessDisablingHelperConfig.EndpointDisablingConfigBuilder	featureFlag(String featureFlag)
AccessDisablingHelperConfig.EndpointDisablingConfigBuilder	logDeprecatedSinceVersion(String logDeprecatedSince)

Methods inherited from class java.lang.Object

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

Method Detail

featureFlag

public AccessDisablingHelperConfig.EndpointDisablingConfigBuilder featureFlag(String featureFlag)

Parameters:

featureFlag - name of feature flag used to disabled/enable restrictions

blockAccessSinceVersion

public AccessDisablingHelperConfig.EndpointDisablingConfigBuilder blockAccessSinceVersion(String blockAccessSince)

Parameters:

blockAccessSince - Jira version for which feature flag will switch from opt-in to opt-out. set to null (or don't set at all) to never switch feature flag from opt-in

logDeprecatedSinceVersion

public AccessDisablingHelperConfig.EndpointDisablingConfigBuilder logDeprecatedSinceVersion(String logDeprecatedSince)

Parameters:

logDeprecatedSince - Jira version for which helper will print debug log about deprecation of feature flag

blockAnonymous

public AccessDisablingHelperConfig.EndpointDisablingConfigBuilder blockAnonymous(boolean blockAnonymous)

Parameters:

blockAnonymous - if set to true blocks access for anonymous users. false disables this check

blockForAnyoneWithoutPermission

public AccessDisablingHelperConfig.EndpointDisablingConfigBuilder blockForAnyoneWithoutPermission(GlobalPermissionKey permissionKey)

Parameters:

permissionKey - GlobalPermissionKey which is necessary to access endpoint. Users without this permission don't have access to protected endpoint. if set to null then check is disabled.

blockAnyoneNotFulfillingCondition

public AccessDisablingHelperConfig.EndpointDisablingConfigBuilder blockAnyoneNotFulfillingCondition(Predicate<ApplicationUser> condition)

Parameters:

condition - a function that returns true if user should have access to resource.

build

public AccessDisablingHelperConfig build()

Validate settings and builds new config object

Returns:

immutable configuration

Throws:

IllegalStateException - when settings are incorrect