You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by sk...@apache.org on 2008/03/11 19:23:19 UTC
svn commit: r636050 - in /myfaces/orchestra/trunk/maven/src/site/xdoc:
download.xml index.xml
Author: skitching
Date: Tue Mar 11 11:23:15 2008
New Revision: 636050
URL: http://svn.apache.org/viewvc?rev=636050&view=rev
Log:
Replace tabs with spaces only
Modified:
myfaces/orchestra/trunk/maven/src/site/xdoc/download.xml
myfaces/orchestra/trunk/maven/src/site/xdoc/index.xml
Modified: myfaces/orchestra/trunk/maven/src/site/xdoc/download.xml
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/maven/src/site/xdoc/download.xml?rev=636050&r1=636049&r2=636050&view=diff
==============================================================================
--- myfaces/orchestra/trunk/maven/src/site/xdoc/download.xml (original)
+++ myfaces/orchestra/trunk/maven/src/site/xdoc/download.xml Tue Mar 11 11:23:15 2008
@@ -1,73 +1,73 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//Apache Software Foundation//DTD XDOC 1.0//EN"
- "http://www.apache.org/dtd/xdoc.dtd">
+ "http://www.apache.org/dtd/xdoc.dtd">
<document>
- <properties>
- <title>About Apache MyFaces Orchestra</title>
- </properties>
+ <properties>
+ <title>About Apache MyFaces Orchestra</title>
+ </properties>
- <body>
- <section name="Download">
+ <body>
+ <section name="Download">
<subsection name="Release">
- <p>
- Use the links below to download a distribution of Apache MyFaces Orchestra
- from one of our mirrors. It is good practice to verify the integrity of
- the distribution files.
- </p>
- <p>
- You will be prompted for a mirror - if the file is not found on yours,
- please be patient, as it may take 24 hours to reach all mirrors.
- </p>
- <p>
- Apache MyFaces Orchestra is distributed as a zip archive (for Windows)
- and as a tar.gz archive (for UNIX). The contents are the same.
- Please note that the tar.gz archives contain file names longer than
- 100 characters and have been created using GNU tar extensions. Thus
- they must be untarred with a GNU compatible version of tar.
- </p>
- <p>
- <b>Apache MyFaces Orchestra Core 1.0 Distribution</b>
+ <p>
+ Use the links below to download a distribution of Apache MyFaces Orchestra
+ from one of our mirrors. It is good practice to verify the integrity of
+ the distribution files.
+ </p>
+ <p>
+ You will be prompted for a mirror - if the file is not found on yours,
+ please be patient, as it may take 24 hours to reach all mirrors.
+ </p>
+ <p>
+ Apache MyFaces Orchestra is distributed as a zip archive (for Windows)
+ and as a tar.gz archive (for UNIX). The contents are the same.
+ Please note that the tar.gz archives contain file names longer than
+ 100 characters and have been created using GNU tar extensions. Thus
+ they must be untarred with a GNU compatible version of tar.
+ </p>
+ <p>
+ <b>Apache MyFaces Orchestra Core 1.0 Distribution</b>
<table>
- <tr>
- <th>Archive</th>
- <th>Mirrors</th>
- <th>Checksum</th>
- <th>Signature</th>
- </tr>
- <tr>
- <td>Apache MyFaces Orchestra Core 1.0 (tar.gz)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.tar.gz">myfaces-orchestra-core-1.0.tar.gz</a></td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.tar.gz.md5">myfaces-orchestra-core-1.0.tar.gz.md5</a></td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.tar.gz.asc">myfaces-orchestra-core-1.0.tar.gz.asc</a></td>
- </tr><tr>
- <td>Apache MyFaces Orchestra Core 1.0 (zip)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.zip">myfaces-orchestra-core-1.0.zip</a></td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.zip.md5">myfaces-orchestra-core-1.0.zip.md5</a></td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.zip.asc">myfaces-orchestra-core-1.0.zip.asc</a></td>
- </tr>
+ <tr>
+ <th>Archive</th>
+ <th>Mirrors</th>
+ <th>Checksum</th>
+ <th>Signature</th>
+ </tr>
+ <tr>
+ <td>Apache MyFaces Orchestra Core 1.0 (tar.gz)</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.tar.gz">myfaces-orchestra-core-1.0.tar.gz</a></td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.tar.gz.md5">myfaces-orchestra-core-1.0.tar.gz.md5</a></td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.tar.gz.asc">myfaces-orchestra-core-1.0.tar.gz.asc</a></td>
+ </tr><tr>
+ <td>Apache MyFaces Orchestra Core 1.0 (zip)</td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.zip">myfaces-orchestra-core-1.0.zip</a></td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.zip.md5">myfaces-orchestra-core-1.0.zip.md5</a></td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/myfaces/binaries/myfaces-orchestra-core-1.0.zip.asc">myfaces-orchestra-core-1.0.zip.asc</a></td>
+ </tr>
</table>
- </p>
- </subsection>
+ </p>
+ </subsection>
<subsection name="Snapshot">
- Use our maven snapshot repository to download the latest build <a href="http://people.apache.org/repo/m2-snapshot-repository/org/apache/myfaces/orchestra">http://people.apache.org/repo/m2-snapshot-repository/org/apache/myfaces/orchestra</a>
+ Use our maven snapshot repository to download the latest build <a href="http://people.apache.org/repo/m2-snapshot-repository/org/apache/myfaces/orchestra">http://people.apache.org/repo/m2-snapshot-repository/org/apache/myfaces/orchestra</a>
</subsection>
<subsection name="Build from source">
- The easiest way is to download the Apache MyFaces codebase and build them all
- <pre>
+ The easiest way is to download the Apache MyFaces codebase and build them all
+ <pre>
# svn checkout https://svn.apache.org/repos/asf/myfaces/current myfaces
# cd myfaces
# mvn install
- </pre>
- This will create "target" directories within the structure and create a jar file per module. Simply copy it from there or from the /home/user/.m2/repository directory.
+ </pre>
+ This will create "target" directories within the structure and create a jar file per module. Simply copy it from there or from the /home/user/.m2/repository directory.
</subsection>
<subsection name="Maven 2">
- Add the following xml snipped to your pom.xml.<br />
- Note: core15 is optional.
- <pre>
+ Add the following xml snipped to your pom.xml.<br />
+ Note: core15 is optional.
+ <pre>
<dependency>
<groupId>org.apache.myfaces.orchestra</groupId>
<artifactId>myfaces-orchestra-core</artifactId>
@@ -79,12 +79,12 @@
<artifactId>myfaces-orchestra-core15</artifactId>
<version>wanted_version_number</version>
</dependency>
- </pre>
- If you'd like to work with the nightly builds it is also required that you have the
- Apache Maven Snapshot Repository
- (http://people.apache.org/repo/m2-snapshot-repository) configured.
+ </pre>
+ If you'd like to work with the nightly builds it is also required that you have the
+ Apache Maven Snapshot Repository
+ (http://people.apache.org/repo/m2-snapshot-repository) configured.
</subsection>
- </section>
- </body>
+ </section>
+ </body>
</document>
Modified: myfaces/orchestra/trunk/maven/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/myfaces/orchestra/trunk/maven/src/site/xdoc/index.xml?rev=636050&r1=636049&r2=636050&view=diff
==============================================================================
--- myfaces/orchestra/trunk/maven/src/site/xdoc/index.xml (original)
+++ myfaces/orchestra/trunk/maven/src/site/xdoc/index.xml Tue Mar 11 11:23:15 2008
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//Apache Software Foundation//DTD XDOC 1.0//EN"
- "http://www.apache.org/dtd/xdoc.dtd">
+ "http://www.apache.org/dtd/xdoc.dtd">
<!--
- Note: there is a bug in maven's site generation which causes <p> tags to be lost when <ul> tags are
- also present in the document. See http://jira.codehaus.org/browse/DOXIA-139.
@@ -9,151 +9,151 @@
- fixed (scheduled for DOXIA alpha-9) this workaround can be removed.
-->
<document>
- <properties>
- <title>About Apache MyFaces Orchestra</title>
- </properties>
-
- <body>
- <section name="Apache MyFaces Orchestra">
- <subsection name="Introduction">
- <p>Orchestra is a small library that can be used in web applications to provide the following features:
- <ul>
- <li><p>A conversation (aka dialog) scope for beans.</p></li>
- <li><p>Conversation-scope persistence contexts. This fixes the dreaded LazyInitializationException
- or NonUniqueObjectException problems when working with persistent objects.</p></li>
- <li><p>Declarative transaction annotations (java1.5 only).</p></li>
- <li><p>A "dynaForm" JSF component that helps create forms for editing persistent data.</p></li>
- </ul>
- </p>
- <p>Together these features ease development of applications that perform a lot of persistence
- (ie are strongly coupled with a database). In particular, the dynaForm component (which requires
- the other parts of Orchestra) makes it easy to write the "data entry" type applications that
- Oracle Forms or Microsoft Access specialise in.</p>
- <p>Orchestra currently supports JSF1.1 and JSF1.2, but support should be possible for other
- web presentation frameworks in future.</p>
- <p>Apache MyFaces Orchestra is a relatively new member of the Apache MyFaces project family, but
- has already been used in several real world projects. Check-out our demo-application if you
- want to see more on how it works in practice.</p>
- </subsection>
-
- <subsection name="Dependencies">
- <p>Orchestra requires that Spring 2.x be used to declare managed beans that will be stored in
- conversation context.</p>
- <p>There are no other significant dependencies or structural requirements for code that
- uses Orchestra (in particular, no requirement to use EJBs).</p>
- </subsection>
-
- <subsection name="Structure">
- <p>The Apache MyFaces Orchestra project contains several modules:
- <ul>
- <li><p><a href="myfaces-orchestra-core/index.html">core</a>: The core module is compatible with
- Java 1.4 - which means that you are able to use all this convenient stuff without the
- need to migrate to Java 5.0</p></li>
- <li><p><a href="myfaces-orchestra-core15/index.html">core15</a>: Ok, we admit, we couldn't resist,
- so this package contains Java 5.0 enhancements to the core so that you get cool new
- annotation based stuff as well.</p></li>
- <li><p><a href="myfaces-orchestra-sandbox/index.html">sandbox</a>: An area for components that are
- not yet API-stable, or which depend on unreleased components of other projects.</p></li>
- <li><p><a href="myfaces-orchestra-examples/index.html">examples</a>: Demo apps (currently only one)
- showing off many of Orchestra's features.</p></li>
- </ul>
- </p>
- <p>Follow the links to these modules for further documentation.</p>
- </subsection>
-
- <subsection name="Highlights">
- <ul>
- <li><p>It works with a Java 1.4-compliant syntax, but you can optionally use annotations</p></li>
- <li><p>It utilizes the powerful Spring bean configuration mechanism instead of JSF's
- managed-bean facility. The release of Spring 2.0 made it possible to define custom
- bean scopes in Spring. If a JSF Managed bean is declared in Spring using the
- Orchestra "conversation" scope, then when that bean is referenced from a JSF EL
- expression it is automatically created within that conversation scope. It is not
- necessary for non-conversation-scoped managed beans to be declared via Spring,
- although we do recommend it: request and session scopes are also supported and you
- benefit from having one common syntax for defining the beans of your application,
- from the AOP features Spring provides, and from Spring's other advanced features.</p>
- </li>
- <li><p>A plus for integrating Orchestra into existing applications:
- If you configure your application to use Orchestra, whenever the
- conversational context is opened,
- Spring configured DAOs and BOs automatically use the new context and gain
- from the conversational features of Orchestra. Minimal effort for maximal results!</p>
- </li>
- <li><p>MyFaces Orchestra is know to be compatible to persistence frameworks
- such as Toplink and Hibernate (and generally any JPA-implementation).
- However, any persistence framework can be plugged into Orchestra.</p>
- </li>
- <li><p>The Orchestra API can be adapted to use other web frameworks than JSF.</p></li>
- <li><p>Orchestra sports a very easy to use API - maximum 3 method calls, and you're ready to go.</p></li>
- </ul>
- </subsection>
-
- <subsection name="Limitations">
- <p>
- Orchestra persistence features presume the presentation tier has access to the database,
- i.e. that the presentation and database-access tiers are combined. This is often the case
- in small-to-medium web applications. Large or security-sensitive applications which separate
- database access out into an isolated tier (eg use a "full EB stack") cannot use the Orchestra
- persistence facilities, although they can still make use of the regular conversational support
- for beans in the presentation layer.
- </p>
- </subsection>
-
- <subsection name="A small JSF example">
- <p>For the impatient, here's a quick demonstration of Orchestra's main features.</p>
-
- <p>First, you need to configure a conversation-scoped bean - do that
- in standard Spring-syntax. Define the name of the scope by setting
- the scope-attribute.</p>
+ <properties>
+ <title>About Apache MyFaces Orchestra</title>
+ </properties>
+
+ <body>
+ <section name="Apache MyFaces Orchestra">
+ <subsection name="Introduction">
+ <p>Orchestra is a small library that can be used in web applications to provide the following features:
+ <ul>
+ <li><p>A conversation (aka dialog) scope for beans.</p></li>
+ <li><p>Conversation-scope persistence contexts. This fixes the dreaded LazyInitializationException
+ or NonUniqueObjectException problems when working with persistent objects.</p></li>
+ <li><p>Declarative transaction annotations (java1.5 only).</p></li>
+ <li><p>A "dynaForm" JSF component that helps create forms for editing persistent data.</p></li>
+ </ul>
+ </p>
+ <p>Together these features ease development of applications that perform a lot of persistence
+ (ie are strongly coupled with a database). In particular, the dynaForm component (which requires
+ the other parts of Orchestra) makes it easy to write the "data entry" type applications that
+ Oracle Forms or Microsoft Access specialise in.</p>
+ <p>Orchestra currently supports JSF1.1 and JSF1.2, but support should be possible for other
+ web presentation frameworks in future.</p>
+ <p>Apache MyFaces Orchestra is a relatively new member of the Apache MyFaces project family, but
+ has already been used in several real world projects. Check-out our demo-application if you
+ want to see more on how it works in practice.</p>
+ </subsection>
+
+ <subsection name="Dependencies">
+ <p>Orchestra requires that Spring 2.x be used to declare managed beans that will be stored in
+ conversation context.</p>
+ <p>There are no other significant dependencies or structural requirements for code that
+ uses Orchestra (in particular, no requirement to use EJBs).</p>
+ </subsection>
+
+ <subsection name="Structure">
+ <p>The Apache MyFaces Orchestra project contains several modules:
+ <ul>
+ <li><p><a href="myfaces-orchestra-core/index.html">core</a>: The core module is compatible with
+ Java 1.4 - which means that you are able to use all this convenient stuff without the
+ need to migrate to Java 5.0</p></li>
+ <li><p><a href="myfaces-orchestra-core15/index.html">core15</a>: Ok, we admit, we couldn't resist,
+ so this package contains Java 5.0 enhancements to the core so that you get cool new
+ annotation based stuff as well.</p></li>
+ <li><p><a href="myfaces-orchestra-sandbox/index.html">sandbox</a>: An area for components that are
+ not yet API-stable, or which depend on unreleased components of other projects.</p></li>
+ <li><p><a href="myfaces-orchestra-examples/index.html">examples</a>: Demo apps (currently only one)
+ showing off many of Orchestra's features.</p></li>
+ </ul>
+ </p>
+ <p>Follow the links to these modules for further documentation.</p>
+ </subsection>
+
+ <subsection name="Highlights">
+ <ul>
+ <li><p>It works with a Java 1.4-compliant syntax, but you can optionally use annotations</p></li>
+ <li><p>It utilizes the powerful Spring bean configuration mechanism instead of JSF's
+ managed-bean facility. The release of Spring 2.0 made it possible to define custom
+ bean scopes in Spring. If a JSF Managed bean is declared in Spring using the
+ Orchestra "conversation" scope, then when that bean is referenced from a JSF EL
+ expression it is automatically created within that conversation scope. It is not
+ necessary for non-conversation-scoped managed beans to be declared via Spring,
+ although we do recommend it: request and session scopes are also supported and you
+ benefit from having one common syntax for defining the beans of your application,
+ from the AOP features Spring provides, and from Spring's other advanced features.</p>
+ </li>
+ <li><p>A plus for integrating Orchestra into existing applications:
+ If you configure your application to use Orchestra, whenever the
+ conversational context is opened,
+ Spring configured DAOs and BOs automatically use the new context and gain
+ from the conversational features of Orchestra. Minimal effort for maximal results!</p>
+ </li>
+ <li><p>MyFaces Orchestra is know to be compatible to persistence frameworks
+ such as Toplink and Hibernate (and generally any JPA-implementation).
+ However, any persistence framework can be plugged into Orchestra.</p>
+ </li>
+ <li><p>The Orchestra API can be adapted to use other web frameworks than JSF.</p></li>
+ <li><p>Orchestra sports a very easy to use API - maximum 3 method calls, and you're ready to go.</p></li>
+ </ul>
+ </subsection>
+
+ <subsection name="Limitations">
+ <p>
+ Orchestra persistence features presume the presentation tier has access to the database,
+ i.e. that the presentation and database-access tiers are combined. This is often the case
+ in small-to-medium web applications. Large or security-sensitive applications which separate
+ database access out into an isolated tier (eg use a "full EB stack") cannot use the Orchestra
+ persistence facilities, although they can still make use of the regular conversational support
+ for beans in the presentation layer.
+ </p>
+ </subsection>
+
+ <subsection name="A small JSF example">
+ <p>For the impatient, here's a quick demonstration of Orchestra's main features.</p>
+
+ <p>First, you need to configure a conversation-scoped bean - do that
+ in standard Spring-syntax. Define the name of the scope by setting
+ the scope-attribute.</p>
<pre>
<bean
- name="ballotTopic"
- class="org.apache.myfaces.examples.ballot.backings.BallotTopic"
- scope="conversation.access"/>
+ name="ballotTopic"
+ class="org.apache.myfaces.examples.ballot.backings.BallotTopic"
+ scope="conversation.access"/>
</pre>
- <p>The bean named "ballotTopic" can now be used from the JSF-view.
- It defines properties, methods and event-listeners as usual
- managed-beans do.</p>
-
- <p>Then, there is the action-method - you define this method as
- requiring a transaction with the @Transactional annotation
- (with this, a commit will be executed at the end of the method).
- Now do whatever you want to do with your beans - save business objects,
- update them, play around and have fun.
- When the conversation needs to be closed again, close it by calling
- the invalidate method on the current conversational instance (the
- action-method needs to be defined in the conversational bean itself).</p>
- <code><pre>
+ <p>The bean named "ballotTopic" can now be used from the JSF-view.
+ It defines properties, methods and event-listeners as usual
+ managed-beans do.</p>
+
+ <p>Then, there is the action-method - you define this method as
+ requiring a transaction with the @Transactional annotation
+ (with this, a commit will be executed at the end of the method).
+ Now do whatever you want to do with your beans - save business objects,
+ update them, play around and have fun.
+ When the conversation needs to be closed again, close it by calling
+ the invalidate method on the current conversational instance (the
+ action-method needs to be defined in the conversational bean itself).</p>
+ <code><pre>
@Transactional
public String saveAction()
{
- topic.setOwner(getVoterDao().getByKey(getBallotState().getVoterId()));
- topicDao.save(topic);
+ topic.setOwner(getVoterDao().getByKey(getBallotState().getVoterId()));
+ topicDao.save(topic);
- Conversation.getCurrentInstance().invalidate();
+ Conversation.getCurrentInstance().invalidate();
- return "success";
+ return "success";
} </pre>
- </code>
+ </code>
- The developer keeps on defining DAO's as she is used to do
- - here a simple example using the JPA-syntax with an
- injected EntityManager.
- <pre>
+ The developer keeps on defining DAO's as she is used to do
+ - here a simple example using the JPA-syntax with an
+ injected EntityManager.
+ <pre>
public class VoterDao
{
- @PersistenceContext
- private EntityManager entityManager;
+ @PersistenceContext
+ private EntityManager entityManager;
- public Voter getByKey(Long id)
- {
- return entityManager.find(Voter.class, id);
- }
+ public Voter getByKey(Long id)
+ {
+ return entityManager.find(Voter.class, id);
+ }
}
- </pre>
-
- </subsection>
- </section>
- </body>
+ </pre>
+
+ </subsection>
+ </section>
+ </body>
</document>