Google Git
Sign in
apache / openjpa-site / f4f8b894b02554a0a851bbf380ef41d45c445062 / . / content / builds / 2.4.1 / apidocs / org / apache / openjpa / slice / DistributedBrokerFactory.html
blob: 3326470f91876483b4c11d2265ec4cd2968ed906 [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 (version 1.7.0_79) on Mon Mar 21 21:59:50 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DistributedBrokerFactory (OpenJPA Parent POM 2.4.1 API)</title>
<meta name="date" content="2016-03-21">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DistributedBrokerFactory (OpenJPA Parent POM 2.4.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/slice/DistributedBrokerImpl.html" title="class in org.apache.openjpa.slice"><span class="strong">Next 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 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:&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="http://download.oracle.com/javase/6/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="strong">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="strong">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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr 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><strong><a href="../../../../org/apache/openjpa/slice/DistributedBrokerFactory.html#addSlice(java.lang.String,%20java.util.Map)">addSlice</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://download.oracle.com/javase/6/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,%20java.lang.Class[])">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,%20java.lang.String,%20boolean,%20int,%20boolean)">newBroker</a>, <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker(java.lang.String,%20java.lang.String,%20boolean,%20int,%20boolean,%20java.lang.String,%20java.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,%20java.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="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name,
<a href="http://download.oracle.com/javase/6/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="strong">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="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/openjpa/slice/DistributedBrokerImpl.html" title="class in org.apache.openjpa.slice"><span class="strong">Next 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 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:&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;2016 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>