com.atlassian.annotations.tenancy

Enum TenancyScope

java.lang.Object

java.lang.Enum<TenancyScope>

com.atlassian.annotations.tenancy.TenancyScope

All Implemented Interfaces:

Serializable, Comparable<TenancyScope>

@Internal
public enum TenancyScope
extends Enum<TenancyScope>

An expression of how a multi-tenanted environment affects the behaviour of the annotated component.

Since:

v0.20

Enum Constant Summary

Enum Constants

Enum Constant and Description
SUPPRESS Explicitly marks that tenancy scope concerns are not relevant for this component and that it should be exempt from static analysis rules.
TENANTED The definition of 'tenanted' is dependent on where it is applied: Methods: Indicates that the method uses data access patterns that require knowledge of the current tenant.
TENANTLESS The definition of 'tenantless' is dependent on where it is applied: Methods: Indicates that the method only accesses data that is universal across all tenants.
UNRESOLVED Explicitly marks that this is a component whose safety in a multi-tenanted environment has not yet been evaluated or that is known to require additional work.

Method Summary

Modifier and Type	Method and Description
static TenancyScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static TenancyScope[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TENANTED

public static final TenancyScope TENANTED

The definition of 'tenanted' is dependent on where it is applied:

• Methods: Indicates that the method uses data access patterns that require knowledge of the current tenant.
• Fields and types: Indicates that the component contains or references tenant specific data (either directly or indirectly).

Both definitions imply that the method or component must only be used within tenant request contexts.

TENANTLESS

public static final TenancyScope TENANTLESS

The definition of 'tenantless' is dependent on where it is applied:

• Methods: Indicates that the method only accesses data that is universal across all tenants. Tenantless methods may be called safely even outside of a tenanted request context. Tenantless methods must avoid calls resulting in tenant specific data access. Calling TENANTED methods from TENANTLESS methods is generally an error, since if this service calls another service that requires a tenant, then this service transitively requires one as well.
• Fields and types: Indicates that the component does not contain references to tenant specific data (either directly or indirectly).

UNRESOLVED

public static final TenancyScope UNRESOLVED

Explicitly marks that this is a component whose safety in a multi-tenanted environment has not yet been evaluated or that is known to require additional work.

This is intended to be used temporarily to help track remaining multi-tenancy work. It should not be assigned in new code unless properly resolving the problem is blocked by some external dependency.

SUPPRESS

public static final TenancyScope SUPPRESS

Explicitly marks that tenancy scope concerns are not relevant for this component and that it should be exempt from static analysis rules.

This is intended for use on components that code analysis tools are likely to flag as suspicious, but are naturally safe due to how they are used.

Method Detail

values

public static TenancyScope[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TenancyScope c : TenancyScope.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TenancyScope valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null