org.eclipse.persistence.annotations

public @Interface TenantTableDiscriminator

Annotations

@Target:TYPE
@Retention:RUNTIME

Imports

java.lang.annotation.Retention, .Target, org.eclipse.persistence.config.PersistenceUnitProperties

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"

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.

Author: Guy Pelletier
Since: EclipseLink 2.4
See Also: org.eclipse.persistence.annotations.TenantTableDiscriminator, org.eclipse.persistence.annotations.Multitenant, org.eclipse.persistence.annotations.MultitenantType

Method Summary

Modifier and Type	Method and Description
public String	contextProperty() (Optional) The name of the context property to apply to as tenant table discriminator.
public TenantTableDiscriminatorType	type() (Optional) The type of tenant table discriminator to use with the tables of the persistence unit.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

contextProperty	back to summary
public String contextProperty() (Optional) The name of the context property to apply to as tenant table discriminator. Default is "eclipselink-tenant.id"

type	back to summary
public TenantTableDiscriminatorType type() (Optional) The type of tenant table discriminator to use with the tables of the persistence unit. Defaults to `TenantTableDiscriminatorType.SUFFIX`.