Tenants (Grails 8.0.1-SNAPSHOT)

grails.gorm.multitenancy.Tenants

```
@CompileStatic
@Slf4j
class Tenants
extends java.lang.Object
```
Helper methods for working with multi tenancy
Authors:
Graeme Rocher
Since:
6.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Tenants.DatastoreLocator`

Properties Summary

Properties
Type	Name and description
`static Tenants.DatastoreLocator`	`datastoreLocator` Pluggable locator for Datastore instances, allowing for easier testing.

Constructor Summary

Constructors
Constructor and description
`Tenants()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.io.Serializable`	`currentId()` Returns: The current tenant id
	`static java.io.Serializable`	`currentId(MultiTenantCapableDatastore multiTenantCapableDatastore)` The current id for the given datastore.
	`static java.io.Serializable`	`currentId(java.lang.Class<? extends Datastore> datastoreClass)` Returns: The current tenant id for the given datastore type
	`static void`	`eachTenant(Closure callable)` Execute the given closure for each tenant.
	`static void`	`eachTenant(java.lang.Class<? extends Datastore> datastoreClass, Closure callable)` Execute the given closure for each tenant.
	`static void`	`eachTenant(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure callable)` Execute the given closure for each tenant for the given datastore.
	`static boolean`	`isWithoutId()` Whether the current thread runs without a tenant id for the default datastore, as it does inside withoutId(Closure) and in a method annotated with WithoutTenant.
	`static boolean`	`isWithoutId(Datastore datastore)` Whether the current thread runs without a tenant id for the given datastore, as it does inside withoutId(MultiTenantCapableDatastore, Closure).
`<T>`	`static T`	`withCurrent(Closure<T> callable)` Execute the given closure with the current tenant
`<T>`	`static T`	`withCurrent(java.lang.Class<? extends Datastore> datastoreClass, Closure<T> callable)` Execute the given closure with the current tenant
`<T>`	`static T`	`withCurrent(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure<T> callable)` Execute the given closure with the current tenant for the given datastore.
`<T>`	`static T`	`withId(java.io.Serializable tenantId, Closure<T> callable)` Execute the given closure with given tenant id
`<T>`	`static T`	`withId(java.lang.Class domainClass, java.io.Serializable tenantId, Closure<T> callable)` Execute the given closure with given tenant id
`<T>`	`static T`	`withId(MultiTenantCapableDatastore multiTenantCapableDatastore, java.io.Serializable tenantId, Closure<T> callable)` Execute the given closure with given tenant id for the given datastore.
`<T>`	`static T`	`withTenant(java.io.Serializable tenantId, Closure<T> callable)` Binds the given tenant id to the current thread for the duration of the closure.
`<T>`	`static T`	`withTenant(java.lang.Class domainClass, java.io.Serializable tenantId, Closure<T> callable)` Binds the given tenant id to the current thread for the datastore that maps the given domain class, for the duration of the closure.
`<T>`	`static T`	`withoutId(Closure<T> callable)` Execute the given closure without any tenant id.
`<T>`	`static T`	`withoutId(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure<T> callable)` Execute the given closure without tenant id for the given datastore.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Property Detail
  - static Tenants.DatastoreLocator datastoreLocator
    
    Pluggable locator for Datastore instances, allowing for easier testing.
- Constructor Detail
  - Tenants()
- Method Detail
  - static java.io.Serializable currentId()
    
    throws:
    org.grails.datastore.mapping.multitenancy.exceptions.TenantNotFoundException if no current tenant is found
    
    Returns:
    The current tenant id
  - static java.io.Serializable currentId(MultiTenantCapableDatastore multiTenantCapableDatastore)
    
    The current id for the given datastore. Inside withoutId(Closure) it is ConnectionSource.DEFAULT.
    throws:
    TenantNotFoundException if no current tenant is found, including when the tenant resolver returns null
    
    Parameters:
    multiTenantCapableDatastore - The multi tenant capable datastore
    Returns:
    The current id
  - static java.io.Serializable currentId(java.lang.Class<? extends Datastore> datastoreClass)
    
    throws:
    org.grails.datastore.mapping.multitenancy.exceptions.TenantNotFoundException if no current tenant is found
    
    Returns:
    The current tenant id for the given datastore type
  - static void eachTenant(Closure callable)
    
    Execute the given closure for each tenant.
    Parameters:
    callable - The closure
    Returns:
    The result of the closure
  - static void eachTenant(java.lang.Class<? extends Datastore> datastoreClass, Closure callable)
    
    Execute the given closure for each tenant.
    Parameters:
    callable - The closure
    Returns:
    The result of the closure
  - static void eachTenant(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure callable)
    
    Execute the given closure for each tenant for the given datastore. This method will create a new datastore session for the scope of the call and hence is designed to be used to manage the connection life cycle
    Parameters:
    callable - The closure
    Returns:
    The result of the closure
  - static boolean isWithoutId()
    
    Whether the current thread runs without a tenant id for the default datastore, as it does inside withoutId(Closure) and in a method annotated with WithoutTenant. A tenant id that a TenantResolver returns or that is passed to withId(Serializable, Closure) never counts, even if it is the name of the default connection source, ConnectionSource.DEFAULT.
    The tenant id is bound per datastore, so this method looks up the single configured datastore. When more than one GORM implementation is configured, use isWithoutId(Datastore) with the datastore in question instead.
    throws:
    IllegalStateException if GORM is not initialized or more than one GORM implementation is configured
    
    Returns:
    Whether the current thread runs without a tenant id
    Since:
    7.0.18
  - static boolean isWithoutId(Datastore datastore)
    
    Whether the current thread runs without a tenant id for the given datastore, as it does inside withoutId(MultiTenantCapableDatastore, Closure). A tenant id that a TenantResolver returns or that is passed to withId never counts, even if it is the name of the default connection source, ConnectionSource.DEFAULT.
    Parameters:
    datastore - The datastore
    Returns:
    Whether the current thread runs without a tenant id for the datastore
    Since:
    7.0.18
  - <T> static T withCurrent(Closure<T> callable)
    
    Execute the given closure with the current tenant
    Parameters:
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withCurrent(java.lang.Class<? extends Datastore> datastoreClass, Closure<T> callable)
    
    Execute the given closure with the current tenant
    Parameters:
    datastoreClass - The datastore class
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withCurrent(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure<T> callable)
    
    Execute the given closure with the current tenant for the given datastore. Inside withoutId(MultiTenantCapableDatastore, Closure) it runs without a tenant id, and a closure that takes the tenant id gets ConnectionSource.DEFAULT.
    Parameters:
    multiTenantCapableDatastore - The multi tenant capable datastore
    callable - The closure
    Returns:
    The result of the closure
    Since:
    7.0.18
  - <T> static T withId(java.io.Serializable tenantId, Closure<T> callable)
    
    Execute the given closure with given tenant id
    Parameters:
    tenantId - The tenant id
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withId(java.lang.Class domainClass, java.io.Serializable tenantId, Closure<T> callable)
    
    Execute the given closure with given tenant id
    Parameters:
    tenantId - The tenant id
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withId(MultiTenantCapableDatastore multiTenantCapableDatastore, java.io.Serializable tenantId, Closure<T> callable)
    
    Execute the given closure with given tenant id for the given datastore. This method will create a new datastore session for the scope of the call and hence is designed to be used to manage the connection life cycle
    Parameters:
    tenantId - The tenant id
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withTenant(java.io.Serializable tenantId, Closure<T> callable)
    
    Binds the given tenant id to the current thread for the duration of the closure. This binds the tenant only. Unlike withId(Serializable, Closure) it opens no session and manages no connection life cycle: the closure runs in whatever session the caller has already established, and the caller remains responsible for opening and closing it. Reach for withId when the tenant's work needs a session of its own - in DATABASE mode that is also what selects the tenant's connection.
    Parameters:
    tenantId - The tenant id
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withTenant(java.lang.Class domainClass, java.io.Serializable tenantId, Closure<T> callable)
    
    Binds the given tenant id to the current thread for the datastore that maps the given domain class, for the duration of the closure. This binds the tenant only. Unlike withId(Class, Serializable, Closure) it opens no session and manages no connection: the caller owns the session the closure runs in.
    Parameters:
    domainClass - The domain class whose datastore the tenant should be bound for
    tenantId - The tenant id
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withoutId(Closure<T> callable)
    
    Execute the given closure without any tenant id. In Multi tenancy mode SINGLE this will execute against the default data source. If multi tenancy mode MULTI this will execute without including the "tenantId" on any query. Use with caution.
    Parameters:
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withoutId(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure<T> callable)
    
    Execute the given closure without tenant id for the given datastore. This method will create a new datastore session for the scope of the call and hence is designed to be used to manage the connection life cycle
    Parameters:
    callable - The closure
    Returns:
    The result of the closure

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

[Groovy] Class Tenants

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static Tenants.DatastoreLocator datastoreLocator

Constructor Detail

Tenants()

Method Detail

static java.io.Serializable currentId()

static java.io.Serializable currentId(MultiTenantCapableDatastore multiTenantCapableDatastore)

static java.io.Serializable currentId(java.lang.Class<? extends Datastore> datastoreClass)

static void eachTenant(Closure callable)

static void eachTenant(java.lang.Class<? extends Datastore> datastoreClass, Closure callable)

static void eachTenant(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure callable)

static boolean isWithoutId()

static boolean isWithoutId(Datastore datastore)

<T> static T withCurrent(Closure<T> callable)

<T> static T withCurrent(java.lang.Class<? extends Datastore> datastoreClass, Closure<T> callable)

<T> static T withCurrent(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure<T> callable)

<T> static T withId(java.io.Serializable tenantId, Closure<T> callable)

<T> static T withId(java.lang.Class domainClass, java.io.Serializable tenantId, Closure<T> callable)

<T> static T withId(MultiTenantCapableDatastore multiTenantCapableDatastore, java.io.Serializable tenantId, Closure<T> callable)

<T> static T withTenant(java.io.Serializable tenantId, Closure<T> callable)

<T> static T withTenant(java.lang.Class domainClass, java.io.Serializable tenantId, Closure<T> callable)

<T> static T withoutId(Closure<T> callable)

<T> static T withoutId(MultiTenantCapableDatastore multiTenantCapableDatastore, Closure<T> callable)