[jbosstools-commits] JBoss Tools SVN: r7552 - in trunk/esb/docs: esb_ref_guide and 4 other directories.

Author: tromanovich Date: 2008-04-16 08:48:16 -0400 (Wed, 16 Apr 2008) New Revision: 7552 Added: trunk/esb/docs/esb_ref_guide/ trunk/esb/docs/esb_ref_guide/en/ trunk/esb/docs/esb_ref_guide/en/images/ trunk/esb/docs/esb_ref_guide/en/images/esb_support/ trunk/esb/docs/esb_ref_guide/en/images/esb_support/01_create_esb.png trunk/esb/docs/esb_ref_guide/en/images/esb_support/02_create_esb.png trunk/esb/docs/esb_ref_guide/en/master.xml trunk/esb/docs/esb_ref_guide/en/modules/ trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml trunk/esb/docs/esb_ref_guide/pom.xml Log: JBDS-307 Sketch of ref guide. ESB support chapter with "Creating a ESB File" section is added. Added: trunk/esb/docs/esb_ref_guide/en/images/esb_support/01_create_esb.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en/images/esb_support/01_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en/images/esb_support/02_create_esb.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en/images/esb_support/02_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en/master.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en/master.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en/master.xml 2008-04-16 12:48:16 UTC (rev 7552) @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" +"../../resources/support/docbook-dtd/docbookx.dtd" + +[ +<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY esb_support SYSTEM "modules/esb_support.xml"> +<!ENTITY esb_editor SYSTEM "modules/esb_editor.xml"> +]> +<book> + <bookinfo> + <title>ESB Tools Reference Guide</title> + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2008</year> + <holder>JBoss, a division of Red Hat Inc.</holder> + </copyright> + <releaseinfo> + <para>Version: 2.1.0.Beta1</para> + </releaseinfo> + </bookinfo> + + <toc/> + + &introduction; + &esb_support; + &esb_editor; + +</book> \ No newline at end of file Added: trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml 2008-04-16 12:48:16 UTC (rev 7552) @@ -0,0 +1,332 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="esb_editor" xreflabel="esb_editor"> + <?dbhtml filename="esbEditor.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Editor</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Editor</title> + + <para> + ESB editor have <link linkend="OpenOnSelection4Hyperlinknavigation"><property>OpenOn</property></link> and + <link linkend="CodeAssistAndDynamicCodeAssist42BasedOnProjectData"><property>Content Assist</property></link> features, + they are described more detail in this chapter. In addition you get to know a <link linkend="visual_page">ESB Editor</link> for combined visual and source editing + of esb files.</para> + + <section id="esb_editors_features"> + + <title>ESB Editors Features</title> + <para>JBoss Developer Studio has powerful editor features that help you easily navigate + within your application and make use of content and code assist no matter what project + file you are working on.</para> + + <section id="OpenOnSelection4Hyperlinknavigation"> + + <title>OpenOn</title> + + <para><property>OpenOn</property> let&apos;s you easily navigate through your + project without using the Package Explorer view (project tree). With OpenOn, you can + simply click on a reference to another file and that file will be opened.</para> + + <para>OpenOn is available for the XML files </para> + + <para>Press and hold down the Ctrl key. As you move the mouse cursor over different + file references in the file, they display an underline. When you have the mouse + cursor over the name of the file you want to open, click and the file will open + in its own editor. In this example the managed bean NameBean will open.</para> + + </section> + + <section id="CodeAssistAndDynamicCodeAssist42BasedOnProjectData"> + + <title>Content Assist</title> + <para><property>Content assist</property> is available when working with ESB file.</para> + + <para>When working with ESB file in JBoss Developer Studio, you can use + various <property>Content Assist features</property> while developing:</para> + <itemizedlist> + <listitem> + <para>Content Assist for XML file</para> + </listitem> + <listitem> + <para>Content Assist based on project data</para> + </listitem> + <listitem> + <para>Content Assist with graphical JSF editor</para> + </listitem> + </itemizedlist> + <section id="ContentAssistForXMLJSPAndJSFConfigurationFiles865"> + + <title>Content Assist for XML file</title> + + <para>At any point when working with any XML file Content Assist is available to help you. Simply type <emphasis> + <property>Ctrl-Space</property></emphasis> to see what is available.</para> + + <para>Content Assist for XML file:</para> + <figure> + <title>Content Assist in JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_9.png" scale="85"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ContentAssistBasedOnProjectData86"> + + <title>Content Assist Based on Project Data</title> + + <para>JBoss Developer Studio takes Content Assist to the next level. Studio + will constantly scan your project and you will be able to insert code + into the ESB page from your project that includes:</para> + <itemizedlist> + <listitem> + <para>Values from Property files</para> + </listitem> + <listitem> + <para><emphasis role="italic"> + <property>&quot;Managed beans&quot;</property> + </emphasis> attributes and methods</para> + </listitem> + <listitem> + <para>Navigation Rule Outcomes</para> + </listitem> + <listitem> + <para>JSF variables (context, request etc...)</para> + </listitem> + </itemizedlist> + <para>The first screenshot shows how to insert message from a Properties + files. You simply put the cursor inside the <emphasis role="italic"> + <property>&quot;value&quot;</property> + </emphasis> attribute and press <emphasis> + <property>Ctrl-Space</property>. + </emphasis> JBoss Developer Studio will scan your project and show a + list of possible values to insert.</para> + <figure> + <title>Inserting Message</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_12.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the following screenshot we are inserting a <emphasis role="italic"><property>&quot;Managed bean&quot;</property></emphasis> + attribute value. Again, by simply clicking <emphasis><property>Ctrl-Space</property>,</emphasis> + JBoss Developer Studio will show a list of all possible values that you can insert.</para> + + <para>Once you select a Managed bean, it will show you a list of all + available attributes for the selected Managed bean (userBean).</para> + <figure> + <title>Attributes List</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_13.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Code Assist based on project data will also prompt you for navigation + rules that exist in your JSF configuration file.</para> + <figure> + <title>Code Assist</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_14.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="ContentAssistWithinJSFGraphicalEditor44"> + + <title>Content Assist within Tree ESB Editor</title> + + <para>JBoss Developer Studio also provides Content Assist when working within the Tree ESB editor. + Just click <emphasis><property>Ctrl-Space</property>.</emphasis></para> + <figure> + <title>Content Assist in Tree ESB Editor</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_15.png" scale="85"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section> + <title>Code assist for ESB</title> + + <para>One more feature which comes with ESB support is code assist + (Ctrl + Space). It is available for <property>ESB tags</property> + while editing <emphasis> + <property>iboss-esb.xml</property> + </emphasis> files.</para> + + <figure> + <title>XML File Code Assist</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/esb_support/esb_support_5.png" + scale="60"/> + </imageobject> + </mediaobject> + </figure> + + <para>What&apos;s more, code assist is also available for <emphasis + role="italic"> + <property>&quot;ESB&quot;</property> + </emphasis> attribute in any HTML tag.</para> + + <figure> + <title>Code Assist for ESB Attribute</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/esb_support/esb_support_6.png" + scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para>After selecting <emphasis role="italic"> + <property>&quot;esb&quot;</property> + </emphasis> you get the code assist for ESB components available on + a page.</para> + + <figure> + <title>Code Assist for ESB Components</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/esb_support/esb_support_7.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>When a component is chosen you will see all available attributes for + it.</para> + + <figure> + <title>Available Attributes for the Component</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/esb_support/esb_support_8.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing74"> + + <title>Synchronized Source and Visual Editing</title> + + <para>JBoss Developer Studio offers the flexibility to edit ESB file in either source + or extra visual modes at the same time.</para> + + <para>JBoss Developer Studio provides you two different editors to speed your development. At the same + time, you always have full control over esb source file. Any changes you + make in the source view, will immediately appear in the tree view.</para> + + <para>The ESB file editor has two views: <property>Tree</property> and <property>Source</property>. Both + views are synchronized, you can edit the file in any view.</para> + <figure> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_32.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>The same applies to all other JBoss Developer Studio editors.</para> + + <para>Web XML editor is shown. Web XML editor has a graphical view (Tree) and source + (Source).</para> + + <figure> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_35.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>JBoss Developer Studio TLD file editor shown in Tree view. At any point you can + edit the source by going switching to Source view.</para> + <figure> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_37.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + + <section id="esb_file"> + + <title>ESB File Editor</title> + <para>JBoss Developer Studio comes with a powerful and customizable <property>ESB File Editor</property>(ESBFE). You can use the ESB File Editor to develop an + application using ESB technology.</para> + + <para>Current ESBFE version has two tabs: Tree and Source.</para> + + <para>You can switch to Tree:</para> + <figure> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Or work just in Source view.</para> + <figure> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>No matter what view you select, you get full integration with Properties and Outline views:</para> + <figure> + <title>Properties And Outline Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_4.png" scale="65"/> + </imageobject> + </mediaobject> + </figure> + + <section id="ESBsyntaxvalidation84"> + + <title>ESB syntax validation</title> + <para>When working in JBoss ESB editor you are constantly provided with feedback + and contextual error checking as you type.</para> + </section> + + </section> + +</chapter> Added: trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml 2008-04-16 12:48:16 UTC (rev 7552) @@ -0,0 +1,95 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="esb_support"> + <?dbhtml filename="esb_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>ESB</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Support</title> + + <para>Since v.1.0.1 Developer Studio supports xml editor for the ESB XML file used in JBoss ESB.</para> + + <para>At this point the structured xml editor will prompt you to specify a proper ESB environment.</para> + + <para>In this section we will focus more on all concepts that JBDS integrates for + working with ESB.</para> + + <section> + <title>ESB Framework Installation</title> + + <para>This chapter will provide you with detailed information on how to install JBoss ESB.</para> + + <para>To install the JBoss ESB plugins for Eclipse, you need the following:</para> + + <itemizedlist> + <listitem> + <para>Get Eclipse 3.3.1 and Web Tools 2.0.1</para> + </listitem> + </itemizedlist> + <para>The quickest way to get a WTP version is to download "Eclipse IDE for Java EE Developers" + via <ulink url="http://www.eclipse.org">www.eclipse.org</ulink>.</para> + <note><title>Note:</title><para>Remember to choose the download that matches your OS and use Java 5 when you run it.</para></note> + <itemizedlist> + <listitem> + <para>Get the <ulink url="http://www.jboss.org/jbossesb/downloads/">JBoss ESB build</ulink></para> + </listitem> + </itemizedlist> + <para>You can also find the latest development release of JBoss ESB from <ulink url="http://www.jboss.org/jbossesb/downloads/">JBoss ESB Downloads Site</ulink></para> + <itemizedlist> + <listitem> + <para>Finally, install the build</para> + </listitem> + </itemizedlist> + + <para>Unzip the file(s) directly into your Eclipse <emphasis> + <property>plugins/features</property> + </emphasis> directory and it will be readily available. It might be necessary to start Eclipse + with eclipse -clean to make sure it starts clean and rereads the new list of plugins.</para> + + </section> + + <section> + <title>Creating a ESB File</title> + <para>In this chapter we suggest a step-by-step walk-through of creating your own simple file. Let's try to organize a new ESB file.</para> + + <para>We will show you how to use the Creation wizard for creating a new ESB file.</para> + + <para>At first you should open any project. Select <emphasis><property>File &gt;New &gt; Other...</property> + </emphasis> in the main menu bar or context menu for selected project and then <emphasis><property>ESB &gt; ESB File</property></emphasis> in the New dialog:</para> + + <figure> + <title>New Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/01_create_esb.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis><property>Next</property></emphasis> brings us to the wizard page where it&apos;s necessary to specify the + folder, name and version for the file. We choose, for example, <emphasis><property>jboss-esb.xml</property> + </emphasis> as the name and accept the selected projects folder and default version.</para> + <figure> + <title>Folder, Name and Version</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/02_create_esb.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, our file will be created in the selected projects folder by default. If you want to change the folder + for your future file click <emphasis><property>Browse...</property></emphasis> button to set needed folder or simply type it.</para> + + <para>Clicking on <emphasis><property>Finish</property> + </emphasis> results in the file being generated. The wizard creates one xml file.</para> + + </section> + +</chapter> Added: trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml 2008-04-16 12:48:16 UTC (rev 7552) @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction"> + <?dbhtml filename="introduction.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + <keyword>JBoss Tools</keyword> + <keyword>JBDS</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <section> + + <title>What is ESB?</title> + + <para>ESB (Enterprise Service Bus) - an abstraction layer on top of an implementation of an enterprise messaging system + that provides the features with which Service Oriented Architectures may be implemented.</para> + + <para>The ESB is seen as the next generation of EAI – better and without the vendor-lockin characteristics of old. + As such, many of the capabilities of a good ESB mirror those of existing EAI offerings. Traditional EAI stacks consist of: + Business Process Monitoring, Integrated Development Environment, Human Workflow User Interface, Business Process Management, + Connectors, Transaction Manager, Security, Application Container, Messaging Service, Metadata Repository, Naming and Directory Service, + Distributed Computing Architecture.</para> + + <para>As with EAI systems, ESB is not about business logic – that is left to higher levels. + It is about infrastructure logic. Although there are many different definitions of what constitutes an ESB, + what everyone agrees on now is that an ESB is part of an SOA infrastructure. However, + SOA is not simply a technology or a product: it's a style of design, with many aspects + (such as architectural, methodological and organisational) unrelated to the actual technology. + But obviously at some point it becomes necessary to map the abstract SOA to a concrete + implementation and that's where the ESB comes in to play.</para> + + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <para>You can find a set of benefits and other extra information on <ulink + url="http://www.jboss.org/jbossesb">JBoss ESB</ulink>.</para> + + </section> + +</chapter> Added: trunk/esb/docs/esb_ref_guide/pom.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/pom.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/pom.xml 2008-04-16 12:48:16 UTC (rev 7552) @@ -0,0 +1,106 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>esb-reference-guide-${translation}</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>ESB_Reference_Guide</name> + +<dependencies> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.0.0</version> + <type>jdocbook-style</type> + </dependency> +</dependencies> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.0.0</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.0.0</version> + </dependency> + <dependency> + <groupId>org.richfaces.docs</groupId> + <artifactId>highlight</artifactId> + <version>3.1.4.GA</version> + </dependency> + </dependencies> + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <!--<cssResource> + <directory>src/main/css</directory> + </cssResource>--> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/main-pdf.xsl</stylesheetResource> + <finalName>${pom.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/main-html.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/nochunk-html.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/main-eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme --> + <!-- could also locate the docbook dependency and inspect its version... --> + <docbookVersion>1.72.0</docbookVersion> + </options> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> + <!-- Copy the dist to the local checkout of the JBoss maven2 repo ${maven.repository.root} --> + <!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml --> + <!-- todo : replace this with direct svn access once the svnkit providers are available --> + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <translation>en-US</translation> + </properties> + + +</project>