1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
/*
* Copyright (c) 2012, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0,
* or the Eclipse Distribution License v. 1.0 which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
*/
// Contributors:
// 14/05/2012-2.4 Guy Pelletier
// - 376603: Provide for table per tenant support for multitenant applications
package org.eclipse.persistence.annotations;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import org.eclipse.persistence.config.PersistenceUnitProperties;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* <p>
* A tenant table discriminator is used with a TABLE_PER_TENANT multitenant
* strategy. The tenant table discriminator describes the type of table
* discriminator to use. The user may choose their own tenant identifier
* property or use the default property:
*
* org.eclipse.persistence.config.PersistenceUnitProperties.MULTITENANT_PROPERTY_DEFAULT = "eclipselink.tenant-id"
*
* <p>
* Tenant table discriminator can be specified at the Entity or MappedSuperclass
* level and must always be accompanied with a Multitenant(TABLE_PER_TENANT)
* specification. It is not sufficient to specify only a tenant table discriminator.
*
* @see org.eclipse.persistence.annotations.TenantTableDiscriminator
* @see org.eclipse.persistence.annotations.Multitenant
* @see org.eclipse.persistence.annotations.MultitenantType
*
* @author Guy Pelletier
* @since EclipseLink 2.4
*/
@Target({TYPE})
@Retention(RUNTIME)
public @interface TenantTableDiscriminator {
/**
* (Optional) The name of the context property to apply to as
* tenant table discriminator. Default is "eclipselink-tenant.id"
*/
String contextProperty() default PersistenceUnitProperties.MULTITENANT_PROPERTY_DEFAULT;
/**
* (Optional) The type of tenant table discriminator to use with the tables
* of the persistence unit.
* Defaults to {@link TenantTableDiscriminatorType#SUFFIX TenantTableDiscriminatorType.SUFFIX}.
*/
TenantTableDiscriminatorType type() default TenantTableDiscriminatorType.SUFFIX;
}
|
