donaldp 2002/11/12 05:29:48
Modified: info/src/xdocs attributes.xml
Log:
Add some lifecycle hoohaa
Revision Changes Path
1.2 +83 -0 jakarta-avalon-excalibur/info/src/xdocs/attributes.xml
Index: attributes.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/info/src/xdocs/attributes.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- attributes.xml 12 Nov 2002 07:07:49 -0000 1.1
+++ attributes.xml 12 Nov 2002 13:29:48 -0000 1.2
@@ -150,6 +150,89 @@
</attribute>
]]></source>
</subsection>
+ <subsection name="lifecycle">
+ <table>
+ <tr>
+ <th>Target</th>
+ <td>Component,Service</td>
+ </tr>
+ <tr>
+ <th>Allow Multiple</th>
+ <td>false</td>
+ </tr>
+ <tr>
+ <th>Inherit</th>
+ <td>true</td>
+ </tr>
+ <tr>
+ <th>Description</th>
+ <td>The "lifecycle" attribute is used to define
+ the "lifecycle" of a particular component. The lifecycle
+ is defined by a number of parameters. The most important
+ of which is the scope in which a component can be, the scope
+ in which it is visible and the activation policy.
+ </td>
+ </tr>
+ </table>
+
+ <h4>Parameters:</h4>
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Default</th>
+ <th>Required</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>scope</td>
+ <td>application</td>
+ <td>false</td>
+ <td>This defines the scope with in which the the component
is
+ capable of being used. The valid scopes include
"application",
+ "thread", "access" and "transaction". "application" scope
means
+ that each lookup will return the same component. "thread"
scope
+ means that each access in the same thread will return the
same
+ component (usually it also means that the component can
only be used
+ in that thread). "access" scope means that each access will
return a
+ new instance. "transaction" scope means that each access in
the
+ same transaction will return the same component. The notion
of
+ "transaction" is container specific and requires some
context to
+ be shared between the client and the container.</td>
+ </tr>
+ <tr>
+ <td>public</td>
+ <td>false</td>
+ <td>false</td>
+ <td>This parameter specifies whether the component
+ is visible outside this particular partition.</td>
+ </tr>
+ <tr>
+ <td>activation</td>
+ <td>startup</td>
+ <td>false</td>
+ <td>This parameter specifies the activation policy of
+ component. Possible values include "startup" which
+ indicates that the component is created at startup and
+ remains till the application ends. "jit" which means the
+ component is created the first time it is needed.
+ The "on-demand" policy indicates that the component is
+ created when it is needed and that it may be passivated
+ if it is no longer needed. The exact scheduling of
"on-demand"
+ is container specific.</td>
+ </tr>
+ </table>
+
+ <p>The following is an example of a component declaring
+ that it is scoped per access and which can be exported
+ to other partitions.</p>
+ <source>
+ <![CDATA[
+<attribute name="lifestyle">
+ <param name="scope" value="access"/>
+ <param name="public" value="true"/>
+</attribute>
+ ]]></source>
+ </subsection>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:avalon-cvs-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-cvs-help@;jakarta.apache.org>
