TenantResolver (multitenancy 4.2.0 API)

All Known Implementing Classes:

CookieTenantResolver, FixedTenantResolver, HttpHeaderTenantResolver, PrincipalTenantResolver, SessionTenantResolver, SubdomainTenantResolver, SystemPropertyTenantResolver

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
```
@FunctionalInterface
public interface TenantResolver
```
An interface for applications that implement Multi Tenancy to implement in order to resolve the current identifier.

Since:

1.0

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ALL`	Constant for a mapping to all tenants.
`static java.lang.String`	`DEFAULT`	The name of the default tenant.
`static java.lang.String`	`PREFIX`	Tenant Resolver Configuration Prefix.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type Method Description

java.io.Serializable resolveTenantIdentifier()
Resolves the current tenant identifier.

- Field Detail
  - PREFIX
```
static final java.lang.String PREFIX
```
    Tenant Resolver Configuration Prefix.
    
    See Also:
    
    Constant Field Values
  - DEFAULT
```
static final java.lang.String DEFAULT
```
    The name of the default tenant.
    
    See Also:
    
    Constant Field Values
  - ALL
```
static final java.lang.String ALL
```
    Constant for a mapping to all tenants.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - resolveTenantIdentifier
```
@NonNull
java.io.Serializable resolveTenantIdentifier()
                                      throws TenantNotFoundException
```
    Resolves the current tenant identifier.
    In a Multi Tenant setup where a single database is being used amongst multiple tenants this would be the object that is used as the tenantId property for each domain class.
    
    Returns:
    
    The tenant identifier
    
    Throws:
    
    TenantNotFoundException - if tenant not found