blob: 376ea21f0f86abe34d6bb0a646c181b23ecefb52 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="it">
<head>
<!-- Generated by javadoc (version 1.7.0_80) on Thu Jun 14 10:04:13 CEST 2018 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.apache.openjpa.event (OpenJPA Parent POM 2.4.3 API)</title>
<meta name="date" content="2018-06-14">
<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="org.apache.openjpa.event (OpenJPA Parent POM 2.4.3 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/enhance/stats/package-summary.html">Prev Package</a></li>
<li><a href="../../../../org/apache/openjpa/instrumentation/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/event/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;org.apache.openjpa.event</h1>
<div class="docSummary">
<div class="block"><strong>OpenJPA Events</strong>
This package provides some interfaces and useful implementations
for OpenJPA's event notification framework.</div>
</div>
<p>See:&nbsp;<a href="#package_description">Description</a></p>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/AttachListener.html" title="interface in org.apache.openjpa.event">AttachListener</a></td>
<td class="colLast">
<div class="block">Listener for when a detached instance is attached.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/BeginTransactionListener.html" title="interface in org.apache.openjpa.event">BeginTransactionListener</a></td>
<td class="colLast">
<div class="block">Notified when transactions begin.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/BrokerFactoryListener.html" title="interface in org.apache.openjpa.event">BrokerFactoryListener</a></td>
<td class="colLast">
<div class="block">Interface for listening to <a href="../../../../org/apache/openjpa/event/BrokerFactoryEvent.html" title="class in org.apache.openjpa.event"><code>BrokerFactoryEvent</code></a> objects.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/CallbackModes.html" title="interface in org.apache.openjpa.event">CallbackModes</a></td>
<td class="colLast">
<div class="block">Callback handling constants.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/ClearListener.html" title="interface in org.apache.openjpa.event">ClearListener</a></td>
<td class="colLast">
<div class="block">Listener for when persistent state is cleared from an instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/DeleteListener.html" title="interface in org.apache.openjpa.event">DeleteListener</a></td>
<td class="colLast">
<div class="block">Listener for when a persistent instance is deleted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/DetachListener.html" title="interface in org.apache.openjpa.event">DetachListener</a></td>
<td class="colLast">
<div class="block">Listener for when a persistent instance is detached.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/DirtyListener.html" title="interface in org.apache.openjpa.event">DirtyListener</a></td>
<td class="colLast">
<div class="block">Listener for when a persistent instance becomes dirty.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/EndTransactionListener.html" title="interface in org.apache.openjpa.event">EndTransactionListener</a></td>
<td class="colLast">
<div class="block">Notified when transactions end.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/FlushTransactionListener.html" title="interface in org.apache.openjpa.event">FlushTransactionListener</a></td>
<td class="colLast">
<div class="block">Notified on transaction flush.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/LifecycleCallbacks.html" title="interface in org.apache.openjpa.event">LifecycleCallbacks</a></td>
<td class="colLast">
<div class="block">A lifecycle listener that responds to callbacks rather than events.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/LifecycleEventManager.ListenerAdapter.html" title="interface in org.apache.openjpa.event">LifecycleEventManager.ListenerAdapter</a></td>
<td class="colLast">
<div class="block">Interface that facades to other lifecycle listener interfaces can
implement to choose which events to respond to based on their delegate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/LifecycleListener.html" title="interface in org.apache.openjpa.event">LifecycleListener</a></td>
<td class="colLast">
<div class="block">Interface for listening to all <a href="../../../../org/apache/openjpa/event/LifecycleEvent.html" title="class in org.apache.openjpa.event"><code>LifecycleEvent</code></a>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/LoadListener.html" title="interface in org.apache.openjpa.event">LoadListener</a></td>
<td class="colLast">
<div class="block">Listener for when state is loaded into a persistent instnace.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/OrphanedKeyAction.html" title="interface in org.apache.openjpa.event">OrphanedKeyAction</a></td>
<td class="colLast">
<div class="block">Perform an action when OpenJPA detects an orphaned key in the database.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/PersistListener.html" title="interface in org.apache.openjpa.event">PersistListener</a></td>
<td class="colLast">
<div class="block">Listener for newly-persisted instances.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/PostDeleteListener.html" title="interface in org.apache.openjpa.event">PostDeleteListener</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/PostPersistListener.html" title="interface in org.apache.openjpa.event">PostPersistListener</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event">RemoteCommitListener</a></td>
<td class="colLast">
<div class="block">An entity that wishes to be notified when Brokers
associated with remote BrokerFactories commit.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event">RemoteCommitProvider</a></td>
<td class="colLast">
<div class="block">An entity that is responsible for communicating commit
notification to other <a href="../../../../org/apache/openjpa/event/RemoteCommitEventManager.html" title="class in org.apache.openjpa.event"><code>RemoteCommitEventManager</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/StoreListener.html" title="interface in org.apache.openjpa.event">StoreListener</a></td>
<td class="colLast">
<div class="block">Listener for when persistent instances are stored to the database.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/TransactionListener.html" title="interface in org.apache.openjpa.event">TransactionListener</a></td>
<td class="colLast">
<div class="block">Interface for listening to all <a href="../../../../org/apache/openjpa/event/TransactionEvent.html" title="class in org.apache.openjpa.event"><code>TransactionEvent</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/UpdateListener.html" title="interface in org.apache.openjpa.event">UpdateListener</a></td>
<td class="colLast">&nbsp;</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="packageSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/AbstractLifecycleListener.html" title="class in org.apache.openjpa.event">AbstractLifecycleListener</a></td>
<td class="colLast">
<div class="block">Abstract implementation of the <a href="../../../../org/apache/openjpa/event/LifecycleListener.html" title="interface in org.apache.openjpa.event"><code>LifecycleListener</code></a> interface
which delegates events to a single method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/AbstractRemoteCommitProvider.html" title="class in org.apache.openjpa.event">AbstractRemoteCommitProvider</a></td>
<td class="colLast">
<div class="block">Abstract implementation of <a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitProvider</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/AbstractTransactionListener.html" title="class in org.apache.openjpa.event">AbstractTransactionListener</a></td>
<td class="colLast">
<div class="block">Abstract implementation of the <a href="../../../../org/apache/openjpa/event/TransactionListener.html" title="interface in org.apache.openjpa.event"><code>TransactionListener</code></a> interface
that provides no-op implementations of all methods.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/BeanLifecycleCallbacks.html" title="class in org.apache.openjpa.event">BeanLifecycleCallbacks</a></td>
<td class="colLast">
<div class="block">Performs a callback method on a cached bean instance.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/BrokerFactoryEvent.html" title="class in org.apache.openjpa.event">BrokerFactoryEvent</a></td>
<td class="colLast">
<div class="block">Event fired when a <a href="../../../../org/apache/openjpa/kernel/BrokerFactory.html" title="interface in org.apache.openjpa.kernel"><code>BrokerFactory</code></a> is created.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/BrokerFactoryEventManager.html" title="class in org.apache.openjpa.event">BrokerFactoryEventManager</a></td>
<td class="colLast">
<div class="block"><code>EventManager</code> responsible for notifying listeners of
<a href="../../../../org/apache/openjpa/event/BrokerFactoryEvent.html" title="class in org.apache.openjpa.event"><code>BrokerFactoryEvent</code></a>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/ExceptionOrphanedKeyAction.html" title="class in org.apache.openjpa.event">ExceptionOrphanedKeyAction</a></td>
<td class="colLast">
<div class="block">Throw a <a href="../../../../org/apache/openjpa/util/ObjectNotFoundException.html" title="class in org.apache.openjpa.util"><code>ObjectNotFoundException</code></a> when an orphaned key is discovered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/JMSRemoteCommitProvider.html" title="class in org.apache.openjpa.event">JMSRemoteCommitProvider</a></td>
<td class="colLast">
<div class="block">JMS-based implementation of <a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitProvider</code></a> that
listens for object modifications and propagates those changes to
other RemoteCommitProviders over a JMS topic.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/LifecycleEvent.html" title="class in org.apache.openjpa.event">LifecycleEvent</a></td>
<td class="colLast">
<div class="block">Lifecycle event on a persistent instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/LifecycleEventManager.html" title="class in org.apache.openjpa.event">LifecycleEventManager</a></td>
<td class="colLast">
<div class="block">Manager that can be used to track and notify listeners on lifecycle events.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/LifecycleEventManager.ListenerList.html" title="class in org.apache.openjpa.event">LifecycleEventManager.ListenerList</a></td>
<td class="colLast">
<div class="block">Extended list that tracks what event types its elements care about.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/LogOrphanedKeyAction.html" title="class in org.apache.openjpa.event">LogOrphanedKeyAction</a></td>
<td class="colLast">
<div class="block">Log a message when an orphaned key is discovered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/MethodLifecycleCallbacks.html" title="class in org.apache.openjpa.event">MethodLifecycleCallbacks</a></td>
<td class="colLast">
<div class="block">Callback adapter that invokes a callback method via reflection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/NoneOrphanedKeyAction.html" title="class in org.apache.openjpa.event">NoneOrphanedKeyAction</a></td>
<td class="colLast">
<div class="block">Does nothing when an orphaned key is discovered.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/RemoteCommitEvent.html" title="class in org.apache.openjpa.event">RemoteCommitEvent</a></td>
<td class="colLast">
<div class="block">Event type to hold the IDs of additions, updates, and
deletes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/RemoteCommitEventManager.html" title="class in org.apache.openjpa.event">RemoteCommitEventManager</a></td>
<td class="colLast">
<div class="block">Manager that can be used to track and notify
<a href="../../../../org/apache/openjpa/event/RemoteCommitListener.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitListener</code></a>s on remote commit events.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/SingleJVMRemoteCommitProvider.html" title="class in org.apache.openjpa.event">SingleJVMRemoteCommitProvider</a></td>
<td class="colLast">
<div class="block">Single-JVM-only implementation of <a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitProvider</code></a>
that listens for object modifications and propagates those changes
to other SingleJVMRemoteCommitProviders in the same JVM.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/TCPRemoteCommitProvider.html" title="class in org.apache.openjpa.event">TCPRemoteCommitProvider</a></td>
<td class="colLast">
<div class="block">TCP-based implementation of <a href="../../../../org/apache/openjpa/event/RemoteCommitProvider.html" title="interface in org.apache.openjpa.event"><code>RemoteCommitProvider</code></a> that
listens for object modifications and propagates those changes to
other RemoteCommitProviders over TCP sockets.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a></td>
<td class="colLast">
<div class="block">A transactional event.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../org/apache/openjpa/event/TransactionEventManager.html" title="class in org.apache.openjpa.event">TransactionEventManager</a></td>
<td class="colLast">
<div class="block">Manager that can be used to track and notify transaction listeners
of transaction-related events.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
<a name="package_description">
<!-- -->
</a>
<h2 title="Package org.apache.openjpa.event Description">Package org.apache.openjpa.event Description</h2>
<div class="block"><p><strong>OpenJPA Events</strong></p>
<p>
This package provides some interfaces and useful implementations
for OpenJPA's event notification framework. This framework
allows efficient notification of object modifications and
transaction changes.
</p></div>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/enhance/stats/package-summary.html">Prev Package</a></li>
<li><a href="../../../../org/apache/openjpa/instrumentation/package-summary.html">Next Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/openjpa/event/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2018 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>