org.eclipse.persistence.annotations.MultitenantType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.persistence.core Show documentation

EclipseLink build based upon Git transaction ecdf3c32c4

There is a newer version: 4.0.2

Show newest version

/*
 * Copyright (c) 2011, 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:
//     03/24/2011-2.3 Guy Pelletier
//       - 337323: Multi-tenant with shared schema support (part 1)
//     09/09/2011-2.3.1 Guy Pelletier
//       - 356197: Add new VPD type to MultitenantType
//     14/05/2012-2.4 Guy Pelletier
//       - 376603: Provide for table per tenant support for multitenant applications
package org.eclipse.persistence.annotations;

/**
 * An enum that is used within the Multitenant annotation.
 *
 * @see org.eclipse.persistence.annotations.Multitenant
 * @author Guy Pelletier
 * @since EclipseLink 2.3
 */
public enum MultitenantType {
    /**
     * Specifies that table(s) the entity maps to includes rows for multiple
     * tenants. The tenant discriminator column(s) are used with application
     * context values to limit what a persistence context can access.
     */
    SINGLE_TABLE,

    /**
     * Specifies that the DB will handle the tenant filtering on all SELECT,
     * UPDATE and DELETE queries. Using this type assumes that the platform
     * used with your persistence unit does indeed support VPD.
     *
     * @since 2.3.1
     */
    VPD,

    /**
     * Specifies that different tables are used for each tenant and used in
     * conjunction with the tenant table discriminator which describes how the
     * tables are uniquely identified, that is, using a suffix/prefix or a
     * separate schema.
     *
     * @since 2.4
     */
    TABLE_PER_TENANT
}