CurrentTenantHolder (Grails 8.0.0-SNAPSHOT)

grails.gorm.multitenancy.CurrentTenantHolder

@groovy.transform.CompileStatic
class CurrentTenantHolder
extends java.lang.Object

Constructor Summary

Constructors
Constructor and description
`CurrentTenantHolder()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static java.io.Serializable`	`get()` Obtain the tenant bound to the current thread, irrespective of datastore.
	`static java.io.Serializable`	`get(Datastore datastore)` Returns: Obtain the current tenant
	`static void`	`remove(Datastore datastore)`
	`static void`	`remove(java.lang.Class<? extends Datastore> datastoreClass)`
	`static void`	`set(Datastore datastore, java.io.Serializable tenantId)` Set the current tenant
	`static void`	`set(java.lang.Class<? extends Datastore> datastoreClass, java.io.Serializable tenantId)`
`<T>`	`static T`	`withTenant(Datastore datastore, java.io.Serializable tenantId, groovy.lang.Closure<T> callable)` Execute with the current tenant
`<T>`	`static T`	`withTenant(java.lang.Class<? extends Datastore> datastoreClass, java.io.Serializable tenantId, groovy.lang.Closure<T> callable)`
`<T>`	`static T`	`withoutTenant(Datastore datastore, groovy.lang.Closure<T> callable)` Execute without current tenant

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)`

- Constructor Detail
  - CurrentTenantHolder()
- Method Detail
  - static java.io.Serializable get()
    
    Obtain the tenant bound to the current thread, irrespective of datastore. Prefer get(Datastore). A thread can hold a different tenant for each datastore, and only the datastore-scoped lookup can say which of them applies to a given operation.
    throws:
    TenantException if different tenants are bound for different datastores. There is no correct answer to return in that case, and returning an arbitrary one is how cross-tenant reads and writes happen.
    
    Returns:
    The bound tenant id, or null if no tenant is bound
  - static java.io.Serializable get(Datastore datastore)
    
    Returns:
    Obtain the current tenant
  - static void remove(Datastore datastore)
  - static void remove(java.lang.Class<? extends Datastore> datastoreClass)
  - static void set(Datastore datastore, java.io.Serializable tenantId)
    
    Set the current tenant
    Parameters:
    tenantId - The tenant id
  - static void set(java.lang.Class<? extends Datastore> datastoreClass, java.io.Serializable tenantId)
  - <T> static T withTenant(Datastore datastore, java.io.Serializable tenantId, groovy.lang.Closure<T> callable)
    
    Execute with the current tenant
    Parameters:
    callable - The closure
    Returns:
    The result of the closure
  - <T> static T withTenant(java.lang.Class<? extends Datastore> datastoreClass, java.io.Serializable tenantId, groovy.lang.Closure<T> callable)
  - <T> static T withoutTenant(Datastore datastore, groovy.lang.Closure<T> callable)
    
    Execute without current tenant
    Parameters:
    callable - The closure
    Returns:
    The result of the closure

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class CurrentTenantHolder

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

CurrentTenantHolder()

Method Detail

static java.io.Serializable get()

static java.io.Serializable get(Datastore datastore)

static void remove(Datastore datastore)

static void remove(java.lang.Class<? extends Datastore> datastoreClass)

static void set(Datastore datastore, java.io.Serializable tenantId)

static void set(java.lang.Class<? extends Datastore> datastoreClass, java.io.Serializable tenantId)

<T> static T withTenant(Datastore datastore, java.io.Serializable tenantId, groovy.lang.Closure<T> callable)

<T> static T withTenant(java.lang.Class<? extends Datastore> datastoreClass, java.io.Serializable tenantId, groovy.lang.Closure<T> callable)

<T> static T withoutTenant(Datastore datastore, groovy.lang.Closure<T> callable)