axis-c-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Evanthika Amarasiri (JIRA)" <j...@apache.org>
Subject [jira] Created: (AXIS2C-571) Issues in the Axis2/C Manual - Engaging a Module
Date Wed, 28 Mar 2007 10:37:32 GMT
Issues in the Axis2/C Manual - Engaging a Module
------------------------------------------------

                 Key: AXIS2C-571
                 URL: https://issues.apache.org/jira/browse/AXIS2C-571
             Project: Axis2-C
          Issue Type: Bug
          Components: documentation
         Environment: Windows XP
            Reporter: Evanthika Amarasiri


The following minor issues were found in the Axis2C Manual under the heading "Engaging a Module"
================================================================================
1. The xml segement of the axis2.xml given is not quite readable. Everything seems to be messed
up. No formatting is done.
Make it appear like below

<phaseOrder type="inflow">
        <!-- System pre defined phases -->
        <phase name="TransportIn"/>
        <phase name="PreDispatch"/>
        <phase name="Dispatch" class="org.apache.axis2.engine.DispatchPhase">
        		<handler name="AddressingBasedDispatcher" class="axis2_engine">
        			<order phase="Dispatch"/>
        		</handler>
        </phase>.........
        <phase n></phase n>
</phaseOrder>


2. Under the heading "7. Engaging a Module", it lists the steps that the user has to follow
when engaging a module. Then it gives the detailed descriptions of the given points. So I
write the module.xml file and then without taking any notice to the 1-4 points given above
(Thinking that refering to more detail is appropriate), move to the next heading which is
"Adding the Module Specific Phases in the axis2.xml File". Then I try to engage the module
by adding the <module ref="logging"/> tag to a services.xml file. 

When tried to restart the server it fails since it does not engage the module logging since
the logging module is not available in the modules folder. I go back to the listed points
and realized that I have missed step 2 and 3, the part where I have to create a folder by
the name of the module and place it inside the axis2c/modules folder. 

So I think the guide should provide at least a brief description of how to follow these two
steps so that the user will not have to go back to the and see what he/she has missed out.


3. Under "Engaging the Module on the Client Side" it states  - "On the client side, if the
above <module ref ="logging"/> is added in the axis2.xml the module specific handlers
will be invoked for every request the client sends.". This gives a meaning like, for every
request only a particular client sends, the module specific handlers will be invoked. 

Therefore it is more appropriate if this can be rephrased into something like "If the above
<module ref ="logging"/> is added in the axis2.xml, the module specific handlers will
be invoked for every request which (all) the clients send". (This is the real meaning that
should be given I assume)

4. Minor Issues - Typos (correct the words quoted)
a) The module specific phase has to "de" added after the system predefined phases.
b) In that case some of the module "specie" handlers may be put in to that phase.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


---------------------------------------------------------------------
To unsubscribe, e-mail: axis-c-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-c-dev-help@ws.apache.org


Mime
View raw message