blob: 13d9331b4b1faf557adaec6ea466bb7b99fa851f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (1.8.0_252) on Thu Sep 03 11:54:30 CEST 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DistributedBrokerFactory (OpenJPA Parent POM 3.1.2 API)</title>
<meta name="date" content="2020-09-03">
<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="DistributedBrokerFactory (OpenJPA Parent POM 3.1.2 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="class-use/DistributedBrokerFactory.html">Use</a></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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openjpa/slice/DistributedBroker.html" title="interface in org.apache.openjpa.slice"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/slice/DistributedBrokerImpl.html" title="class in org.apache.openjpa.slice"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/slice/DistributedBrokerFactory.html" target="_top">Frames</a></li>
<li><a href="DistributedBrokerFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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.apache.openjpa.slice</div>
<h2 title="Interface DistributedBrokerFactory" class="title">Interface DistributedBrokerFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a>, <a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a>, <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></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/openjpa/slice/jdbc/DistributedJDBCBrokerFactory.html" title="class in org.apache.openjpa.slice.jdbc">DistributedJDBCBrokerFactory</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">DistributedBrokerFactory</span>
extends <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></pre>
<div class="block">Extension to BrokerFactory to allow dynamically add/remove slices.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Pinaki Poddar</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</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/apache/openjpa/slice/Slice.html" title="class in org.apache.openjpa.slice">Slice</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/openjpa/slice/DistributedBrokerFactory.html#addSlice-java.lang.String-java.util.Map-">addSlice</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>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;properties)</code>
<div class="block">Adds the given slice with the given properties.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.openjpa.kernel.BrokerFactory">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.openjpa.kernel.<a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></h3>
<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#addLifecycleListener-java.lang.Object-java.lang.Class:A-">addLifecycleListener</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#addTransactionListener-java.lang.Object-">addTransactionListener</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#assertOpen--">assertOpen</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#close--">close</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getConfiguration--">getConfiguration</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getProperties--">getProperties</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getSupportedProperties--">getSupportedProperties</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getUserObject-java.lang.Object-">getUserObject</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#isClosed--">isClosed</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#lock--">lock</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker--">newBroker</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker-java.lang.String-java.lang.String-boolean-int-boolean-">newBroker</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker-java.lang.String-java.lang.String-boolean-int-boolean-java.lang.String-java.lang.String-">newBroker</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#postCreationCallback--">postCreationCallback</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#putUserObject-java.lang.Object-java.lang.Object-">putUserObject</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#removeLifecycleListener-java.lang.Object-">removeLifecycleListener</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#removeTransactionListener-java.lang.Object-">removeTransactionListener</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#unlock--">unlock</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addSlice-java.lang.String-java.util.Map-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>addSlice</h4>
<pre><a href="../../../../org/apache/openjpa/slice/Slice.html" title="class in org.apache.openjpa.slice">Slice</a>&nbsp;addSlice(<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>&nbsp;name,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;properties)</pre>
<div class="block">Adds the given slice with the given properties. This newly added slice
will be configured to brokers constructed by this factory after this
call.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - logical name of the to be added slice. Must be different from
any currently available slices.</dd>
<dd><code>properties</code> - key-value pair of configuration for the slice to be
added. The keys must have openjpa.slice.&lt;name&gt;.* as prefix.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/openjpa/slice/DistributedConfiguration.html#getAvailableSliceNames--"><code>DistributedConfiguration.getAvailableSliceNames()</code></a>,
<code>DistributedConfiguration#addSlice(String, Map)</code></dd>
</dl>
</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="class-use/DistributedBrokerFactory.html">Use</a></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>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/openjpa/slice/DistributedBroker.html" title="interface in org.apache.openjpa.slice"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/slice/DistributedBrokerImpl.html" title="class in org.apache.openjpa.slice"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/slice/DistributedBrokerFactory.html" target="_top">Frames</a></li>
<li><a href="DistributedBrokerFactory.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 2006&#x2013;2020 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>