donaldp 01/11/10 13:03:57
Modified: src/xdocs assemblers-guide.xml book.xml
creating-a-server-application.xml phoenix.uris
Added: src/xdocs environment-xml-specification.xml
Removed: src/xdocs server-xml-specification.xml
Log:
Update documentation to refer to environment.xml rather than server.xml
Revision Changes Path
1.4 +2 -2 jakarta-avalon-phoenix/src/xdocs/assemblers-guide.xml
Index: assemblers-guide.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/assemblers-guide.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- assemblers-guide.xml 2001/04/20 01:49:44 1.3
+++ assemblers-guide.xml 2001/11/10 21:03:57 1.4
@@ -48,7 +48,7 @@
<link href="assembly-xml-specification.html">assembly.xml
specification</link>
</li>
<li>
- <link href="server-xml-specification.html">server.xml
specification</link>
+ <link href="environment-xml-specification.html">environment.xml
specification</link>
</li>
</ol>
</s1>
@@ -56,7 +56,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.3 $ $Date: 2001/04/20 01:49:44 $
+ $Revision: 1.4 $ $Date: 2001/11/10 21:03:57 $
</legal>
</footer>
</document>
1.7 +1 -1 jakarta-avalon-phoenix/src/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/book.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- book.xml 2001/08/27 10:37:07 1.6
+++ book.xml 2001/11/10 21:03:57 1.7
@@ -31,7 +31,7 @@
<menu-item label="Creating a Server Application"
href="creating-a-server-application.html"/>
<menu-item label="config.xml Specification"
href="config-xml-specification.html"/>
<menu-item label="assembly.xml Specification"
href="assembly-xml-specification.html"/>
- <menu-item label="server.xml Specification"
href="server-xml-specification.html"/>
+ <menu-item label="environment.xml Specification"
href="environment-xml-specification.html"/>
</menu>
<menu label="Block Developers Guide">
1.4 +7 -7
jakarta-avalon-phoenix/src/xdocs/creating-a-server-application.xml
Index: creating-a-server-application.xml
===================================================================
RCS file:
/home/cvs/jakarta-avalon-phoenix/src/xdocs/creating-a-server-application.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- creating-a-server-application.xml 2001/11/05 23:41:03 1.3
+++ creating-a-server-application.xml 2001/11/10 21:03:57 1.4
@@ -21,7 +21,7 @@
<li>Select the blocks you wish to assemble.</li>
<li>Write the config.xml file.</li>
<li>Write the assembly.xml file.</li>
- <li>Write the server.xml file.</li>
+ <li>Write the environment.xml file.</li>
<li>Package the component and related resources into a sar file.</li>
</ol>
</s1>
@@ -53,19 +53,19 @@
specification</link>.
</p>
</s1>
- <s1 title="Write the server.xml file">
+ <s1 title="Write the environment.xml file">
<p>
- The next stage is to write the server.xml file. The server.xml is
used to
+ The next stage is to write the environment.xml file. The
environment.xml is used to
configure the code-based security policy, log management and thread
pooling.
- For more detail on the format of server.xml see the
- <link href="server-xml-specification.html">specification</link>.
+ For more detail on the format of environment.xml see the
+ <link href="environment-xml-specification.html">specification</link>.
</p>
</s1>
<s1 title="Create the sar file">
<p>
The sar file format is the standard distribution format of Phoenix
Server
Applications. It is a standard Jar file with a specific directory
layout.
- The config.xml, server.xml and assembly.xml file must be stored in
+ The config.xml, environment.xml and assembly.xml file must be stored
in
<code>SAR-INF/</code> directory of the archive. All jar files,
including
both those that contain blocks and those that contain support classes
should be stored in the <code>SAR-INF/lib/</code> directory.
@@ -75,7 +75,7 @@
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
- $Revision: 1.3 $ $Date: 2001/11/05 23:41:03 $
+ $Revision: 1.4 $ $Date: 2001/11/10 21:03:57 $
</legal>
</footer>
</document>
1.4 +1 -1 jakarta-avalon-phoenix/src/xdocs/phoenix.uris
Index: phoenix.uris
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/xdocs/phoenix.uris,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- phoenix.uris 2001/10/05 10:36:38 1.3
+++ phoenix.uris 2001/11/10 21:03:57 1.4
@@ -11,7 +11,7 @@
creating-a-server-application.html
config-xml-specification.html
assembly-xml-specification.html
-server-xml-specification.html
+environment-xml-specification.html
block-developers-guide.html
what-is-a-block.html
blockinfo-specification.html
1.1
jakarta-avalon-phoenix/src/xdocs/environment-xml-specification.xml
Index: environment-xml-specification.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "dtd/document-v10.dtd">
<document>
<header>
<title>Server Assemblers Guide</title>
<subtitle>Specification of environment.xml</subtitle>
<authors>
<person id="PD" name="Peter Donald" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Introduction">
<p>
The purpose of the <code>environment.xml</code> file is to configure
environmental
or Server Application wide settings. Currently this means being able
to set the
security policy and configure logging settings. A sample
<code>environment.xml</code>
follows. Previously thread pool settings were also configured in this
section but this has been deprecated. Note that previously the
information stored in
<code>environment.xml</code> was stored in a file named
<code>server.xml</code>.
</p>
</s1>
<s1 title="Sample environment.xml file">
<source><![CDATA[
<?xml version="1.0"?>
<environment>
<logs>
<category name="" target="default" priority="DEBUG" />
<category name="myAuthorizer" target="myAuthorizer-target"
priority="DEBUG" />
<log-target name="default"
location="/logs/default.log" />
<log-target name="myAuthorizer-target"
location="/logs/authorizer.log" />
</logs>
<policy>
<keystore name="foo-keystore"
location="file:${app.home}${/}conf${/}keystore"
type="JKS" />
<grant signed-by="Bob"
code-base="file:${app.home}${/}SAR-INF${/}lib${/}*"
key-store="foo-keystore" >
<permission class="java.io.FilePermission"
target="${/}tmp${/}*"
action="read,write" />
</grant>
</policy>
</environment>]]>
</source>
<p>
The format of the policy section should be self evident if the
assembler
has experienve with standard policy files. It should be noted that if
no
policy section is given then the Server Application runs at full
permissions.
The evaluation of properties occurs in a similar manner to standard
policy file property expansion. There are a number of extra
properties that
will be evaluated. These include; <code>app.home</code> and
<code>app.name</code>.
</p>
<p>
The logs section can currently have two types of elements;
<em>log-target</em>s
which represent destinations for logging and <em>category</em>s.
There must be a
log-target with the name "default". Categories are hierarchial in
nature, have a
priority and are associated with one or more log-targets. See the
logging
documentation for a further description of this section.
</p>
</s1>
</body>
<footer>
<legal>
Copyright (c) @year@ The Jakarta Apache Project All rights reserved.
$Revision: 1.1 $ $Date: 2001/11/10 21:03:57 $
</legal>
</footer>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
