Apache
/
openjpa
mirror of https://github.com/apache/openjpa.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

OPENJPA-858: Document openjpa.Callbacks plug-in options 

git-svn-id: https://svn.apache.org/repos/asf/openjpa/trunk@734347 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Pinaki Poddar 2009-01-14 06:39:26 +00:00
parent 2e2618407d
commit b65b9b2471
1 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
openjpa-project/src/doc/manual/ref_guide_conf.xml
View File

@ -649,6 +649,53 @@ org.apache.openjpa.kernel.Broker</classname></ulink> type to use at runtime. See
<xref linkend="ref_guide_runtime_broker_extension"/> on for details.
</para>
</section>
<section id="openjpa.Callbacks">
<title>openjpa.Callbacks</title>
<indexterm zone="openjpa.Callbacks">
<primary>Callbacks</primary>
</indexterm>
<indexterm>
<primary>Callbacks</primary>
<see>Callbacks</see>
</indexterm>
<para>
<emphasis role="bold">Property name: </emphasis><literal>openjpa.Callbacks</literal>
</para>
<para>
<emphasis role="bold">Configuration API:</emphasis>
<ulink url="../javadoc/org/apache/openjpa/conf/OpenJPAConfiguration.html#getCallbackOptionsInstance()">
<methodname>org.apache.openjpa.conf.OpenJPAConfiguration.getCallbackOptionsInstance</methodname></ulink>
</para>
<para>
<emphasis role="bold">Resource adaptor config-property: </emphasis><literal>Callbacks</literal>
</para>
<para>
<emphasis role="bold">Default: </emphasis><literal>default</literal>
</para>
<para>
<emphasis role="bold">Description:</emphasis> A plugin string (see
<xref linkend="ref_guide_conf_plugins"/>) to fine tune some of the configurable
properties related to callbacks. The plug-in supports two boolean properties:
</para>
<itemizedlist>
<listitem>
<para><literal>PostPersistCallbackImmediate</literal>: whether the
post-persist callback is invoked as soon as a new instance
is managed. The default is <literal>false</literal>, implies that
the post-persist callback is invoked after the instance been committed
or flushed to the datastore.
</para>
</listitem>
<listitem>
<para><literal>AllowsMultipleMethodsForSameCallback</literal>: whether
multiple methods of the same class can handle the same callback event.
Defaults to <literal>false</literal>.
</para>
</listitem>
</itemizedlist>
</section>
<section id="openjpa.ClassResolver">
<title>
openjpa.ClassResolver