You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by cs...@apache.org on 2007/02/09 19:22:49 UTC
svn commit: r505402 -
/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/serialization.xml
Author: cschoett
Date: Fri Feb 9 10:22:48 2007
New Revision: 505402
URL: http://svn.apache.org/viewvc?view=rev&rev=505402
Log:
A bit of cleanup to the new controls serialization doc.
Modified:
beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/serialization.xml
Modified: beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/serialization.xml
URL: http://svn.apache.org/viewvc/beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/serialization.xml?view=diff&rev=505402&r1=505401&r2=505402
==============================================================================
--- beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/serialization.xml (original)
+++ beehive/trunk/docs/forrest/release/src/documentation/content/xdocs/controls/serialization.xml Fri Feb 9 10:22:48 2007
@@ -26,9 +26,15 @@
<section id="overview">
<title>Overview</title>
<p>
+ This document describes control serialization. Typically control serialization is initiated by
+ the runtime container; however, serialization may also be inititated programatically by a controls
+ developer. For either case the process described in the Serialization Steps section of this document
+ are the same.
+ <!--
This document describes what happens when a control is serialized by its runtime container. All controls
are serializable by default but may be marked as transient if they contain state which does not need
to be serialized.
+ -->
</p>
</section>
<section id="istransient">
@@ -58,8 +64,10 @@
<title>XML vs Java Serialization</title>
<p>
Beehive controls support standard Java serialization as well as XML serialization. All of the necessary
- java.beans.PersistenceDelegate implementations already exist in the controls framework to support XML
- serialization via the java.beans.XMLEncoder/java.beans.XMLDecoder classes.
+ <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/beans/PersistenceDelegate.html">PersistenceDelegate</a>
+ implementations already exist in the controls framework to support XML
+ serialization using the <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/beans/XMLEncoder.html">XMLEncoder</a>
+ and <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/beans/XMLDecoder.html">XMLDecoder</a> classes.
</p>
</section>
@@ -69,14 +77,13 @@
Before serialization can occur, the current ResourceContext must be ended for all controls within the
ControlContainerContext (CCC). Typically this is accomplished by a call to the CCC's endContext()
method. The endContext() method causes an onRelease resource event to be fired to all controls within
- the CCC. Controls with onRelease event listeners then have the opportunity to release any resources
- (such as JDBC connections, JNDI contexts, sessions, etc) before serialization.
+ the CCC. Any controls with onRelease event listeners then have the opportunity to release any resources
+ (such as JDBC connections, JNDI contexts, sessions, etc) before serialization occurs.
</p>
<p>
- When deserialization occurs these resources can then be re-acquired by the control after a new
- ResourceContext has been established by the CCC and each control is notified with on onAcquire
- resource event.
+ During deserialization resources can be reacquired by the control once a new ResourceContext has been
+ established by the CCC. Each control then gets notified with on onAcquire resource event.
</p>
<p>
@@ -85,22 +92,26 @@
<ol>
<li>
- Service providers (java.beans.beancontext.BeanContextServiceProvider) registered with the
- ControlBeanContextServicesSupport instance are serialized, including any registered
- ServiceProviderListeners which have been registered for those services.
+ Service providers (
+ <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/beans/beancontext/BeanContextServiceProvider.html">
+ BeanContextServiceProvider</a>) registered with the ControlBeanContextServicesSupport instance are
+ serialized, including any registered
+ <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/beans/beancontext/BeanContextServicesListener.html">
+ BeanContextServicesListeners</a> which have been registered for those services.
</li>
<li>
- Next the children of the CCC are serialized. Children include ControlBeans as well as each
- ControlBean's ControlBeanContext. Any registered BeanContextMembershipListeners are also
- serialized at this point.
+ Next the children of the CCC are serialized. Children of the CCC include ControlBeans as well as
+ each ControlBean's ControlBeanContext. Any registered
+ <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/beans/beancontext/BeanContextMembershipListener.html">
+ BeanContextMembershipListeners</a> are also serialized.
</li>
<li>
Each ControlBean contains a reference to a control implementation class which gets serialized
- at this point as well (unless the implementation's isTransient annotation attribute is set
- to true, which case it will not be serialized).
+ as well (unless the implementation's isTransient annotation attribute is set to true, which case it
+ will not be serialized).
</li>
<li>
- The control's property state gets serialized at this point as well.
+ The ControlBean contains the control's property state which gets serialized as part of the ControlBean.
</li>
</ol>
</section>