Author: manjula
Date: Wed Oct 3 20:47:43 2007
New Revision: 581767
URL: http://svn.apache.org/viewvc?rev=581767&view=rev
Log:
Some comments added to the method declarations of neethi_engine.h.
Modified:
webservices/axis2/trunk/c/neethi/include/neethi_engine.h
Modified: webservices/axis2/trunk/c/neethi/include/neethi_engine.h
URL:
http://svn.apache.org/viewvc/webservices/axis2/trunk/c/neethi/include/neethi_engine.h?rev=581767&r1=581766&r2=581767&view=diff
==============================================================================
--- webservices/axis2/trunk/c/neethi/include/neethi_engine.h (original)
+++ webservices/axis2/trunk/c/neethi/include/neethi_engine.h Wed Oct 3
20:47:43 2007
@@ -19,6 +19,12 @@
#ifndef NEETHI_ENGINE_H
#define NEETHI_ENGINE_H
+/*neethis_engine.c contains all the useful functions
+ * for dealing with a neethi_policy object
+ */
+
+
+
/**
* @file neethi_engine.h
* @contains neethi_policy creation logic.
@@ -40,18 +46,60 @@
{
#endif
+ /**
+ * Given an axiom model this function will return
+ * a neethi_policy object.
+ * @param env pointer to environment struct
+ * @param node to an axiom_node
+ * @param node to an axiom_element
+ * @return pointer to a neethi_policy_t struct
+ */
+
AXIS2_EXTERN neethi_policy_t *AXIS2_CALL
neethi_engine_get_policy(
const axutil_env_t * env,
axiom_node_t * node,
axiom_element_t * element);
+ /**
+ * Given a neethi_policy object this will return the
+ * normalized policy object.
+ * @param env pointer to environment struct
+ * @param deep to specify whether assertion level normalization
+ needed.
+ * @param neethi_policy_t to the policy which is not
+ normalized.
+ * @return pointer to a normalized neethi_policy_t struct
+ */
+
+ /*This function will return a new neethi_policy struct.
+ So it is callers responsibility to free the neethi_policy
+ which is passed as an argument. */
+
AXIS2_EXTERN neethi_policy_t *AXIS2_CALL
neethi_engine_get_normalize(
const axutil_env_t * env,
axis2_bool_t deep,
neethi_policy_t * neethi_policy);
+ /**
+ * Given a neethi_policy object this will return the
+ * normalized policy object.
+ * @param env pointer to environment struct
+ * @param deep to specify whether assertion level normalization
+ needed.
+ * @param neethi_policy_t to the policy which is not
+ normalized.
+ * @param registry neethi_registry_t struct which contains
+ policy objects.
+ * @return pointer to a normalized neethi_policy_t struct
+ */
+
+ /*This function will return a new neethi_policy struct.
+ So it is callers responsibility to free the neethi_policy
+ which is passed as an argument. */
+
+
AXIS2_EXTERN neethi_policy_t *AXIS2_CALL
neethi_engine_normalize(
const axutil_env_t * env,
@@ -59,11 +107,29 @@
neethi_registry_t * registry,
axis2_bool_t deep);
+ /*Givnen to normalized policy objects this function will
+ retun the merged policy object.
+ * @param env pointer to environment struct
+ * @param neethi_policy1 pointer neethi_policy_t struct as an
+ * input for merge.
+ * @param neethi_policy2 pointer neethi_policy_t struct as an
+ * input for merge.
+ * @return pointer to a merged policy of both inputs.*/
+
+ /*The input for this function should be two normalized policies
+ otherwise the output may be wrong.*/
+
AXIS2_EXTERN neethi_policy_t *AXIS2_CALL
neethi_engine_merge(
const axutil_env_t * env,
neethi_policy_t * neethi_policy1,
neethi_policy_t * neethi_policy2);
+
+ /*Given a policy object this function will give the
+ * corresponding axiom model for that policy object.
+ * @param policy pointer to the neethi_policy_t struct.
+ * @param env pointer to environment struct
+ */
AXIS2_EXTERN axiom_node_t *AXIS2_CALL
neethi_engine_serialize(
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
