EclipseLink Core 4.0.2 · org.eclipse.persistence.descriptors.TablePerMultitenantPolicy

Modifier and Type	Field and Description
protected String	contextProperty
protected String	contextTenant
protected ClassDescriptor	descriptor
protected Map<DatabaseTable, DatabaseTable>	tablePerTenantTables
protected TenantTableDiscriminatorType	type

Access	Constructor and Description
pack-priv	TablePerMultitenantPolicy()
public	TablePerMultitenantPolicy(ClassDescriptor desc)

Method Summary

Modifier and Type	Method and Description
public void	addFieldsToRow(AbstractRecord row, AbstractSession session) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.addFieldsToRow. INTERNAL:
public void	addToTableDefinition(TableDefinition tableDefinition) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.addToTableDefinition. INTERNAL:
public MultitenantPolicy	clone(ClassDescriptor descriptor) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.clone. INTERNAL: Multitenant policies are cloned per inheritance subclass.
public String	getContextProperty() INTERNAL: Return the context property for this table per tenant policy.
public DatabaseTable	getTable(String tableName) INTERNAL: Return the new database table associated with this tenant.
public DatabaseTable	getTable(DatabaseTable table) INTERNAL: Return the new database table associated with this tenant.
protected String	getTableName(DatabaseTable table, String tenant) INTERNAL: Return the tenant table name.
public boolean	hasContextTenant() INTERNAL: Return true if the tenant has been set for this policy.
public void	initialize(AbstractSession session) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.initialize. INTERNAL:
public boolean	isPrefixPerTable() PUBLIC: Return true if this descriptor requires a prefix to the table per tenant.
public boolean	isSchemaPerMultitenantPolicy() Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isSchemaPerMultitenantPolicy. INTERNAL:
public boolean	isSchemaPerTable() PUBLIC: Return true if this descriptor requires a table schema per tenant.
public boolean	isSingleTableMultitenantPolicy() Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isSingleTableMultitenantPolicy. INTERNAL:
public boolean	isSuffixPerTable() PUBLIC: Return true if this descriptor requires a suffix to the table per tenant.
public boolean	isTablePerMultitenantPolicy() Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isTablePerMultitenantPolicy. INTERNAL:
public void	postInitialize(AbstractSession session) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.postInitialize. INTERNAL:
public void	preInitialize(AbstractSession session) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.preInitialize. INTERNAL:
public void	setContextProperty(String contextProperty) PUBLIC: Set the context property used to define the table per tenant.
public void	setContextTenant(String contextTenant) INTERNAL:
protected void	setTablePerTenant() INTERNAL: This method is used to update the table per tenant descriptor with a table per tenant prefix or suffix on its associated tables.
protected void	setTableSchemaPerTenant() INTERNAL: This method is used to update the table per tenant descriptor with a table per tenant schema.
public void	setTenantTableDiscriminatorType(TenantTableDiscriminatorType type) PUBLIC: Set the tenant table discriminator type.
public boolean	shouldInitialize(AbstractSession session) INTERNAL: This method is called during regular descriptor initialization.
protected DatabaseTable	updateTable(DatabaseTable table) INTERNAL: This method will update the table by cloning it and setting a new name on it.
public boolean	usesContextProperty(String property) INTERNAL: Return true if this policy accepts the given property.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

contextProperty	back to summary
protected String contextProperty

contextTenant	back to summary
protected String contextTenant

descriptor	back to summary
protected ClassDescriptor descriptor

tablePerTenantTables	back to summary
protected Map<DatabaseTable, DatabaseTable> tablePerTenantTables

type	back to summary
protected TenantTableDiscriminatorType type

TablePerMultitenantPolicy	back to summary
pack-priv TablePerMultitenantPolicy()

TablePerMultitenantPolicy	back to summary
public TablePerMultitenantPolicy(ClassDescriptor desc)

Method Detail

addFieldsToRow	back to summary
public void addFieldsToRow(AbstractRecord row, AbstractSession session) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.addFieldsToRow. INTERNAL: Annotations @Override

addFieldsToRow

back to summary

public void addFieldsToRow(AbstractRecord row, AbstractSession session)

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.addFieldsToRow.

INTERNAL:

Annotations

@Override

addToTableDefinition	back to summary
public void addToTableDefinition(TableDefinition tableDefinition) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.addToTableDefinition. INTERNAL: Annotations @Override

addToTableDefinition

back to summary

public void addToTableDefinition(TableDefinition tableDefinition)

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.addToTableDefinition.

INTERNAL:

Annotations

@Override

clone	back to summary
public MultitenantPolicy clone(ClassDescriptor descriptor) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.clone. INTERNAL: Multitenant policies are cloned per inheritance subclass. Annotations @Override

clone

back to summary

public MultitenantPolicy clone(ClassDescriptor descriptor)

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.clone.

INTERNAL: Multitenant policies are cloned per inheritance subclass.

Annotations

@Override

getContextProperty	back to summary
public String getContextProperty() INTERNAL: Return the context property for this table per tenant policy.

getTable	back to summary
public DatabaseTable getTable(String tableName) INTERNAL: Return the new database table associated with this tenant.

getTable	back to summary
public DatabaseTable getTable(DatabaseTable table) INTERNAL: Return the new database table associated with this tenant.

getTableName	back to summary
protected String getTableName(DatabaseTable table, String tenant) INTERNAL: Return the tenant table name.

hasContextTenant	back to summary
public boolean hasContextTenant() INTERNAL: Return true if the tenant has been set for this policy.

initialize	back to summary
public void initialize(AbstractSession session) throws DescriptorException Implements org.eclipse.persistence.descriptors.MultitenantPolicy.initialize. INTERNAL: Annotations @Override

initialize

back to summary

public void initialize(AbstractSession session) throws DescriptorException

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.initialize.

INTERNAL:

Annotations

@Override

isPrefixPerTable	back to summary
public boolean isPrefixPerTable() PUBLIC: Return true if this descriptor requires a prefix to the table per tenant.

isSchemaPerMultitenantPolicy	back to summary
public boolean isSchemaPerMultitenantPolicy() Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isSchemaPerMultitenantPolicy. INTERNAL: Annotations @Override

isSchemaPerMultitenantPolicy

back to summary

public boolean isSchemaPerMultitenantPolicy()

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isSchemaPerMultitenantPolicy.

INTERNAL:

Annotations

@Override

isSchemaPerTable	back to summary
public boolean isSchemaPerTable() PUBLIC: Return true if this descriptor requires a table schema per tenant.

isSingleTableMultitenantPolicy	back to summary
public boolean isSingleTableMultitenantPolicy() Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isSingleTableMultitenantPolicy. INTERNAL: Annotations @Override

isSingleTableMultitenantPolicy

back to summary

public boolean isSingleTableMultitenantPolicy()

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isSingleTableMultitenantPolicy.

INTERNAL:

Annotations

@Override

isSuffixPerTable	back to summary
public boolean isSuffixPerTable() PUBLIC: Return true if this descriptor requires a suffix to the table per tenant.

isTablePerMultitenantPolicy	back to summary
public boolean isTablePerMultitenantPolicy() Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isTablePerMultitenantPolicy. INTERNAL: Annotations @Override

isTablePerMultitenantPolicy

back to summary

public boolean isTablePerMultitenantPolicy()

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.isTablePerMultitenantPolicy.

INTERNAL:

Annotations

@Override

postInitialize	back to summary
public void postInitialize(AbstractSession session) Implements org.eclipse.persistence.descriptors.MultitenantPolicy.postInitialize. INTERNAL: Annotations @Override

postInitialize

back to summary

public void postInitialize(AbstractSession session)

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.postInitialize.

INTERNAL:

Annotations

@Override

preInitialize	back to summary
public void preInitialize(AbstractSession session) throws DescriptorException Implements org.eclipse.persistence.descriptors.MultitenantPolicy.preInitialize. INTERNAL: Annotations @Override

preInitialize

back to summary

public void preInitialize(AbstractSession session) throws DescriptorException

Implements org.eclipse.persistence.descriptors.MultitenantPolicy.preInitialize.

INTERNAL:

Annotations

@Override

setContextProperty	back to summary
public void setContextProperty(String contextProperty) PUBLIC: Set the context property used to define the table per tenant. If it is not set by the user, the policy defaults it to the multitenant property default of "eclipselink.tenant-id"

setContextTenant	back to summary
public void setContextTenant(String contextTenant) INTERNAL:

setTablePerTenant	back to summary
protected void setTablePerTenant() INTERNAL: This method is used to update the table per tenant descriptor with a table per tenant prefix or suffix on its associated tables. This includes any relation tables from mappings. If the given session is a client session than we must clone the tables. Outside of a client session, assume global usage and no cloning is needed. This method should only be called at the start of a client session lifecycle and should only be called once.

setTablePerTenant

back to summary

protected void setTablePerTenant()

INTERNAL: This method is used to update the table per tenant descriptor with a table per tenant prefix or suffix on its associated tables. This includes any relation tables from mappings. If the given session is a client session than we must clone the tables. Outside of a client session, assume global usage and no cloning is needed. This method should only be called at the start of a client session lifecycle and should only be called once.

setTableSchemaPerTenant	back to summary
protected void setTableSchemaPerTenant() INTERNAL: This method is used to update the table per tenant descriptor with a table per tenant schema. This includes any relation tables from mappings. This will be done through the setting of a table qualifier on the tables. This method should only be called at the start of a client session lifecycle and should only be called once.

setTenantTableDiscriminatorType	back to summary
public void setTenantTableDiscriminatorType(TenantTableDiscriminatorType type) PUBLIC: Set the tenant table discriminator type.

shouldInitialize	back to summary
public boolean shouldInitialize(AbstractSession session) INTERNAL: This method is called during regular descriptor initialization. When initializing at that level no cloning should be done on when setting the context tenant.

updateTable	back to summary
protected DatabaseTable updateTable(DatabaseTable table) INTERNAL: This method will update the table by cloning it and setting a new name on it. The table association will be stored here as well for ease of future look up.

usesContextProperty	back to summary
public boolean usesContextProperty(String property) INTERNAL: Return true if this policy accepts the given property.

public Class TablePerMultitenantPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail