org.hibernate

Enum MultiTenancyStrategy

java.lang.Object

java.lang.Enum<MultiTenancyStrategy>

org.hibernate.MultiTenancyStrategy

All Implemented Interfaces:

Serializable, Comparable<MultiTenancyStrategy>

public enum MultiTenancyStrategy
extends Enum<MultiTenancyStrategy>

Describes the methods for multi-tenancy understood by Hibernate.

Author:

Steve Ebersole

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATABASE Multi-tenancy implemented as separate databases.
DISCRIMINATOR Multi-tenancy implemented by use of discriminator columns.
NONE No multi-tenancy.
SCHEMA Multi-tenancy implemented as separate schemas.

Method Summary

Modifier and Type	Method and Description
static MultiTenancyStrategy	determineMultiTenancyStrategy(Map properties) Extract the MultiTenancyStrategy from the setting map.
boolean	requiresMultiTenantConnectionProvider() Does this strategy indicate a requirement for the specialized MultiTenantConnectionProvider, rather than the traditional ConnectionProvider?
static MultiTenancyStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static MultiTenancyStrategy[]	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

DISCRIMINATOR

public static final MultiTenancyStrategy DISCRIMINATOR

Multi-tenancy implemented by use of discriminator columns.

SCHEMA

public static final MultiTenancyStrategy SCHEMA

Multi-tenancy implemented as separate schemas.

DATABASE

public static final MultiTenancyStrategy DATABASE

Multi-tenancy implemented as separate databases.

NONE

public static final MultiTenancyStrategy NONE

No multi-tenancy.

Method Detail

values

public static MultiTenancyStrategy[] 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 (MultiTenancyStrategy c : MultiTenancyStrategy.values())
    System.out.println(c);

Returns:

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

valueOf

public static MultiTenancyStrategy 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

requiresMultiTenantConnectionProvider

public boolean requiresMultiTenantConnectionProvider()

Does this strategy indicate a requirement for the specialized MultiTenantConnectionProvider, rather than the traditional ConnectionProvider?

Returns:

true indicates a MultiTenantConnectionProvider is required; false indicates it is not.

determineMultiTenancyStrategy

public static MultiTenancyStrategy determineMultiTenancyStrategy(Map properties)

Extract the MultiTenancyStrategy from the setting map.

Parameters:

properties - The map of settings.

Returns:

The selected strategy. NONE is always the default.