Package org.eclipse.persistence.descriptors

Class SingleTableMultitenantPolicy

java.lang.Object

org.eclipse.persistence.descriptors.SingleTableMultitenantPolicy

All Implemented Interfaces:

Serializable, MultitenantPolicy

Direct Known Subclasses:

VPDMultitenantPolicy

public class SingleTableMultitenantPolicy
extends Object
implements MultitenantPolicy

A single table "striped" multitenant policy.

Since:

EclipseLink 2.3.1

Author:

Guy Pelletier

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassDescriptor	descriptor
protected boolean	includeTenantCriteria
protected Map<DatabaseField,String>	tenantDiscriminatorFields
protected Map<String,List<DatabaseField>>	tenantDiscriminatorFieldsKeyedOnContext

Constructor Summary

Constructors

Constructor	Description
SingleTableMultitenantPolicy(ClassDescriptor desc)

Method Summary

Modifier and Type	Method	Description
void	addFieldsToRow(AbstractRecord row, AbstractSession session)	INTERNAL: Add the tenant discriminator fields to the row.
void	addTenantDiscriminatorField(String property, DatabaseField field)	INTERNAL: Add a tenant discriminator field to the policy.
void	addToTableDefinition(TableDefinition tableDefinition)	INTERNAL:
MultitenantPolicy	clone(ClassDescriptor descriptor)	INTERNAL:
ClassDescriptor	getDescriptor()	INTERNAL:
Map<DatabaseField,String>	getTenantDiscriminatorFields()	INTERNAL:
Map<String,List<DatabaseField>>	getTenantDiscriminatorFieldsKeyedOnContext()	INTERNAL:
boolean	hasTenantDiscriminatorFields()	INTERNAL: Return if this descriptor has specified some tenant discriminator fields.
void	initialize(AbstractSession session)	INTERNAL: Initialize the mappings as a separate step.
boolean	isSchemaPerMultitenantPolicy()	INTERNAL:
boolean	isSingleTableMultitenantPolicy()	INTERNAL:
boolean	isTablePerMultitenantPolicy()	INTERNAL:
void	postInitialize(AbstractSession session)	INTERNAL: Subclasses that need to add field to an expresison should override this method.
void	preInitialize(AbstractSession session)	INTERNAL: Allow the descriptor to initialize any dependencies on this session.
void	setDescriptor(ClassDescriptor descriptor)	INTERNAL:
void	setIncludeTenantCriteria(boolean includeTenantCriteria)	ADVANCED: Boolean used to indicate if the database requires the tenant criteria to be added to the SELECT, UPDATE, and DELETE queries.
void	setTenantDiscriminatorFields(Map<DatabaseField,String> tenantDiscriminatorFields)	INTERNAL:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

includeTenantCriteria

protected boolean includeTenantCriteria

descriptor

protected ClassDescriptor descriptor

tenantDiscriminatorFields

protected Map<DatabaseField,String> tenantDiscriminatorFields

tenantDiscriminatorFieldsKeyedOnContext

protected Map<String,List<DatabaseField>> tenantDiscriminatorFieldsKeyedOnContext

Constructor Detail

SingleTableMultitenantPolicy

public SingleTableMultitenantPolicy(ClassDescriptor desc)

Method Detail

addFieldsToRow

public void addFieldsToRow(AbstractRecord row,
                           AbstractSession session)

INTERNAL: Add the tenant discriminator fields to the row.

Specified by:

addFieldsToRow in interface MultitenantPolicy

addToTableDefinition

public void addToTableDefinition(TableDefinition tableDefinition)

INTERNAL:

Specified by:

addToTableDefinition in interface MultitenantPolicy

clone

public MultitenantPolicy clone(ClassDescriptor descriptor)

INTERNAL:

Specified by:

clone in interface MultitenantPolicy

getDescriptor

public ClassDescriptor getDescriptor()

INTERNAL:

addTenantDiscriminatorField

public void addTenantDiscriminatorField(String property,
                                        DatabaseField field)

INTERNAL: Add a tenant discriminator field to the policy.

getTenantDiscriminatorFields

public Map<DatabaseField,String> getTenantDiscriminatorFields()

INTERNAL:

getTenantDiscriminatorFieldsKeyedOnContext

public Map<String,List<DatabaseField>> getTenantDiscriminatorFieldsKeyedOnContext()

INTERNAL:

hasTenantDiscriminatorFields

public boolean hasTenantDiscriminatorFields()

INTERNAL: Return if this descriptor has specified some tenant discriminator fields.

initialize

public void initialize(AbstractSession session)
                throws DescriptorException

INTERNAL: Initialize the mappings as a separate step. This is done as a separate step to ensure that inheritance has been first resolved.

Specified by:

initialize in interface MultitenantPolicy

Throws:

DescriptorException

isSingleTableMultitenantPolicy

public boolean isSingleTableMultitenantPolicy()

INTERNAL:

Specified by:

isSingleTableMultitenantPolicy in interface MultitenantPolicy

isTablePerMultitenantPolicy

public boolean isTablePerMultitenantPolicy()

INTERNAL:

Specified by:

isTablePerMultitenantPolicy in interface MultitenantPolicy

isSchemaPerMultitenantPolicy

public boolean isSchemaPerMultitenantPolicy()

INTERNAL:

Specified by:

isSchemaPerMultitenantPolicy in interface MultitenantPolicy

postInitialize

public void postInitialize(AbstractSession session)

INTERNAL: Subclasses that need to add field to an expresison should override this method.

Specified by:

postInitialize in interface MultitenantPolicy

preInitialize

public void preInitialize(AbstractSession session)
                   throws DescriptorException

INTERNAL: Allow the descriptor to initialize any dependencies on this session.

Specified by:

preInitialize in interface MultitenantPolicy

Throws:

DescriptorException

setDescriptor

public void setDescriptor(ClassDescriptor descriptor)

INTERNAL:

setIncludeTenantCriteria

public void setIncludeTenantCriteria(boolean includeTenantCriteria)

ADVANCED: Boolean used to indicate if the database requires the tenant criteria to be added to the SELECT, UPDATE, and DELETE queries. By default this is done but when set to false the queries will not be modified and it will be up to the application or database to ensure that the correct criteria is applied to all queries.

See Also:

Multitenant

setTenantDiscriminatorFields

public void setTenantDiscriminatorFields(Map<DatabaseField,String> tenantDiscriminatorFields)

INTERNAL: