Author: lahiru
Date: Mon Apr 14 09:42:48 2008
New Revision: 647892
URL: http://svn.apache.org/viewvc?rev=647892&view=rev
Log:
Hackathon RampartC:adding method discription in to header files
Modified:
webservices/rampart/trunk/c/include/rampart_error.h
webservices/rampart/trunk/c/include/rampart_issued.h
webservices/rampart/trunk/c/include/rampart_issued_token.h
webservices/rampart/trunk/c/include/rampart_replay_detector.h
webservices/rampart/trunk/c/include/rampart_saml.h
webservices/rampart/trunk/c/include/rampart_saml_token.h
Modified: webservices/rampart/trunk/c/include/rampart_error.h
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/rampart_error.h?rev=647892&r1=647891&r2=647892&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/rampart_error.h (original)
+++ webservices/rampart/trunk/c/include/rampart_error.h Mon Apr 14 09:42:48 2008
@@ -62,6 +62,12 @@
typedef enum rampart_error_codes rampart_error_codes_t;
+ /**
+ * initialising method for error
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
+
axis2_status_t AXIS2_CALL
rampart_error_init();
Modified: webservices/rampart/trunk/c/include/rampart_issued.h
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/rampart_issued.h?rev=647892&r1=647891&r2=647892&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/rampart_issued.h (original)
+++ webservices/rampart/trunk/c/include/rampart_issued.h Mon Apr 14 09:42:48
2008
@@ -26,6 +26,16 @@
{
#endif
+ /**
+ *
+ * @param rampart_context
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param sec_node
+ * @param sign_parts
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
+
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_issued_supporting_token_build(
rampart_context_t *rampart_context,
Modified: webservices/rampart/trunk/c/include/rampart_issued_token.h
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/rampart_issued_token.h?rev=647892&r1=647891&r2=647892&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/rampart_issued_token.h (original)
+++ webservices/rampart/trunk/c/include/rampart_issued_token.h Mon Apr 14
09:42:48 2008
@@ -37,30 +37,66 @@
const axutil_env_t *env,
rp_property_t *issued_token,
void *ctx);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
+
AXIS2_EXTERN rampart_issued_token_t * AXIS2_CALL
rampart_issued_token_create(
const axutil_env_t *env);
+ /**
+ *
+ * @param token
+ * @param env pointer to environment struct,Must not be NULL.
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_issued_token_free(
rampart_issued_token_t *token,
const axutil_env_t *env);
+ /**
+ *
+ * @param issued_token
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param token
+ * @param token_type
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_issued_token_set_token(
rampart_issued_token_t *issued_token,
const axutil_env_t *env, void *token,
rp_property_type_t token_type);
-
+ /**
+ *
+ * @param token
+ * @param env pointer to environment struct,Must not be NULL.
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN rp_property_type_t AXIS2_CALL
rampart_issued_token_get_token_type(
rampart_issued_token_t *token,
const axutil_env_t *env);
+ /**
+ *
+ * @param token
+ * @param env pointer to environment struct,Must not be NULL.
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN void * AXIS2_CALL
rampart_issued_token_get_token(
Modified: webservices/rampart/trunk/c/include/rampart_replay_detector.h
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/rampart_replay_detector.h?rev=647892&r1=647891&r2=647892&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/rampart_replay_detector.h (original)
+++ webservices/rampart/trunk/c/include/rampart_replay_detector.h Mon Apr 14
09:42:48 2008
@@ -75,35 +75,87 @@
axutil_param_t *param;
};
- /*The default impl for RRD*/
+
+ /**
+ * The default impl for RRD
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param msg_ctx
+ * @param rampart_context
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
+
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_replay_detector_default(const axutil_env_t *env,
axis2_msg_ctx_t *msg_ctx,
rampart_context_t *rampart_context);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param ctx
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
rampart_replay_detector_set_default_db(const axutil_env_t *env,
axis2_ctx_t *ctx);
+ /**
+ * A linked list based implementation for RRD
+ * This doesnt required addressing headers to be present
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param msg_ctx
+ * @param rampart_context
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
- /*A linked list based implementation for RRD
- This doesnt required addressing headers to be present*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_replay_detector_with_linked_list(const axutil_env_t *env,
axis2_msg_ctx_t* msg_ctx,
rampart_context_t *rampart_context);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param ctx
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axutil_linked_list_t *AXIS2_CALL
rampart_replay_detector_set_ll_db(const axutil_env_t *env,
axis2_ctx_t *ctx);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param msg_ctx
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_replay_detector_final_cleanup(const axutil_env_t *env,
axis2_msg_ctx_t* msg_ctx);
+ /**
+ *
+ * @param linked_list
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param id
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
rampart_replay_detector_linked_list_contains(axutil_linked_list_t
*linked_list,
const axutil_env_t *env,
axis2_char_t *id);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param msg_ctx
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_char_t * AXIS2_CALL
rampart_replay_detector_get_ts(const axutil_env_t *env,
Modified: webservices/rampart/trunk/c/include/rampart_saml.h
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/rampart_saml.h?rev=647892&r1=647891&r2=647892&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/rampart_saml.h (original)
+++ webservices/rampart/trunk/c/include/rampart_saml.h Mon Apr 14 09:42:48 2008
@@ -49,34 +49,82 @@
#define RAMPART_ST_FAULT_INVALIDSECURITYTOKEN_CODE
"wsse:InvalidSecurityToken"
#define RAMPART_SAML_FAULT_CODE "env:Sender"
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param rampart_context
+ * @param sec_node
+ * @param sign_parts
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_saml_supporting_token_build(const axutil_env_t *env,
rampart_context_t *rampart_context,
axiom_node_t *sec_node,
axutil_array_list_t *sign_parts);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param rampart_context
+ * @param assertion
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_saml_token_validate(const axutil_env_t *env,
rampart_context_t *rampart_context,
axiom_node_t *assertion);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param assertion
+ * @returns
+ */
AXIS2_EXTERN char * AXIS2_CALL
rampart_saml_token_get_subject_confirmation(const axutil_env_t *env,
axiom_node_t *assertion);
-/* SAML token proccessing faults */
+
+ /**
+ * SAML token proccessing faults
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param ctx
+ * @returns
+ */
+
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_fault_securitytokenunavailable(axutil_env_t *env,
axis2_msg_ctx_t *ctx);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param ctx
+ * @returns
+ */
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_fault_unsupportedsecuritytoken(axutil_env_t *env,
axis2_msg_ctx_t *ctx);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param ctx
+ * @returns
+ */
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_fault_failedcheck(axutil_env_t *env,
axis2_msg_ctx_t *ctx);
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param ctx
+ * @returns
+ */
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_fault_invalidsecuritytoken(axutil_env_t *env,
Modified: webservices/rampart/trunk/c/include/rampart_saml_token.h
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/rampart_saml_token.h?rev=647892&r1=647891&r2=647892&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/rampart_saml_token.h (original)
+++ webservices/rampart/trunk/c/include/rampart_saml_token.h Mon Apr 14
09:42:48 2008
@@ -44,51 +44,139 @@
typedef struct rampart_saml_token_t rampart_saml_token_t;
+ /**
+ *
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param assertion
+ * @param type
+ * returns
+ */
+
AXIS2_EXTERN rampart_saml_token_t *AXIS2_CALL
rampart_saml_token_create(const axutil_env_t *env, axiom_node_t *assertion,
rampart_st_confir_type_t type);
+ /**
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * returns
+ */
+
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_free(rampart_saml_token_t *tok, const axutil_env_t *env);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param assertion
+ * returns
+ */
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_set_assertion(rampart_saml_token_t *tok, const axutil_env_t
*env,
axiom_node_t *assertion);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * returns
+ */
AXIS2_EXTERN axiom_node_t* AXIS2_CALL
rampart_saml_token_get_assertion(rampart_saml_token_t *tok, const axutil_env_t
*env);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param assertion
+ * returns
+ */
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_set_type(rampart_saml_token_t *tok, const axutil_env_t
*env,
rampart_st_confir_type_t type);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * returns
+ */
AXIS2_EXTERN rampart_st_confir_type_t AXIS2_CALL
rampart_saml_token_get_type(rampart_saml_token_t *tok, const axutil_env_t
*env);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param key
+ * returns
+ */
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_set_key_value(rampart_saml_token_t *tok, const axutil_env_t
*env,
oxs_key_t *key);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * returns
+ */
AXIS2_EXTERN axiom_node_t * AXIS2_CALL
rampart_saml_token_get_str(rampart_saml_token_t *tok, const axutil_env_t *env);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param str
+ * returns
+ */
AXIS2_EXTERN int AXIS2_CALL
rampart_saml_token_set_str(rampart_saml_token_t *tok, const axutil_env_t *env,
axiom_node_t *str);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param is_token_added
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_saml_token_set_is_added_to_header(rampart_saml_token_t *tok,
const axutil_env_t *env,
axis2_bool_t is_token_added);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * returns
+ */
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
rampart_saml_token_is_added_to_header(rampart_saml_token_t *tok,
const axutil_env_t *env);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * @param token_type
+ * @returns status of the op.
+ * AXIS2_SUCCESS on success and AXIS2_FAILURE on error
+ */
AXIS2_EXTERN axis2_status_t AXIS2_CALL
rampart_saml_token_set_token_type(rampart_saml_token_t *tok,
const
axutil_env_t *env,
rp_property_type_t token_type);
+ /**
+ *
+ * @param tok
+ * @param env pointer to environment struct,Must not be NULL.
+ * returns
+ */
AXIS2_EXTERN rp_property_type_t AXIS2_CALL
rampart_saml_token_get_token_type(rampart_saml_token_t *tok,
