blob: 07d63459f92694d7bf7e337664986c41f04f307f [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang>
<head>
<!-- Generated by javadoc -->
<title>AuditManager (OpenJPA Parent POM 4.1.1 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.7.1.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="AuditManager (OpenJPA Parent POM 4.1.1 API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AuditManager.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" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.apache.openjpa.kernel</a></div>
<h2 title="Class AuditManager" class="title">Class AuditManager</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="InMemorySavepointManager.html" title="class in org.apache.openjpa.kernel">org.apache.openjpa.kernel.InMemorySavepointManager</a></li>
<li>
<ul class="inheritance">
<li>org.apache.openjpa.kernel.AuditManager</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../enhance/PCRegistry.RegisterClassListener.html" title="interface in org.apache.openjpa.enhance">PCRegistry.RegisterClassListener</a></code>, <code><a href="../event/BeginTransactionListener.html" title="interface in org.apache.openjpa.event">BeginTransactionListener</a></code>, <code><a href="../event/EndTransactionListener.html" title="interface in org.apache.openjpa.event">EndTransactionListener</a></code>, <code><a href="../event/FlushTransactionListener.html" title="interface in org.apache.openjpa.event">FlushTransactionListener</a></code>, <code><a href="../event/TransactionListener.html" title="interface in org.apache.openjpa.event">TransactionListener</a></code>, <code><a href="SavepointManager.html" title="interface in org.apache.openjpa.kernel">SavepointManager</a></code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">AuditManager</span>
extends <a href="InMemorySavepointManager.html" title="class in org.apache.openjpa.kernel">InMemorySavepointManager</a>
implements <a href="../event/TransactionListener.html" title="interface in org.apache.openjpa.event">TransactionListener</a>, <a href="../enhance/PCRegistry.RegisterClassListener.html" title="interface in org.apache.openjpa.enhance">PCRegistry.RegisterClassListener</a></pre>
<div class="block">Controller for audit facility.
This controller performs the following basic duties:
<LI> Records auditable types at class loading time
<LI> Listens to instance life cycle changes and transaction.
<LI> Collects auditable instances on instance life cycle changes.
<LI> Delegates real auditing to the <a href="../audit/Auditor.html" title="interface in org.apache.openjpa.audit"><code>Auditor</code></a> at transaction boundary.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Pinaki Poddar</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.apache.openjpa.audit.Auditor)">AuditManager</a></span>&#8203;(<a href="../audit/Auditor.html" title="interface in org.apache.openjpa.audit">Auditor</a>&nbsp;auditor)</code></th>
<td class="colLast">&nbsp;</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterBegin(org.apache.openjpa.event.TransactionEvent)">afterBegin</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">-----------------------------------------------------------------------
Transaction callbacks</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterCommit(org.apache.openjpa.event.TransactionEvent)">afterCommit</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Notification that a transaction has successfully committed.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterCommitComplete(org.apache.openjpa.event.TransactionEvent)">afterCommitComplete</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Notification that a transaction has successfully committed and
the transaction is no longer active.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterFlush(org.apache.openjpa.event.TransactionEvent)">afterFlush</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Notification that a transaction has flushed all object changes.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterRollback(org.apache.openjpa.event.TransactionEvent)">afterRollback</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Notification that a transaction has been rolled back.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterRollbackComplete(org.apache.openjpa.event.TransactionEvent)">afterRollbackComplete</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Notification that a transaction has been rolled back and
the transaction is no longer active.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#afterStateTransitions(org.apache.openjpa.event.TransactionEvent)">afterStateTransitions</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Notification that state transitions are complete.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beforeCommit(org.apache.openjpa.event.TransactionEvent)">beforeCommit</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Notification that the next flush is for the transaction commit.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beforeFlush(org.apache.openjpa.event.TransactionEvent)">beforeFlush</a></span>&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</code></th>
<td class="colLast">
<div class="block">Notification that a transaction is about to flush all object changes.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&gt;</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuditedTypes()">getAuditedTypes</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="../audit/Auditor.html" title="interface in org.apache.openjpa.audit">Auditor</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuditor()">getAuditor</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>protected <a href="Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBroker(org.apache.openjpa.enhance.PersistenceCapable)">getBroker</a></span>&#8203;(<a href="../enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a>&nbsp;pc)</code></th>
<td class="colLast">
<div class="block">Extracts the broker from the given persistence capable instance.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>protected <a href="../enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPersistenceCapable(org.apache.openjpa.event.LifecycleEvent)">getPersistenceCapable</a></span>&#8203;(<a href="../event/LifecycleEvent.html" title="class in org.apache.openjpa.event">LifecycleEvent</a>&nbsp;evt)</code></th>
<td class="colLast">
<div class="block">Extracts the persistence capable instance from the source of the given event.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isAuditable(org.apache.openjpa.audit.AuditableOperation,org.apache.openjpa.kernel.StateManagerImpl)">isAuditable</a></span>&#8203;(<a href="../audit/AuditableOperation.html" title="enum in org.apache.openjpa.audit">AuditableOperation</a>&nbsp;op,
<a href="StateManagerImpl.html" title="class in org.apache.openjpa.kernel">StateManagerImpl</a>&nbsp;sm)</code></th>
<td class="colLast">
<div class="block">Affirms if the given state manager is auditable for the given operation.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#register(java.lang.Class)">register</a></span>&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;cls)</code></th>
<td class="colLast">
<div class="block">Records all auditable classes in operation-specific sets.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.org.apache.openjpa.kernel.InMemorySavepointManager">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.openjpa.kernel.<a href="InMemorySavepointManager.html" title="class in org.apache.openjpa.kernel">InMemorySavepointManager</a></h3>
<code><a href="InMemorySavepointManager.html#getPreFlush()">getPreFlush</a>, <a href="InMemorySavepointManager.html#newSavepoint(java.lang.String,org.apache.openjpa.kernel.Broker)">newSavepoint</a>, <a href="InMemorySavepointManager.html#setPreFlush(boolean)">setPreFlush</a>, <a href="InMemorySavepointManager.html#supportsIncrementalFlush()">supportsIncrementalFlush</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang" class="externalLink">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang" class="externalLink">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang" class="externalLink">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang" class="externalLink">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang" class="externalLink">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang" class="externalLink">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang" class="externalLink">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true#wait(long,int)" title="class or interface in java.lang" class="externalLink">wait</a></code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;(org.apache.openjpa.audit.Auditor)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>AuditManager</h4>
<pre>public&nbsp;AuditManager&#8203;(<a href="../audit/Auditor.html" title="interface in org.apache.openjpa.audit">Auditor</a>&nbsp;auditor)</pre>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section>
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="register(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>register</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;register&#8203;(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&nbsp;cls)</pre>
<div class="block">Records all auditable classes in operation-specific sets.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../enhance/PCRegistry.RegisterClassListener.html#register(java.lang.Class)">register</a></code>&nbsp;in interface&nbsp;<code><a href="../enhance/PCRegistry.RegisterClassListener.html" title="interface in org.apache.openjpa.enhance">PCRegistry.RegisterClassListener</a></code></dd>
</dl>
</li>
</ul>
<a id="getAuditor()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuditor</h4>
<pre class="methodSignature">public&nbsp;<a href="../audit/Auditor.html" title="interface in org.apache.openjpa.audit">Auditor</a>&nbsp;getAuditor()</pre>
</li>
</ul>
<a id="getAuditedTypes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAuditedTypes</h4>
<pre class="methodSignature">public&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html?is-external=true" title="class or interface in java.util" class="externalLink">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Class.html?is-external=true" title="class or interface in java.lang" class="externalLink">Class</a>&lt;?&gt;&gt;&nbsp;getAuditedTypes()</pre>
</li>
</ul>
<a id="afterBegin(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterBegin</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterBegin&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block">-----------------------------------------------------------------------
Transaction callbacks.
-----------------------------------------------------------------------</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/BeginTransactionListener.html#afterBegin(org.apache.openjpa.event.TransactionEvent)">afterBegin</a></code>&nbsp;in interface&nbsp;<code><a href="../event/BeginTransactionListener.html" title="interface in org.apache.openjpa.event">BeginTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#AFTER_BEGIN"><code>TransactionEvent.AFTER_BEGIN</code></a></dd>
</dl>
</li>
</ul>
<a id="beforeCommit(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beforeCommit</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;beforeCommit&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../event/EndTransactionListener.html#beforeCommit(org.apache.openjpa.event.TransactionEvent)">EndTransactionListener</a></code></span></div>
<div class="block">Notification that the next flush is for the transaction commit.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/EndTransactionListener.html#beforeCommit(org.apache.openjpa.event.TransactionEvent)">beforeCommit</a></code>&nbsp;in interface&nbsp;<code><a href="../event/EndTransactionListener.html" title="interface in org.apache.openjpa.event">EndTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#BEFORE_COMMIT"><code>TransactionEvent.BEFORE_COMMIT</code></a></dd>
</dl>
</li>
</ul>
<a id="afterCommit(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterCommit</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterCommit&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../event/EndTransactionListener.html#afterCommit(org.apache.openjpa.event.TransactionEvent)">EndTransactionListener</a></code></span></div>
<div class="block">Notification that a transaction has successfully committed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/EndTransactionListener.html#afterCommit(org.apache.openjpa.event.TransactionEvent)">afterCommit</a></code>&nbsp;in interface&nbsp;<code><a href="../event/EndTransactionListener.html" title="interface in org.apache.openjpa.event">EndTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#AFTER_COMMIT"><code>TransactionEvent.AFTER_COMMIT</code></a></dd>
</dl>
</li>
</ul>
<a id="afterRollback(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterRollback</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterRollback&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../event/EndTransactionListener.html#afterRollback(org.apache.openjpa.event.TransactionEvent)">EndTransactionListener</a></code></span></div>
<div class="block">Notification that a transaction has been rolled back.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/EndTransactionListener.html#afterRollback(org.apache.openjpa.event.TransactionEvent)">afterRollback</a></code>&nbsp;in interface&nbsp;<code><a href="../event/EndTransactionListener.html" title="interface in org.apache.openjpa.event">EndTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#AFTER_ROLLBACK"><code>TransactionEvent.AFTER_ROLLBACK</code></a></dd>
</dl>
</li>
</ul>
<a id="afterCommitComplete(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterCommitComplete</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterCommitComplete&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../event/EndTransactionListener.html#afterCommitComplete(org.apache.openjpa.event.TransactionEvent)">EndTransactionListener</a></code></span></div>
<div class="block">Notification that a transaction has successfully committed and
the transaction is no longer active.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/EndTransactionListener.html#afterCommitComplete(org.apache.openjpa.event.TransactionEvent)">afterCommitComplete</a></code>&nbsp;in interface&nbsp;<code><a href="../event/EndTransactionListener.html" title="interface in org.apache.openjpa.event">EndTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#AFTER_COMMIT_COMPLETE"><code>TransactionEvent.AFTER_COMMIT_COMPLETE</code></a></dd>
</dl>
</li>
</ul>
<a id="afterRollbackComplete(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterRollbackComplete</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterRollbackComplete&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../event/EndTransactionListener.html#afterRollbackComplete(org.apache.openjpa.event.TransactionEvent)">EndTransactionListener</a></code></span></div>
<div class="block">Notification that a transaction has been rolled back and
the transaction is no longer active.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/EndTransactionListener.html#afterRollbackComplete(org.apache.openjpa.event.TransactionEvent)">afterRollbackComplete</a></code>&nbsp;in interface&nbsp;<code><a href="../event/EndTransactionListener.html" title="interface in org.apache.openjpa.event">EndTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#AFTER_ROLLBACK_COMPLETE"><code>TransactionEvent.AFTER_ROLLBACK_COMPLETE</code></a></dd>
</dl>
</li>
</ul>
<a id="beforeFlush(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beforeFlush</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;beforeFlush&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../event/FlushTransactionListener.html#beforeFlush(org.apache.openjpa.event.TransactionEvent)">FlushTransactionListener</a></code></span></div>
<div class="block">Notification that a transaction is about to flush all object changes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/FlushTransactionListener.html#beforeFlush(org.apache.openjpa.event.TransactionEvent)">beforeFlush</a></code>&nbsp;in interface&nbsp;<code><a href="../event/FlushTransactionListener.html" title="interface in org.apache.openjpa.event">FlushTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#BEFORE_FLUSH"><code>TransactionEvent.BEFORE_FLUSH</code></a></dd>
</dl>
</li>
</ul>
<a id="afterFlush(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterFlush</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterFlush&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../event/FlushTransactionListener.html#afterFlush(org.apache.openjpa.event.TransactionEvent)">FlushTransactionListener</a></code></span></div>
<div class="block">Notification that a transaction has flushed all object changes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/FlushTransactionListener.html#afterFlush(org.apache.openjpa.event.TransactionEvent)">afterFlush</a></code>&nbsp;in interface&nbsp;<code><a href="../event/FlushTransactionListener.html" title="interface in org.apache.openjpa.event">FlushTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#AFTER_FLUSH"><code>TransactionEvent.AFTER_FLUSH</code></a></dd>
</dl>
</li>
</ul>
<a id="afterStateTransitions(org.apache.openjpa.event.TransactionEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>afterStateTransitions</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;afterStateTransitions&#8203;(<a href="../event/TransactionEvent.html" title="class in org.apache.openjpa.event">TransactionEvent</a>&nbsp;event)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../event/EndTransactionListener.html#afterStateTransitions(org.apache.openjpa.event.TransactionEvent)">EndTransactionListener</a></code></span></div>
<div class="block">Notification that state transitions are complete.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../event/EndTransactionListener.html#afterStateTransitions(org.apache.openjpa.event.TransactionEvent)">afterStateTransitions</a></code>&nbsp;in interface&nbsp;<code><a href="../event/EndTransactionListener.html" title="interface in org.apache.openjpa.event">EndTransactionListener</a></code></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../event/TransactionEvent.html#AFTER_STATE_TRANSITIONS"><code>TransactionEvent.AFTER_STATE_TRANSITIONS</code></a></dd>
</dl>
</li>
</ul>
<a id="getPersistenceCapable(org.apache.openjpa.event.LifecycleEvent)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPersistenceCapable</h4>
<pre class="methodSignature">protected&nbsp;<a href="../enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a>&nbsp;getPersistenceCapable&#8203;(<a href="../event/LifecycleEvent.html" title="class in org.apache.openjpa.event">LifecycleEvent</a>&nbsp;evt)</pre>
<div class="block">Extracts the persistence capable instance from the source of the given event.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if an instance can not be extracted.</dd>
</dl>
</li>
</ul>
<a id="getBroker(org.apache.openjpa.enhance.PersistenceCapable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBroker</h4>
<pre class="methodSignature">protected&nbsp;<a href="Broker.html" title="interface in org.apache.openjpa.kernel">Broker</a>&nbsp;getBroker&#8203;(<a href="../enhance/PersistenceCapable.html" title="interface in org.apache.openjpa.enhance">PersistenceCapable</a>&nbsp;pc)</pre>
<div class="block">Extracts the broker from the given persistence capable instance.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pc</code> - a persistence capable instance</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>null if a Broker can notbe extracted</dd>
</dl>
</li>
</ul>
<a id="isAuditable(org.apache.openjpa.audit.AuditableOperation,org.apache.openjpa.kernel.StateManagerImpl)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isAuditable</h4>
<pre class="methodSignature">protected&nbsp;boolean&nbsp;isAuditable&#8203;(<a href="../audit/AuditableOperation.html" title="enum in org.apache.openjpa.audit">AuditableOperation</a>&nbsp;op,
<a href="StateManagerImpl.html" title="class in org.apache.openjpa.kernel">StateManagerImpl</a>&nbsp;sm)</pre>
<div class="block">Affirms if the given state manager is auditable for the given operation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>op</code> - an auditable operation</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AuditManager.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" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</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 id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2025 <a href="http://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</body>
</html>