/[debian]/libjpf-java/trunk/jdocs/boot.jxp
ViewVC logotype

Contents of /libjpf-java/trunk/jdocs/boot.jxp

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1601 - (show annotations)
Sat Feb 28 23:28:19 2009 UTC (12 years, 5 months ago) by gregoa
File size: 2627 byte(s)
[svn-inject] Forking libjpf-java source to Trunk
1 <%
2 // Java Plug-in Framework (JPF)
3 // Copyright (C) 2004 - 2006 Dmitry Olshansky
4 // $Id$
5 %>
6 <%
7 include("/functions.ijxp");
8
9 printHeader("JPF Boot Library");
10 printMenu("boot");
11 %>
12 <div class="content">
13 <h1>JPF Boot Library</h1>
14 <h3>Introduction</h3>
15 <p>Running JPF based application is often routine and it might be quite tricky, especially for Java beginners. What application developer usually need to do to start (and stop) JPF based application?</p>
16 <ul>
17 <li>load application configuration</li>
18 <li>collect available plug-ins</li>
19 <li>instantiate and initialize JPF runtime</li>
20 <li>publish (load) collected plug-ins</li>
21 <li>activate and "run" main plug-in</li>
22 <li>on application exit, properly shutdow Framework</li>
23 </ul>
24 <p>As you can see, this is quite general and common procedure. All steps are usual and good formalized. So it is possible to write some library once and use it again and again for one particular purpose - load, configure and start application. That is the <a href="api/org/java/plugin/boot/package-summary.html">JPF Boot Library</a> (and slightly more as usual :).</p>
25 <p><img src="resources/images/jpf-boot-diagram.png" width="485" height="516" border="0" alt="JPF Boot Library flow chart" title="JPF Boot Library flow chart" /></p>
26 <h3>Usage</h3>
27 <p>The library packaged in separate JAR file <code>jpf-boot.jar</code> There are special entries placed in manifest of this file that tells JVM what other libraries required for this JAR (<code>jpf.jar</code> so far) and what class to start when running JAR - <code>org.java.plugin.boot.Boot</code> This simplifies library usage and allows to start application simply typing in command shell:</p>
28 <pre>java -jar lib/jpf-boot.jar</pre>
29 <p>Here is typical folders structure:</p>
30 <pre>[APPLICATION_HOME_FOLDER]/
31 +- lib/
32 | +- commons-logging.jar
33 | +- jpf.jar
34 | +- jpf-boot.jar
35 | +- log4j.jar
36 +- plugins/
37 +- boot.properties
38 +- log4j.properties
39 +- run.bat
40 +- run.sh</pre>
41 <p>Put your plug-ins in <code>plugins</code> folder and execute <code>run</code> script. All start up magic will be done by library.</p>
42 <p>You may remove <code>log4j.jar</code> and <code>log4j.properties</code> files if you don't need logging facilities. See <a href="api/org/java/plugin/boot/package-summary.html">JPF Boot Library javadoc</a> for configuration options.</p>
43 <p>Look at <a href="http://sourceforge.net/project/showfiles.php?group_id=110394">JPF-Demo application</a> to get working example of JPF Boot library usage.</p>
44 <br /><br />
45 </div>
46 <%
47 printFooter();
48 %>

  ViewVC Help
Powered by ViewVC 1.1.26