| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_252) on Fri Jul 16 09:38:47 UTC 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>SchemaPerMultitenantPolicy (EclipseLink 3.0.2, API Reference)</title> |
| <meta name="date" content="2021-07-16"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SchemaPerMultitenantPolicy (EclipseLink 3.0.2, API Reference)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/ReturningPolicy.Info.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/SelectedFieldsLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html" target="_top">Frames</a></li> |
| <li><a href="SchemaPerMultitenantPolicy.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.eclipse.persistence.descriptors.TablePerMultitenantPolicy">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.eclipse.persistence.descriptors</div> |
| <h2 title="Class SchemaPerMultitenantPolicy" class="title">Class SchemaPerMultitenantPolicy</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">org.eclipse.persistence.descriptors.TablePerMultitenantPolicy</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.persistence.descriptors.SchemaPerMultitenantPolicy</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</a>, <a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html" title="interface in org.eclipse.persistence.descriptors">MultitenantPolicy</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SchemaPerMultitenantPolicy</span> |
| extends <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></pre> |
| <div class="block">A schema per tenant multitenant policy. |
| This is a special case of TablePerMultitenantPolicy which can be applied |
| on the project. Can be useful in cases when tenant schema change happens |
| outside of EclipseLink, typically if Proxy DataSource is used. |
| |
| Use of this policy is limited to projects where following applies |
| <ul> |
| <li>@Multitenant entities are not used |
| <li>EMF is shared across tenants |
| <li>EMF shared cache is disabled |
| <li>no @Entity defines schema to be used |
| </ul></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.eclipse.persistence.descriptors.SchemaPerMultitenantPolicy">Serialized Form</a></dd> |
| <dt><span class="simpleTagLabel">Author:</span></dt> |
| <dd>Lukas Jungmann</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>EclipseLink 2.6</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.eclipse.persistence.descriptors.TablePerMultitenantPolicy"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.persistence.descriptors.<a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></h3> |
| <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#contextProperty">contextProperty</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#contextTenant">contextTenant</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#descriptor">descriptor</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#tablePerTenantTables">tablePerTenantTables</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#type">type</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#SchemaPerMultitenantPolicy--">SchemaPerMultitenantPolicy</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#SchemaPerMultitenantPolicy-org.eclipse.persistence.descriptors.ClassDescriptor-">SchemaPerMultitenantPolicy</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> desc)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html" title="interface in org.eclipse.persistence.descriptors">MultitenantPolicy</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#clone-org.eclipse.persistence.descriptors.ClassDescriptor-">clone</a></span>(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</code> |
| <div class="block">INTERNAL: |
| Multitenant policies are cloned per inheritance subclass.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseTable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#getTable-org.eclipse.persistence.internal.helper.DatabaseTable-">getTable</a></span>(org.eclipse.persistence.internal.helper.DatabaseTable table)</code> |
| <div class="block">INTERNAL: |
| Return the new database table associated with this tenant.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>org.eclipse.persistence.internal.helper.DatabaseTable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#getTable-java.lang.String-">getTable</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tableName)</code> |
| <div class="block">INTERNAL: |
| Return the new database table associated with this tenant.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#getTableName-org.eclipse.persistence.internal.helper.DatabaseTable-java.lang.String-">getTableName</a></span>(org.eclipse.persistence.internal.helper.DatabaseTable table, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tenant)</code> |
| <div class="block">INTERNAL: |
| Return the tenant table name.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a></span>(org.eclipse.persistence.internal.sessions.AbstractSession session)</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#isSchemaPerMultitenantPolicy--">isSchemaPerMultitenantPolicy</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#isTablePerMultitenantPolicy--">isTablePerMultitenantPolicy</a></span>()</code> |
| <div class="block">INTERNAL:</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#setShouldUseSharedCache-boolean-">setShouldUseSharedCache</a></span>(boolean shouldUseSharedCache)</code> </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#setShouldUseSharedEMF-boolean-">setShouldUseSharedEMF</a></span>(boolean shouldUseSharedEMF)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#setTableSchemaPerTenant--">setTableSchemaPerTenant</a></span>()</code> |
| <div class="block">INTERNAL: |
| This method is used to update the table per tenant descriptor with |
| a table per tenant schema.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#shouldUseSharedCache--">shouldUseSharedCache</a></span>()</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#shouldUseSharedEMF--">shouldUseSharedEMF</a></span>()</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>protected org.eclipse.persistence.internal.helper.DatabaseTable</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html#updateTable-org.eclipse.persistence.internal.helper.DatabaseTable-">updateTable</a></span>(org.eclipse.persistence.internal.helper.DatabaseTable table)</code> |
| <div class="block">INTERNAL: |
| This method will update the table by cloning it and setting a new name |
| on it.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.eclipse.persistence.descriptors.TablePerMultitenantPolicy"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.persistence.descriptors.<a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></h3> |
| <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#addFieldsToRow-org.eclipse.persistence.internal.sessions.AbstractRecord-org.eclipse.persistence.internal.sessions.AbstractSession-">addFieldsToRow</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#addToTableDefinition-org.eclipse.persistence.tools.schemaframework.TableDefinition-">addToTableDefinition</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#getContextProperty--">getContextProperty</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#hasContextTenant--">hasContextTenant</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#isPrefixPerTable--">isPrefixPerTable</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#isSchemaPerTable--">isSchemaPerTable</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#isSingleTableMultitenantPolicy--">isSingleTableMultitenantPolicy</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#isSuffixPerTable--">isSuffixPerTable</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#postInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">postInitialize</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#preInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">preInitialize</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#setContextProperty-java.lang.String-">setContextProperty</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#setContextTenant-java.lang.String-">setContextTenant</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#setTablePerTenant--">setTablePerTenant</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#setTenantTableDiscriminatorType-org.eclipse.persistence.annotations.TenantTableDiscriminatorType-">setTenantTableDiscriminatorType</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#shouldInitialize-org.eclipse.persistence.internal.sessions.AbstractSession-">shouldInitialize</a>, <a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#usesContextProperty-java.lang.String-">usesContextProperty</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SchemaPerMultitenantPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SchemaPerMultitenantPolicy</h4> |
| <pre>public SchemaPerMultitenantPolicy()</pre> |
| </li> |
| </ul> |
| <a name="SchemaPerMultitenantPolicy-org.eclipse.persistence.descriptors.ClassDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SchemaPerMultitenantPolicy</h4> |
| <pre>public SchemaPerMultitenantPolicy(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> desc)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="initialize-org.eclipse.persistence.internal.sessions.AbstractSession-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>initialize</h4> |
| <pre>public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session) |
| throws <a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></pre> |
| <div class="block">INTERNAL:</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a></code> in interface <code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html" title="interface in org.eclipse.persistence.descriptors">MultitenantPolicy</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#initialize-org.eclipse.persistence.internal.sessions.AbstractSession-">initialize</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/exceptions/DescriptorException.html" title="class in org.eclipse.persistence.exceptions">DescriptorException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="clone-org.eclipse.persistence.descriptors.ClassDescriptor-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>clone</h4> |
| <pre>public <a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html" title="interface in org.eclipse.persistence.descriptors">MultitenantPolicy</a> clone(<a href="../../../../org/eclipse/persistence/descriptors/ClassDescriptor.html" title="class in org.eclipse.persistence.descriptors">ClassDescriptor</a> descriptor)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#clone-org.eclipse.persistence.descriptors.ClassDescriptor-">TablePerMultitenantPolicy</a></code></span></div> |
| <div class="block">INTERNAL: |
| Multitenant policies are cloned per inheritance subclass.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html#clone-org.eclipse.persistence.descriptors.ClassDescriptor-">clone</a></code> in interface <code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html" title="interface in org.eclipse.persistence.descriptors">MultitenantPolicy</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#clone-org.eclipse.persistence.descriptors.ClassDescriptor-">clone</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isSchemaPerMultitenantPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isSchemaPerMultitenantPolicy</h4> |
| <pre>public boolean isSchemaPerMultitenantPolicy()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#isSchemaPerMultitenantPolicy--">TablePerMultitenantPolicy</a></code></span></div> |
| <div class="block">INTERNAL:</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html#isSchemaPerMultitenantPolicy--">isSchemaPerMultitenantPolicy</a></code> in interface <code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html" title="interface in org.eclipse.persistence.descriptors">MultitenantPolicy</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#isSchemaPerMultitenantPolicy--">isSchemaPerMultitenantPolicy</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setTableSchemaPerTenant--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTableSchemaPerTenant</h4> |
| <pre>protected void setTableSchemaPerTenant()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#setTableSchemaPerTenant--">TablePerMultitenantPolicy</a></code></span></div> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#setTableSchemaPerTenant--">setTableSchemaPerTenant</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isTablePerMultitenantPolicy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isTablePerMultitenantPolicy</h4> |
| <pre>public boolean isTablePerMultitenantPolicy()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#isTablePerMultitenantPolicy--">TablePerMultitenantPolicy</a></code></span></div> |
| <div class="block">INTERNAL:</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html#isTablePerMultitenantPolicy--">isTablePerMultitenantPolicy</a></code> in interface <code><a href="../../../../org/eclipse/persistence/descriptors/MultitenantPolicy.html" title="interface in org.eclipse.persistence.descriptors">MultitenantPolicy</a></code></dd> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#isTablePerMultitenantPolicy--">isTablePerMultitenantPolicy</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTableName-org.eclipse.persistence.internal.helper.DatabaseTable-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTableName</h4> |
| <pre>protected <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getTableName(org.eclipse.persistence.internal.helper.DatabaseTable table, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tenant)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#getTableName-org.eclipse.persistence.internal.helper.DatabaseTable-java.lang.String-">TablePerMultitenantPolicy</a></code></span></div> |
| <div class="block">INTERNAL: |
| Return the tenant table name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#getTableName-org.eclipse.persistence.internal.helper.DatabaseTable-java.lang.String-">getTableName</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTable-org.eclipse.persistence.internal.helper.DatabaseTable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTable</h4> |
| <pre>public org.eclipse.persistence.internal.helper.DatabaseTable getTable(org.eclipse.persistence.internal.helper.DatabaseTable table)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#getTable-org.eclipse.persistence.internal.helper.DatabaseTable-">TablePerMultitenantPolicy</a></code></span></div> |
| <div class="block">INTERNAL: |
| Return the new database table associated with this tenant.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#getTable-org.eclipse.persistence.internal.helper.DatabaseTable-">getTable</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTable-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTable</h4> |
| <pre>public org.eclipse.persistence.internal.helper.DatabaseTable getTable(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> tableName)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#getTable-java.lang.String-">TablePerMultitenantPolicy</a></code></span></div> |
| <div class="block">INTERNAL: |
| Return the new database table associated with this tenant.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#getTable-java.lang.String-">getTable</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="updateTable-org.eclipse.persistence.internal.helper.DatabaseTable-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>updateTable</h4> |
| <pre>protected org.eclipse.persistence.internal.helper.DatabaseTable updateTable(org.eclipse.persistence.internal.helper.DatabaseTable table)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#updateTable-org.eclipse.persistence.internal.helper.DatabaseTable-">TablePerMultitenantPolicy</a></code></span></div> |
| <div class="block">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.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html#updateTable-org.eclipse.persistence.internal.helper.DatabaseTable-">updateTable</a></code> in class <code><a href="../../../../org/eclipse/persistence/descriptors/TablePerMultitenantPolicy.html" title="class in org.eclipse.persistence.descriptors">TablePerMultitenantPolicy</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="shouldUseSharedEMF--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldUseSharedEMF</h4> |
| <pre>public boolean shouldUseSharedEMF()</pre> |
| </li> |
| </ul> |
| <a name="setShouldUseSharedEMF-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setShouldUseSharedEMF</h4> |
| <pre>public void setShouldUseSharedEMF(boolean shouldUseSharedEMF)</pre> |
| </li> |
| </ul> |
| <a name="shouldUseSharedCache--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shouldUseSharedCache</h4> |
| <pre>public boolean shouldUseSharedCache()</pre> |
| </li> |
| </ul> |
| <a name="setShouldUseSharedCache-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setShouldUseSharedCache</h4> |
| <pre>public void setShouldUseSharedCache(boolean shouldUseSharedCache)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">EclipseLink 3.0.2, API Reference</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/ReturningPolicy.Info.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/eclipse/persistence/descriptors/SelectedFieldsLockingPolicy.html" title="class in org.eclipse.persistence.descriptors"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/eclipse/persistence/descriptors/SchemaPerMultitenantPolicy.html" target="_top">Frames</a></li> |
| <li><a href="SchemaPerMultitenantPolicy.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#fields.inherited.from.class.org.eclipse.persistence.descriptors.TablePerMultitenantPolicy">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="http://www.eclipse.org/eclipselink">Eclipse.org - EclipseLink Project</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
