@Internal public final enum

TenantAware

extends Enum<E extends Enum<E>>
java.lang.Object
   ↳ java.lang.Enum<E extends java.lang.Enum<E>>
     ↳ com.atlassian.jira.tenancy.TenantAware

@Internal

This enum is an internal implementation detail and will change without notice.

Clients that depend on @Internal classes and interfaces can not expect to be compatible with any version other than the version they were compiled against (even minor version and milestone releases may break binary compatibility with respect to @Internal elements).

Class Overview

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

Summary

Enum Values
TenantAware  TENANTED  Indicates that the component uses data access patterns that require knowledge of the current tenant. 
TenantAware  TENANTLESS  Indicates that the component only accesses data that is universal across all tenants. 
TenantAware  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. 
Public Methods
static TenantAware valueOf(String name)
final static TenantAware[] values()
[Expand]
Inherited Methods
From class java.lang.Enum
From class java.lang.Object
From interface java.lang.Comparable

Enum Values

public static final TenantAware TENANTED

Indicates that the component uses data access patterns that require knowledge of the current tenant.

This implies that the component not must be used without first establishing a tenanted request context.

public static final TenantAware TENANTLESS

Indicates that the component only accesses data that is universal across all tenants.

Tenantless components may be accessed safely even outside of a tenanted request context and must avoid access to any tenant-specific information. Calling TENANTED components from TENANTLESS ones is generally an error, since if this service calls another service that requires a tenant, then this service transitively requires one as well.

public static final TenantAware 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.

Public Methods

public static TenantAware valueOf (String name)

public static final TenantAware[] values ()