Return-Path: Delivered-To: apmail-jakarta-avalon-cvs-archive@apache.org Received: (qmail 69082 invoked from network); 2 Dec 2002 08:07:42 -0000 Received: from unknown (HELO nagoya.betaversion.org) (192.18.49.131) by daedalus.apache.org with SMTP; 2 Dec 2002 08:07:42 -0000 Received: (qmail 27015 invoked by uid 97); 2 Dec 2002 08:08:57 -0000 Delivered-To: qmlist-jakarta-archive-avalon-cvs@jakarta.apache.org Received: (qmail 26989 invoked by uid 97); 2 Dec 2002 08:08:56 -0000 Mailing-List: contact avalon-cvs-help@jakarta.apache.org; run by ezmlm Precedence: bulk List-Unsubscribe: List-Subscribe: List-Help: List-Post: List-Id: "Avalon CVS List" Reply-To: "Avalon Developers List" Delivered-To: mailing list avalon-cvs@jakarta.apache.org Received: (qmail 26978 invoked by uid 97); 2 Dec 2002 08:08:55 -0000 X-Antivirus: nagoya (v4218 created Aug 14 2002) Date: 2 Dec 2002 08:07:34 -0000 Message-ID: <20021202080734.34210.qmail@icarus.apache.org> From: hammant@apache.org To: jakarta-avalon-phoenix-cvs@apache.org Subject: cvs commit: jakarta-avalon-phoenix/src/documentation/content/mx index.xml structure.xml xdoctags.xml X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N hammant 2002/12/02 00:07:34 Modified: src/documentation/content/assemblers index.xml src/documentation/content/bdg making-phoenix-compatible-comps.xml what-is-an-application-listener.xml src/documentation/content features.xml for-developers-alternate-kernel.xml getting-started.xml guide-administrator.xml guide-architecture.xml index.xml install.xml src/documentation/content/mx index.xml structure.xml xdoctags.xml Log: Typos fixed by Adam Murdoch Revision Changes Path 1.2 +1 -1 jakarta-avalon-phoenix/src/documentation/content/assemblers/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/assemblers/index.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- index.xml 18 Nov 2002 14:18:49 -0000 1.1 +++ index.xml 2 Dec 2002 08:07:34 -0000 1.2 @@ -21,7 +21,7 @@
Organization

The information is organized into sections detailing a specifc aspect of - assembling ServerApplications. + assembling Server Applications.

Contents 1.3 +11 -11 jakarta-avalon-phoenix/src/documentation/content/bdg/making-phoenix-compatible-comps.xml Index: making-phoenix-compatible-comps.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/bdg/making-phoenix-compatible-comps.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- making-phoenix-compatible-comps.xml 18 Nov 2002 23:19:36 -0000 1.2 +++ making-phoenix-compatible-comps.xml 2 Dec 2002 08:07:34 -0000 1.3 @@ -10,7 +10,7 @@

Quite often reusable components are made elsewhere. Apache has a number of places where this activity is going on. While we get it right most of - the time, some components developer elsewhere are harder to use in Phoenix + the time, some components developed elsewhere are harder to use in Phoenix.

Things to remember @@ -36,18 +36,18 @@

The IoC pattern is described here. This means for Phoenix avoiding static concepts including loggers.

-
Sepearation of interface and implementation +
Separation of interface and implementation

- The separation of interface/impl pattern is described here. - For Phoenix is means we can (if done completely) mount the implementation jar in place where hosted client compoennts (beans, servlets etc) can use the API, bit not see the implementation. We can also reimplement or wrap + The separation of interface/implementation pattern is described here. + For Phoenix this means we can (if done completely) mount the implementation jar in place where hosted client components (beans, servlets etc) can use the API, but not see the implementation. We can also reimplement or wrap bits of the implementation. For example we could write a pluggable implementation that could, for a certain API - journal some methods, but still delegate to the real impl. Which pluggable impl is used by Phoenix when it + journal some methods, but still delegate to the real implementation. Which pluggable implementation is used by Phoenix when it boots is determined in assembly.xml of course.

Opening up the API

- Given that you have divided into interface and impl, there are probably plenty of methods you + Given that you have divided into interface and implementation, there are probably plenty of methods you can put method in the interface you never though might be used. For example if you are making JDBC compliant relational database, and it is a bean, you could easily think that the only use would be clients via JDBC over sockets. Well, given that Phoenix can now mount the RDBMS block, it might want @@ -61,9 +61,9 @@

-
Example compatible comp +
Example compatible component

- Below are an interface and implemmentation that are suitably separated, are beanlike and is in accordance + Below are an interface and implementation that are suitably separated, are beanlike and is in accordance with the IoC pattern...

package examplecomp; @@ -111,7 +111,7 @@ } } -

When we are trying to run this in phoeinix we might have this wrapper:

+

When we are trying to run this in phoenix we might have this wrapper:

package examplecomp.block; public class WebServerBlock @@ -152,8 +152,8 @@ } } -

This basically shows the impl wrapped and taking its configuration from the config.xml - that phonix prefers from configuration. The the developer wanted they could ignore +

This basically shows the implementation wrapped and taking its configuration from the config.xml + that phoenix prefers from configuration. If the developer wanted they could ignore that place of configuration and use their own config files. If the WebServer block were being reused by another Phoenix block (say an EJB server), it might be like so:

1.2 +2 -2 jakarta-avalon-phoenix/src/documentation/content/bdg/what-is-an-application-listener.xml Index: what-is-an-application-listener.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/bdg/what-is-an-application-listener.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- what-is-an-application-listener.xml 18 Nov 2002 14:19:02 -0000 1.1 +++ what-is-an-application-listener.xml 2 Dec 2002 08:07:34 -0000 1.2 @@ -11,14 +11,14 @@ This is very similar to BlockListener in that it is notified during lifecycle of blocks and application. In Java terms the ApplicationListener interface extends BlockListener - so it is always informd of both types of events + so it is always informed of both types of events.

Events notified

ApplicationListener components are created before any Blocks are created in an Application. They receive notifications before and - after the Applictaion is started and stopped. + after the Application is started and stopped.

How to make a block listener 1.2 +2 -2 jakarta-avalon-phoenix/src/documentation/content/features.xml Index: features.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/features.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- features.xml 18 Nov 2002 14:18:18 -0000 1.1 +++ features.xml 2 Dec 2002 08:07:34 -0000 1.2 @@ -18,14 +18,14 @@
  • Customise behaviour quickly
  • Plug in extra functionality effortlessly
  • -
  • remove unneeded functionality for a small footprint
  • +
  • Remove unneeded functionality for a small footprint
Flexible environment

Phoenix has native support for use in the following environments:

    -
  • command-line stand-alone program
  • +
  • Command-line stand-alone program
  • Unix daemon
  • Embedded in other programs (including servlet engines)
1.3 +1 -1 jakarta-avalon-phoenix/src/documentation/content/for-developers-alternate-kernel.xml Index: for-developers-alternate-kernel.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/for-developers-alternate-kernel.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- for-developers-alternate-kernel.xml 30 Nov 2002 08:43:42 -0000 1.2 +++ for-developers-alternate-kernel.xml 2 Dec 2002 08:07:34 -0000 1.3 @@ -15,7 +15,7 @@
Beanshell enabled kernel

- This allows pretty much any anything to be done to applications + This allows pretty much anything to be done to applications and blocks once started. As such it is not suitable for live deployment as it could be considered a bit of a hackers tool.

1.4 +1 -1 jakarta-avalon-phoenix/src/documentation/content/getting-started.xml Index: getting-started.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/getting-started.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- getting-started.xml 18 Nov 2002 23:48:53 -0000 1.3 +++ getting-started.xml 2 Dec 2002 08:07:34 -0000 1.4 @@ -55,7 +55,7 @@ has compiled correctly by running the HelloWorld demo Service Application.

- Firstly you will need to get the demo-helloword.sar file and drop it into + Firstly you will need to get the demo-helloworld.sar file and drop it into the apps directory of Phoenix. Currently it needs to be built from CVS - http://cvs.apache.org/viewcvs/jakarta-avalon-apps/demo/. 1.2 +1 -1 jakarta-avalon-phoenix/src/documentation/content/guide-administrator.xml Index: guide-administrator.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/guide-administrator.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- guide-administrator.xml 18 Nov 2002 14:18:18 -0000 1.1 +++ guide-administrator.xml 2 Dec 2002 08:07:34 -0000 1.2 @@ -193,7 +193,7 @@ documentation. Phoenix uses the JRMP RMI Adaptor.

- Ensure that the MX4J RMI Adaptor is enabled in kernal.xml + Ensure that the MX4J RMI Adaptor is enabled in kernel.xml

<component role="org.apache.avalon.phoenix.interfaces.SystemManager" 1.2 +3 -3 jakarta-avalon-phoenix/src/documentation/content/guide-architecture.xml Index: guide-architecture.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/guide-architecture.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- guide-architecture.xml 18 Nov 2002 14:18:18 -0000 1.1 +++ guide-architecture.xml 2 Dec 2002 08:07:34 -0000 1.2 @@ -47,10 +47,10 @@
Packaging in terms of block jar files

- The server application is entirely contained withing one "sar" file. Sar is "Server ARchive". + The server application is entirely contained within one "sar" file. Sar is "Server ARchive". Each block is a jar file. The dependant libraries are regular jars (placed - within a directory "lib" insde the sar file). The Assembly and configuration instructions - are in xml form and contained within a "conf" directory inside the sar file. + within a directory "SAR-INF/lib" insde the sar file). The Assembly and configuration instructions + are in xml form and contained within a "SAR-INF" directory inside the sar file.

1.3 +1 -1 jakarta-avalon-phoenix/src/documentation/content/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/index.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- index.xml 22 Nov 2002 22:22:13 -0000 1.2 +++ index.xml 2 Dec 2002 08:07:34 -0000 1.3 @@ -21,7 +21,7 @@
Documentation is coming

Some of the information on this site is currently a bit out of date. We are - working hard to fix this. If you come across any incosistencies or have a + working hard to fix this. If you come across any inconsistencies or have a problem, please don't hesitate to contact us through the mailing list. Thank you.

1.2 +1 -1 jakarta-avalon-phoenix/src/documentation/content/install.xml Index: install.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/install.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- install.xml 18 Nov 2002 14:18:18 -0000 1.1 +++ install.xml 2 Dec 2002 08:07:34 -0000 1.2 @@ -16,7 +16,7 @@

- Everything required to run Phoenix and develope Phoenix based products comes with the + Everything required to run Phoenix and develop Phoenix based products comes with the distribution. If you wish to help develop Avalon/Phoenix then it is recomended that you obtain the full source tree from CVS 1.2 +3 -3 jakarta-avalon-phoenix/src/documentation/content/mx/index.xml Index: index.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/mx/index.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- index.xml 18 Nov 2002 14:19:13 -0000 1.1 +++ index.xml 2 Dec 2002 08:07:34 -0000 1.2 @@ -17,7 +17,7 @@

Overview

Management in Phoenix is divided into two distinct areas. The first - area is the the management metadata. This information about which + area is the the management metadata. This is information about which applications, blocks and components should be managed, the operations and attributes to expose, and descriptions for each these to help guide the user. @@ -29,7 +29,7 @@

The second area is the Phoenix component that uses the MXINFO files to generate a user interface through which Phoenix - and its applications are interacted with. It is anticated that a number + and its applications are interacted with. It is anticipated that a number of such interfaces will be developed. The current implementation of the management component uses the MXINFO files to generate ModelMBeans that are then registered and exposed through a slightly @@ -52,7 +52,7 @@ This section provides a conceptual overview of the elements that are used to represent management information within Phoenix. An understanding of these elements and their relationships is - essential for all users are the management functionality. + essential for all users of the management functionality.

Structure 1.3 +5 -5 jakarta-avalon-phoenix/src/documentation/content/mx/structure.xml Index: structure.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/mx/structure.xml,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- structure.xml 18 Nov 2002 23:18:08 -0000 1.2 +++ structure.xml 2 Dec 2002 08:07:34 -0000 1.3 @@ -8,12 +8,12 @@

Introduction

- Phoenix Management seperates the information on what should be managed + Phoenix Management separates the information on what should be managed from the implementation of the management agent. In order to maintain - this seperation, yet still allow the management interface to be rich + this separation, yet still allow the management interface to be rich and structured enough to be useful, it is necessary to impose an organizing strucuture on the management metadata. This structure will be common - across all management interfaces, althought the specifics of how it is + across all management interfaces, although the specifics of how it is exposed is up to the implementor.

@@ -31,7 +31,7 @@ sub-Contexts.

- This nested structure of Contexts is the principle + This nested structure of Contexts is the principal organizing element for management data, and is the bridge between the management code embedded in Phoenix and the implementation of the management component. It is represented by the @@ -95,7 +95,7 @@

Again, the point behind the 'Organizing Structure' is to keep the management specification - seperated from the management agent, while at the same time providing enough definition + separated from the management agent, while at the same time providing enough definition to keep a shared conceptual view between the two areas.

1.2 +27 -27 jakarta-avalon-phoenix/src/documentation/content/mx/xdoctags.xml Index: xdoctags.xml =================================================================== RCS file: /home/cvs/jakarta-avalon-phoenix/src/documentation/content/mx/xdoctags.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- xdoctags.xml 18 Nov 2002 14:19:13 -0000 1.1 +++ xdoctags.xml 2 Dec 2002 08:07:34 -0000 1.2 @@ -108,14 +108,14 @@ Example:

- /** - * Gets the list of applications running in the container - * - * @phoenix:mx-attribute - * - * @return applicationNames The array of application names - */ - String[] getApplicationNames(); +/** + * Gets the list of applications running in the container + * + * @phoenix:mx-attribute + * + * @return applicationNames The array of application names + */ +String[] getApplicationNames();
phoenix:mx-operation @@ -150,14 +150,14 @@ Example:

- /** - * Removes the application from the container - * - * @phoenix:mx-operation - * - * @param name the name of application to remove - */ - void removeApplication( String name ) +/** + * Removes the application from the container + * + * @phoenix:mx-operation + * + * @param name the name of application to remove + */ +void removeApplication( String name )
phoenix:mx-description @@ -193,16 +193,16 @@ Example:

- /** - * Retrieve a string identifying version of server. - * Usually looks like "v4.0.1a". - * - * @phoenix:mx-attribute - * @phoenix:mx-description Retrieve a string identifying version of server. - * - * @return version string of server. - */ - String getVersion(); +/** + * Retrieve a string identifying version of server. + * Usually looks like "v4.0.1a". + * + * @phoenix:mx-attribute + * @phoenix:mx-description Retrieve a string identifying version of server. + * + * @return version string of server. + */ +String getVersion();
phoenix:mx-proxy @@ -218,7 +218,7 @@ The proxy tag is used to indicate that a proxy class should be used to manage some aspect(s) of this object. At runtime, the management - system will instantiate in instance of the proxy class passing in + system will instantiate an instance of the proxy class passing in a reference to the managed object in the constructor. Management calls are then made on the proxy instead of the managed object. -- To unsubscribe, e-mail: For additional commands, e-mail: