blob: d8fb2ee50f4e49a09f2ece30305b0b8572763c53 [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:40 CET 2016 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AbstractBrokerFactory (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="AbstractBrokerFactory (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/AbstractBrokerFactory.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>Prev Class</li>
<li><a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/kernel/AbstractBrokerFactory.html" target="_top">Frames</a></li>
<li><a href="AbstractBrokerFactory.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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.kernel</div>
<h2 title="Class AbstractBrokerFactory" class="title">Class AbstractBrokerFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/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>org.apache.openjpa.kernel.AbstractBrokerFactory</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><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>, <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></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../org/apache/openjpa/abstractstore/AbstractStoreBrokerFactory.html" title="class in org.apache.openjpa.abstractstore">AbstractStoreBrokerFactory</a>, <a href="../../../../org/apache/openjpa/jdbc/kernel/JDBCBrokerFactory.html" title="class in org.apache.openjpa.jdbc.kernel">JDBCBrokerFactory</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">AbstractBrokerFactory</span>
extends <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></pre>
<div class="block">Abstract implementation of the <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel"><code>BrokerFactory</code></a>
that must be subclassed for a specific runtime.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Abe White</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.openjpa.kernel.AbstractBrokerFactory">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#AbstractBrokerFactory(org.apache.openjpa.conf.OpenJPAConfiguration)">AbstractBrokerFactory</a></strong>(<a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a>&nbsp;config)</code>
<div class="block">Constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#addLifecycleListener(java.lang.Object,%20java.lang.Class[])">addLifecycleListener</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;listener,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;classes)</code>
<div class="block">Register a listener for lifecycle-related events on the specified
classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#addListeners(org.apache.openjpa.kernel.Broker)">addListeners</a></strong>(<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;broker)</code>
<div class="block">Add factory-registered lifecycle listeners to the broker.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#addTransactionListener(java.lang.Object)">addTransactionListener</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;listener)</code>
<div class="block">Register a listener for transaction-related events on the specified
classes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#assertOpen()">assertOpen</a></strong>()</code>
<div class="block">Throw an exception if the factory is closed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#close()">close</a></strong>()</code>
<div class="block">Close the factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#configureBroker(org.apache.openjpa.kernel.BrokerImpl)">configureBroker</a></strong>(<a href="../../../../org/apache/openjpa/kernel/BrokerImpl.html" title="class in org.apache.openjpa.kernel">BrokerImpl</a>&nbsp;broker)</code>
<div class="block">Configures the given broker with the current factory option settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#createDelegatingStoreManager()">createDelegatingStoreManager</a></strong>()</code>
<div class="block">
Create a DelegatingStoreManager for use with a Broker created by this factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#findBroker(java.lang.String,%20java.lang.String,%20boolean)">findBroker</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;user,
<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;pass,
boolean&nbsp;managed)</code>
<div class="block">Find a pooled broker, or return null if none.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#findTransactionalBroker(java.lang.String,%20java.lang.String)">findTransactionalBroker</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;user,
<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;pass)</code>
<div class="block">Find a managed runtime broker associated with the
current transaction, or returns null if none.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getConfiguration()">getConfiguration</a></strong>()</code>
<div class="block">Return the configuration for this factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getFactoryInitializationBanner()">getFactoryInitializationBanner</a></strong>()</code>
<div class="block">Return an object to be written to the log when this broker factory
initializes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getOpenBrokers()">getOpenBrokers</a></strong>()</code>
<div class="block">Returns a set of all the open brokers associated with this factory.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html" title="class in org.apache.openjpa.kernel">AbstractBrokerFactory</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getPooledFactoryForKey(java.lang.Object)">getPooledFactoryForKey</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key)</code>
<div class="block">Return the pooled factory matching the given key, or null
if none.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getPoolKey()">getPoolKey</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><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>&lt;<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>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getProperties()">getProperties</a></strong>()</code>
<div class="block">Subclasses should override this method to add a <code>Platform</code>
property listing the runtime platform, such as:
<code>OpenJPA JDBC Edition: Oracle Database</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getSupportedProperties()">getSupportedProperties</a></strong>()</code>
<div class="block">Return all of the supported properties as a set of keys.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getUserObject(java.lang.Object)">getUserObject</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key)</code>
<div class="block">Get the value for the specified key from the map of user objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#isClosed()">isClosed</a></strong>()</code>
<div class="block">Returns true if this broker factory is closed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#loadPersistentTypes(java.lang.ClassLoader)">loadPersistentTypes</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;envLoader)</code>
<div class="block">Load the configured persistent classes list.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#lock()">lock</a></strong>()</code>
<div class="block">Synchronizes on an internal lock.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#makeReadOnly()">makeReadOnly</a></strong>()</code>
<div class="block">Freezes the configuration of this factory.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newBroker()">newBroker</a></strong>()</code>
<div class="block">Return a broker with default settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newBroker(boolean,%20int)">newBroker</a></strong>(boolean&nbsp;managed,
int&nbsp;connRetainMode)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newBroker(java.lang.String,%20java.lang.String)">newBroker</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;user,
<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;pass)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newBroker(java.lang.String,%20java.lang.String,%20boolean,%20int)">newBroker</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;user,
<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;pass,
boolean&nbsp;managed,
int&nbsp;connRetainMode)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newBroker(java.lang.String,%20java.lang.String,%20boolean,%20int,%20boolean)">newBroker</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;user,
<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;pass,
boolean&nbsp;managed,
int&nbsp;connRetainMode,
boolean&nbsp;findExisting)</code>
<div class="block">Return a broker using the given credentials and in the given
transaction and connection retain mode, optionally finding
existing broker in the global transaction.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newBroker(java.lang.String,%20java.lang.String,%20boolean,%20int,%20boolean,%20java.lang.String,%20java.lang.String)">newBroker</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;user,
<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;pass,
boolean&nbsp;managed,
int&nbsp;connRetainMode,
boolean&nbsp;findExisting,
<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;cf1Name,
<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;cf2Name)</code>
<div class="block">Return a new broker using the supplied
credentials
transaction management mode
connectionRetainMode
connectionFactories
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../org/apache/openjpa/kernel/BrokerImpl.html" title="class in org.apache.openjpa.kernel">BrokerImpl</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newBrokerImpl(java.lang.String,%20java.lang.String)">newBrokerImpl</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;user,
<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;pass)</code>
<div class="block">Return a broker configured with the proper settings.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract <a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newStoreManager()">newStoreManager</a></strong>()</code>
<div class="block">Return a new StoreManager for this runtime.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#pool(java.lang.Object,%20org.apache.openjpa.kernel.AbstractBrokerFactory)">pool</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html" title="class in org.apache.openjpa.kernel">AbstractBrokerFactory</a>&nbsp;factory)</code>
<div class="block">Register <code>factory</code> in the pool under <code>key</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#postCreationCallback()">postCreationCallback</a></strong>()</code>
<div class="block">This method is invoked AFTER a BrokerFactory has been instantiated.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#putUserObject(java.lang.Object,%20java.lang.Object)">putUserObject</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</code>
<div class="block">Put the specified key-value pair into the map of user objects.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#readResolve()">readResolve</a></strong>()</code>
<div class="block">Replaces the factory with this JVMs pooled version if it exists.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#releaseBroker(org.apache.openjpa.kernel.BrokerImpl)">releaseBroker</a></strong>(<a href="../../../../org/apache/openjpa/kernel/BrokerImpl.html" title="class in org.apache.openjpa.kernel">BrokerImpl</a>&nbsp;broker)</code>
<div class="block">Release <code>broker</code> from any internal data structures.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#removeLifecycleListener(java.lang.Object)">removeLifecycleListener</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;listener)</code>
<div class="block">Remove a listener for lifecycle-related events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#removeTransactionListener(java.lang.Object)">removeTransactionListener</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;listener)</code>
<div class="block">Remove a listener for transaction-related events.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#setup()">setup</a></strong>()</code>
<div class="block">Setup transient state used by this factory based on the
current configuration, which will subsequently be locked down.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected static <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#toPoolKey(java.util.Map)">toPoolKey</a></strong>(<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>&lt;<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>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;map)</code>
<div class="block">Return an internal factory pool key for the given configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#unlock()">unlock</a></strong>()</code>
<div class="block">Release the internal lock.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="AbstractBrokerFactory(org.apache.openjpa.conf.OpenJPAConfiguration)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AbstractBrokerFactory</h4>
<pre>protected&nbsp;AbstractBrokerFactory(<a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a>&nbsp;config)</pre>
<div class="block">Constructor. Configuration must be provided on construction.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="toPoolKey(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toPoolKey</h4>
<pre>protected static&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;toPoolKey(<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>&lt;<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>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;map)</pre>
<div class="block">Return an internal factory pool key for the given configuration.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1.0</dd></dl>
</li>
</ul>
<a name="pool(java.lang.Object, org.apache.openjpa.kernel.AbstractBrokerFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>pool</h4>
<pre>protected static&nbsp;void&nbsp;pool(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html" title="class in org.apache.openjpa.kernel">AbstractBrokerFactory</a>&nbsp;factory)</pre>
<div class="block">Register <code>factory</code> in the pool under <code>key</code>.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1.0</dd></dl>
</li>
</ul>
<a name="getPooledFactoryForKey(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPooledFactoryForKey</h4>
<pre>public static&nbsp;<a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html" title="class in org.apache.openjpa.kernel">AbstractBrokerFactory</a>&nbsp;getPooledFactoryForKey(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key)</pre>
<div class="block">Return the pooled factory matching the given key, or null
if none. The key must be of the form created by <a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#getPoolKey()"><code>getPoolKey()</code></a>.</div>
</li>
</ul>
<a name="getConfiguration()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getConfiguration</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/conf/OpenJPAConfiguration.html" title="interface in org.apache.openjpa.conf">OpenJPAConfiguration</a>&nbsp;getConfiguration()</pre>
<div class="block">Return the configuration for this factory.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getConfiguration()">getConfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="newBroker()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBroker</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;newBroker()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker()">BrokerFactory</a></code></strong></div>
<div class="block">Return a broker with default settings.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker()">newBroker</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="newBroker(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBroker</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;newBroker(<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;user,
<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;pass)</pre>
</li>
</ul>
<a name="newBroker(boolean, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBroker</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;newBroker(boolean&nbsp;managed,
int&nbsp;connRetainMode)</pre>
</li>
</ul>
<a name="newBroker(java.lang.String, java.lang.String, boolean, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBroker</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;newBroker(<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;user,
<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;pass,
boolean&nbsp;managed,
int&nbsp;connRetainMode)</pre>
</li>
</ul>
<a name="newBroker(java.lang.String, java.lang.String, boolean, int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBroker</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;newBroker(<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;user,
<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;pass,
boolean&nbsp;managed,
int&nbsp;connRetainMode,
boolean&nbsp;findExisting)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker(java.lang.String,%20java.lang.String,%20boolean,%20int,%20boolean)">BrokerFactory</a></code></strong></div>
<div class="block">Return a broker using the given credentials and in the given
transaction and connection retain mode, optionally finding
existing broker in the global transaction.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker(java.lang.String,%20java.lang.String,%20boolean,%20int,%20boolean)">newBroker</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="newBroker(java.lang.String, java.lang.String, boolean, int, boolean, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBroker</h4>
<pre>public&nbsp;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;newBroker(<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;user,
<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;pass,
boolean&nbsp;managed,
int&nbsp;connRetainMode,
boolean&nbsp;findExisting,
<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;cf1Name,
<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;cf2Name)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#newBroker(java.lang.String,%20java.lang.String,%20boolean,%20int,%20boolean,%20java.lang.String,%20java.lang.String)">BrokerFactory</a></code></strong></div>
<div class="block">Return a new broker using the supplied
<ul>
<li>credentials</li>
<li>transaction management mode</li>
<li>connectionRetainMode</li>
<li>connectionFactories</li>
</ul></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><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></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>user</code> - Username to use when obtaining a connection. Will be ignored if a connection factory is
obtained from JNDI.</dd><dd><code>pass</code> - Password to use when obtaining a connection. Will be ignored if a connection factory is
obtained from JNDI.</dd><dd><code>managed</code> - Whether managed transactions will be used by this Broker</dd><dd><code>connRetainMode</code> - <code>ConnectionRetainMode</code></dd><dd><code>findExisting</code> - Whether the internal pool of brokers should be used.</dd><dd><code>cf1Name</code> - JTA ConnectionFactory to use</dd><dd><code>cf2Name</code> - Non-JTA ConnectionFactory to use.</dd>
<dt><span class="strong">Returns:</span></dt><dd>A Broker which matches the provided criteria.</dd></dl>
</li>
</ul>
<a name="addListeners(org.apache.openjpa.kernel.Broker)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addListeners</h4>
<pre>protected&nbsp;void&nbsp;addListeners(<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;broker)</pre>
<div class="block">Add factory-registered lifecycle listeners to the broker.</div>
</li>
</ul>
<a name="loadPersistentTypes(java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>loadPersistentTypes</h4>
<pre>public&nbsp;void&nbsp;loadPersistentTypes(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a>&nbsp;envLoader)</pre>
<div class="block">Load the configured persistent classes list. Performed automatically
whenever a broker is created.</div>
</li>
</ul>
<a name="addLifecycleListener(java.lang.Object, java.lang.Class[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addLifecycleListener</h4>
<pre>public&nbsp;void&nbsp;addLifecycleListener(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;listener,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;?&gt;[]&nbsp;classes)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#addLifecycleListener(java.lang.Object,%20java.lang.Class[])">BrokerFactory</a></code></strong></div>
<div class="block">Register a listener for lifecycle-related events on the specified
classes. If the classes are null, all events will be propagated to
the listener. The listener will be passed on to all new brokers.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#addLifecycleListener(java.lang.Object,%20java.lang.Class[])">addLifecycleListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="removeLifecycleListener(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeLifecycleListener</h4>
<pre>public&nbsp;void&nbsp;removeLifecycleListener(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;listener)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#removeLifecycleListener(java.lang.Object)">BrokerFactory</a></code></strong></div>
<div class="block">Remove a listener for lifecycle-related events.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#removeLifecycleListener(java.lang.Object)">removeLifecycleListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="addTransactionListener(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addTransactionListener</h4>
<pre>public&nbsp;void&nbsp;addTransactionListener(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;listener)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#addTransactionListener(java.lang.Object)">BrokerFactory</a></code></strong></div>
<div class="block">Register a listener for transaction-related events on the specified
classes. It will be registered with all <a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel"><code>Broker</code></a>s created
from this instance moving forward.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#addTransactionListener(java.lang.Object)">addTransactionListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="removeTransactionListener(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeTransactionListener</h4>
<pre>public&nbsp;void&nbsp;removeTransactionListener(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;listener)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#removeTransactionListener(java.lang.Object)">BrokerFactory</a></code></strong></div>
<div class="block">Remove a listener for transaction-related events. It will no longer
be registered with new <a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel"><code>Broker</code></a>s created from this instance.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#removeTransactionListener(java.lang.Object)">removeTransactionListener</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="isClosed()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClosed</h4>
<pre>public&nbsp;boolean&nbsp;isClosed()</pre>
<div class="block">Returns true if this broker factory is closed.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#isClosed()">isClosed</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#close()">BrokerFactory</a></code></strong></div>
<div class="block">Close the factory.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html#close()">close</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/lib/util/Closeable.html" title="interface in org.apache.openjpa.lib.util">Closeable</a></code></dd>
</dl>
</li>
</ul>
<a name="getProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperties</h4>
<pre>public&nbsp;<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>&lt;<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>,<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&gt;&nbsp;getProperties()</pre>
<div class="block">Subclasses should override this method to add a <code>Platform</code>
property listing the runtime platform, such as:
<code>OpenJPA JDBC Edition: Oracle Database</code></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getProperties()">getProperties</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="getSupportedProperties()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSupportedProperties</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a>&lt;<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>&gt;&nbsp;getSupportedProperties()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getSupportedProperties()">BrokerFactory</a></code></strong></div>
<div class="block">Return all of the supported properties as a set of keys. If a property
has multiple keys, all keys will be returned.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getSupportedProperties()">getSupportedProperties</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="getUserObject(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUserObject</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getUserObject(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getUserObject(java.lang.Object)">BrokerFactory</a></code></strong></div>
<div class="block">Get the value for the specified key from the map of user objects.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#getUserObject(java.lang.Object)">getUserObject</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="putUserObject(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putUserObject</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;putUserObject(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;key,
<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;val)</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#putUserObject(java.lang.Object,%20java.lang.Object)">BrokerFactory</a></code></strong></div>
<div class="block">Put the specified key-value pair into the map of user objects.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#putUserObject(java.lang.Object,%20java.lang.Object)">putUserObject</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="lock()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lock</h4>
<pre>public&nbsp;void&nbsp;lock()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#lock()">BrokerFactory</a></code></strong></div>
<div class="block">Synchronizes on an internal lock.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#lock()">lock</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="unlock()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unlock</h4>
<pre>public&nbsp;void&nbsp;unlock()</pre>
<div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#unlock()">BrokerFactory</a></code></strong></div>
<div class="block">Release the internal lock.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#unlock()">unlock</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="readResolve()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readResolve</h4>
<pre>protected&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;readResolve()
throws <a href="http://download.oracle.com/javase/6/docs/api/java/io/ObjectStreamException.html?is-external=true" title="class or interface in java.io">ObjectStreamException</a></pre>
<div class="block">Replaces the factory with this JVMs pooled version if it exists. Also
freezes the factory.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/io/ObjectStreamException.html?is-external=true" title="class or interface in java.io">ObjectStreamException</a></code></dd></dl>
</li>
</ul>
<a name="newStoreManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newStoreManager</h4>
<pre>protected abstract&nbsp;<a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel">StoreManager</a>&nbsp;newStoreManager()</pre>
<div class="block">Return a new StoreManager for this runtime. Note that the instance
returned here may be wrapped before being passed to the
<a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newBroker()"><code>newBroker()</code></a> method.</div>
</li>
</ul>
<a name="findBroker(java.lang.String, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findBroker</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;findBroker(<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;user,
<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;pass,
boolean&nbsp;managed)</pre>
<div class="block">Find a pooled broker, or return null if none. If using
managed transactions, looks for a transactional broker;
otherwise returns null by default. This method will be called before
<a href="../../../../org/apache/openjpa/kernel/AbstractBrokerFactory.html#newStoreManager()"><code>newStoreManager()</code></a> so that factory subclasses implementing
pooling can return a matching manager before a new <a href="../../../../org/apache/openjpa/kernel/StoreManager.html" title="interface in org.apache.openjpa.kernel"><code>StoreManager</code></a>
is created.</div>
</li>
</ul>
<a name="newBrokerImpl(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>newBrokerImpl</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/openjpa/kernel/BrokerImpl.html" title="class in org.apache.openjpa.kernel">BrokerImpl</a>&nbsp;newBrokerImpl(<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;user,
<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;pass)</pre>
<div class="block">Return a broker configured with the proper settings.
By default, this method constructs a new
BrokerImpl of the class set for this factory.</div>
</li>
</ul>
<a name="setup()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setup</h4>
<pre>protected&nbsp;void&nbsp;setup()</pre>
<div class="block">Setup transient state used by this factory based on the
current configuration, which will subsequently be locked down. This
method will be called before the first broker is requested,
and will be re-called each time the factory is deserialized into a JVM
that has no configuration for this data store.</div>
</li>
</ul>
<a name="findTransactionalBroker(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>findTransactionalBroker</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;findTransactionalBroker(<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;user,
<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;pass)</pre>
<div class="block">Find a managed runtime broker associated with the
current transaction, or returns null if none.</div>
</li>
</ul>
<a name="configureBroker(org.apache.openjpa.kernel.BrokerImpl)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configureBroker</h4>
<pre>protected&nbsp;void&nbsp;configureBroker(<a href="../../../../org/apache/openjpa/kernel/BrokerImpl.html" title="class in org.apache.openjpa.kernel">BrokerImpl</a>&nbsp;broker)</pre>
<div class="block">Configures the given broker with the current factory option settings.</div>
</li>
</ul>
<a name="makeReadOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeReadOnly</h4>
<pre>public&nbsp;void&nbsp;makeReadOnly()</pre>
<div class="block">Freezes the configuration of this factory.</div>
</li>
</ul>
<a name="getFactoryInitializationBanner()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactoryInitializationBanner</h4>
<pre>protected&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getFactoryInitializationBanner()</pre>
<div class="block">Return an object to be written to the log when this broker factory
initializes. This happens after the configuration is fully loaded.</div>
</li>
</ul>
<a name="assertOpen()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>assertOpen</h4>
<pre>public&nbsp;void&nbsp;assertOpen()</pre>
<div class="block">Throw an exception if the factory is closed. The exact message and
content of the exception varies whether TRACE is enabled or not.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#assertOpen()">assertOpen</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></code></dd>
</dl>
</li>
</ul>
<a name="getOpenBrokers()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOpenBrokers</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../org/apache/openjpa/kernel/Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&gt;&nbsp;getOpenBrokers()</pre>
<div class="block">Returns a set of all the open brokers associated with this factory. The
returned set is unmodifiable, and may contain null references.</div>
</li>
</ul>
<a name="releaseBroker(org.apache.openjpa.kernel.BrokerImpl)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>releaseBroker</h4>
<pre>protected&nbsp;void&nbsp;releaseBroker(<a href="../../../../org/apache/openjpa/kernel/BrokerImpl.html" title="class in org.apache.openjpa.kernel">BrokerImpl</a>&nbsp;broker)</pre>
<div class="block">Release <code>broker</code> from any internal data structures. This
is invoked by <code>broker</code> after the broker is fully closed.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.1.0</dd></dl>
</li>
</ul>
<a name="getPoolKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPoolKey</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getPoolKey()</pre>
<dl><dt><span class="strong">Returns:</span></dt><dd>a key that can be used to obtain this broker factory from the
pool at a later time.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1.0</dd></dl>
</li>
</ul>
<a name="createDelegatingStoreManager()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createDelegatingStoreManager</h4>
<pre>protected&nbsp;<a href="../../../../org/apache/openjpa/kernel/DelegatingStoreManager.html" title="class in org.apache.openjpa.kernel">DelegatingStoreManager</a>&nbsp;createDelegatingStoreManager()</pre>
<div class="block"><P>
Create a DelegatingStoreManager for use with a Broker created by this factory.
If a DataCache has been enabled a DataCacheStoreManager will be returned.
</P>
<P>
If no DataCache is in use an ROPStoreManager will be returned.
</P></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>A delegating store manager suitable for the current
configuration.</dd></dl>
</li>
</ul>
<a name="postCreationCallback()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>postCreationCallback</h4>
<pre>public&nbsp;void&nbsp;postCreationCallback()</pre>
<div class="block">This method is invoked AFTER a BrokerFactory has been instantiated.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html#postCreationCallback()">postCreationCallback</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel">BrokerFactory</a></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/AbstractBrokerFactory.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>Prev Class</li>
<li><a href="../../../../org/apache/openjpa/kernel/AbstractLockManager.html" title="class in org.apache.openjpa.kernel"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/kernel/AbstractBrokerFactory.html" target="_top">Frames</a></li>
<li><a href="AbstractBrokerFactory.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><a href="#constructor_summary">Constr</a>&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><a href="#constructor_detail">Constr</a>&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>