You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by da...@apache.org on 2008/06/26 15:45:40 UTC

svn commit: r671900 - /webservices/axis2/trunk/c/src/core/phaseresolver/phase_resolver.c

Author: damitha
Date: Thu Jun 26 06:45:40 2008
New Revision: 671900

URL: http://svn.apache.org/viewvc?rev=671900&view=rev
Log:
Adding comments

Modified:
    webservices/axis2/trunk/c/src/core/phaseresolver/phase_resolver.c

Modified: webservices/axis2/trunk/c/src/core/phaseresolver/phase_resolver.c
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/src/core/phaseresolver/phase_resolver.c?rev=671900&r1=671899&r2=671900&view=diff
==============================================================================
--- webservices/axis2/trunk/c/src/core/phaseresolver/phase_resolver.c (original)
+++ webservices/axis2/trunk/c/src/core/phaseresolver/phase_resolver.c Thu Jun 26 06:45:40 2008
@@ -49,16 +49,6 @@
     const axutil_env_t * env,
     axis2_module_desc_t * module_desc);
 
-/*
- * Engages the given global module to the given service. This means 
- * the given module would be engaged to all operations of the given 
- * service.
- * @param phase_resolver pointer to phase resolver
- * @param env pointer to environment struct
- * @param svc pointer to service
- * @param module_desc pointer to module description
- * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
- */
 static axis2_status_t
 axis2_phase_resolver_add_module_handlers_to_user_defined_phases(
     axis2_phase_resolver_t * phase_resolver,
@@ -92,9 +82,8 @@
 {
     axis2_phase_resolver_t *phase_resolver = NULL;
 
-    phase_resolver = (axis2_phase_resolver_t *) AXIS2_MALLOC(env->allocator,
-                                                             sizeof
-                                                             (axis2_phase_resolver_t));
+    phase_resolver = (axis2_phase_resolver_t *) AXIS2_MALLOC(env->allocator, 
+            sizeof(axis2_phase_resolver_t));
 
     if (!phase_resolver)
     {
@@ -167,14 +156,14 @@
 }
 
 /**
- * This is in general called to engage a module to the axis2 engine. In other
- * words modules handlers are added into all global and operation specific
- * phases appropriately. Where these handlers should go is determined by the
- * module handler specific descriptions in module.xml file. Also module 
- * operations are added to service and built exeuction chains.
- * First add all the handlers in the module into the global chains. Then
- * retrieve all services from axis2 configuration and add module handlers 
- * into each services operation phases.
+ * This is in general called to engage a module to the axis2 engine. In other words modules handlers 
+ * are added into all global and operation specific phases appropriately. Where these handlers 
+ * should go is determined by the module handler specific descriptions in module.xml file. Also 
+ * module operations are added to service and built exeuction chains for those operations as well.
+ * First add all the handlers defined for system phases are added into system phases. Then module
+ * operations are added into each service. At the same time execution chains for these module
+ * operations are built as well. Then handlers defined for user phases are added into user defined
+ * pahses.
  */
 
 AXIS2_EXTERN axis2_status_t AXIS2_CALL
@@ -354,16 +343,16 @@
 }
 
 /**
- * This function is called to engage a module to a service specifically. In
- * other words all module handlers are added into service operation's execution
- * chains appropriately. Where each module handler should go is determined by
- * module handler descriptions in module.xml file.
- * First we add the operations defined in the module into the service and built
- * execution chains for them.
- * Then for all the operations of the service we check whether the module 
- * already engaged to operation. If not engage it to service operation.
- * Also if the module is newly engaged to operation add the module qnname to
- * the engaged module list of the operation.
+ * This function is called to engage a module to a service specifically. In other words all module 
+ * handlers defined for user phases are added into user defined phases and all module handlers 
+ * defined for system defined phases are added into system defined phases. Note that user defined
+ * phases are in the flows taken from operation and system defined phases are in the flows taken
+ * from conf. Where each module handler should go is determined by module handler descriptions in 
+ * module.xml file.
+ * First we add the operations defined in the module into the service and built execution chains for 
+ * them. Then for all the operations of the service we check whether the module 
+ * already engaged to operation. If not engage it to service operation. Also if the module is newly 
+ * engaged to operation add the module qnname to the engaged module list of the operation.
  */
 AXIS2_EXTERN axis2_status_t AXIS2_CALL
 axis2_phase_resolver_engage_module_to_svc(
@@ -470,9 +459,9 @@
 }
 
 /**
- * In this function all the handlers in each flow of the module description 
- * are added to the phases of the operation. First handlers of global phases
- * are added. Then handlers of operation specific phases are added.
+ * In this function all the handlers in each flow of the module description are added to the phases 
+ * of the operation(user define phases) and phases of the conf(system defined phases). First handlers 
+ * for system defined phases are added. Then handlers for operation specific phases are added.
  */
 AXIS2_EXTERN axis2_status_t AXIS2_CALL
 axis2_phase_resolver_engage_module_to_op(
@@ -685,12 +674,11 @@
 
 /**
  * For operation passed as parameter, build execution chains. To do this get all engaged modules
- * from the axis2 configuration and for each module get the all handlers to be 
- * add to the operation specific phases. Then for each operation specific phases 
- * add those handlers. It should be noted that by the time this function is called
- * the module handlers are already added to system specific phases. 
- * This function is called from axis2_phase_resolver_build_execution_chains_for_svc() function and 
- * axis2_phase_resolver_build_execution_chains_for_module_op() function.
+ * from the axis2 configuration and for each module get the all handlers to be add to the operation 
+ * specific phases. Then for each operation specific phases add those handlers. It should be noted 
+ * that by the time this function is called the module handlers are already added to system specific 
+ * phases. This function is called from axis2_phase_resolver_build_execution_chains_for_svc() 
+ * function and axis2_phase_resolver_build_execution_chains_for_module_op() function.
  */
 static axis2_status_t
 axis2_phase_resolver_build_execution_chains_for_op(
@@ -919,11 +907,10 @@
 }
 
 /**
- * Take the phases for each flow from the axis2 configuration, take all the
- * handlers of each flow from the module description and then each handler
- * is added into the corresponding global phase. This function is called
- * from  function axis2_phase_resolver_engage_module_globally() to add module
- * handlers into global phases.
+ * Take the phases for each flow from the axis2 configuration, take all the handlers of each flow 
+ * from the module description and then each handler is added into the corresponding global phase. 
+ * This function is called from  function axis2_phase_resolver_engage_module_globally() to add 
+ * module handlers into global phases.
  */
 static axis2_status_t
 axis2_phase_resolver_add_module_handlers_to_system_defined_phases(
@@ -936,6 +923,7 @@
     axis2_phase_holder_t *phase_holder = NULL;
     const axutil_qname_t *modqname = NULL;
     axis2_char_t *modname = NULL;
+
     AXIS2_LOG_TRACE(env->log, AXIS2_LOG_SI, 
         "Entry:axis2_phase_resolver_add_module_handlers_to_system_defined_phases");
 
@@ -1083,11 +1071,10 @@
 }
 
 /**
- * For each operation of the service first check whether module is already 
- * engaged to operation. If not take each operations flows and add the module
- * handlers into them appropriately. This function is called from function
- * axis2_phase_resolver_engage_module_globally() to add handlers from module
- * into each services all operations.
+ * For each operation of the service first check whether module is already engaged to operation. 
+ * If not take each operations flows and add the module handlers into them appropriately. This 
+ * function is called from function axis2_phase_resolver_engage_module_globally() to add handlers 
+ * from module into each services all operations.
  */
 static axis2_status_t
 axis2_phase_resolver_add_module_handlers_to_user_defined_phases(