axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nand...@apache.org
Subject svn commit: r668594 - /webservices/axis2/trunk/c/include/axis2_http_transport_utils.h
Date Tue, 17 Jun 2008 09:48:48 GMT
Author: nandika
Date: Tue Jun 17 02:48:48 2008
New Revision: 668594

URL: http://svn.apache.org/viewvc?rev=668594&view=rev
Log:
comments and new functions added

Modified:
    webservices/axis2/trunk/c/include/axis2_http_transport_utils.h

Modified: webservices/axis2/trunk/c/include/axis2_http_transport_utils.h
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/include/axis2_http_transport_utils.h?rev=668594&r1=668593&r2=668594&view=diff
==============================================================================
--- webservices/axis2/trunk/c/include/axis2_http_transport_utils.h (original)
+++ webservices/axis2/trunk/c/include/axis2_http_transport_utils.h Tue Jun 17 02:48:48 2008
@@ -26,7 +26,9 @@
 
 /**
   * @file axis2_http_transport_utils.h
-  * @brief axis2 HTTP Transport Utility class
+  * @brief axis2 HTTP Transport Utility functions
+  * This file includes functions that handles soap and rest request
+  * that comes to the engine via HTTP protocol.
   */
 
 #include <axis2_const.h>
@@ -40,29 +42,127 @@
 #include <axutil_stream.h>
 #include <axiom_soap_envelope.h>
 #include <axutil_http_chunked_stream.h>
+#include <axis2_http_out_transport_info.h>
 #include <axutil_url.h>
 
 #ifdef __cplusplus
 extern "C"
 {
 #endif
-
-    /*
-     * struct to hold the callback information
-     */
-    /*struct axis2_callback_info
-    {
-        const axutil_env_t *env;
-        void *in_stream;
-        int content_length;
-        int unread_len;
-        axutil_http_chunked_stream_t *chunked_stream;
-    };
-    typedef struct axis2_callback_info axis2_callback_info_t;
+	
+	typedef enum axis2_http_method_types
+	{
+		AXIS2_HTTP_METHOD_GET = 0,
+		AXIS2_HTTP_METHOD_POST,
+		AXIS2_HTTP_METHOD_HEAD,
+		AXIS2_HTTP_METHOD_PUT,
+		AXIS2_HTTP_METHOD_DELETE
+	}axis2_http_method_types_t;
+
+	
+	typedef struct axis2_http_transport_in
+	{
+		/** HTTP Content type */
+		axis2_char_t *content_type;
+		/** HTTP Content length */
+		int content_length;
+		/** Input message context */
+		axis2_msg_ctx_t *msg_ctx;
+		
+		/** soap action */
+		axis2_char_t *soap_action;
+		
+		/** complete request uri */
+		axis2_char_t *request_uri;
+		
+		/** Input stream */
+		axutil_stream_t *in_stream;
+		
+		/** remote request ip  corresponds to CGI header REMOTE_ADDR */
+		axis2_char_t *remote_ip;
+		
+		/** server port */
+		axis2_char_t *svr_port;
+		
+		/** HTTP transfer encoding header value */
+		axis2_char_t *transfer_encoding;
+		
+		/** HTTP Accept header */
+		axis2_char_t *accept_header;
+		
+		/** HTTP Accept language header */
+		axis2_char_t *accept_language_header;
+		
+		/** HTTP accept charset header */
+		axis2_char_t *accept_charset_header;
+		/** HTTP METHOD  Should be one of AXIS2_HTTP_METHOD_GET | AXIS2_HTTP_METHOD_POST |"
+		AXIS2_HTTP_METHOD_HEAD | AXIS2_HTTP_METHOD_PUT | AXIS2_HTTP_METHOD_DELETE" */
+		int request_method;
+		/** out transport */
+		axis2_http_out_transport_info_t *out_transport_info;
+		/** this is for serving services html */
+		axis2_char_t *request_url_prefix;
+
+	}axis2_http_transport_in_t;
+
+	typedef struct axis2_http_transport_out
+	{
+		/** HTTP Status code string */
+		axis2_char_t *http_status_code_name;
+		/** HTTP Status code value */
+		int http_status_code;
+		/** Out message context */
+		axis2_msg_ctx_t *msg_ctx;
+		/** Response data */
+		void *response_data;
+		/** HTTP content type */
+		axis2_char_t *content_type;
+		/** Response data length */
+		int response_data_length;
+		/** content language */
+		axis2_char_t *content_language;
+		/** output headers list */
+		axutil_array_list_t *output_headers;
+		
+	}axis2_http_transport_out_t;
+
+
+	/**
+	* This methods provides the HTTP request handling functionality using axis2 for server side

+	* HTTP modules.
+	* @param env, environments 
+	* @param conf_ctx, Instance of axis2_conf_ctx_t
+	* @param request, populated instance of axis2_http_transport_in_t struct
+	* @param response, an instance of axis2_http_transport_out_t struct
+	* @returns AXIS2_SUCCESS on success, AXIS2_FAILURE Otherwise
+	*/
+	AXIS2_EXTERN axis2_status_t AXIS2_CALL
+	axis2_http_transport_utils_process_request(
+		const axutil_env_t *env,
+		axis2_conf_ctx_t *conf_ctx,
+		axis2_http_transport_in_t *request,
+		axis2_http_transport_out_t *response);
+
+
+
+    /**
+    * This function handles the HTTP POST request that comes to the axis2 engine.
+	* The request can be either a SOAP request OR a REST request. 
+    * @param env, axutil_env_t instance
+    * @param msg_ctx, Input message context. (an instance of axis2_msg_ctx_t struct.) 
+    * @param in_stream, This is the input message content represented as an axutil_stream
instance.
+	*  A callback function will be used to read as required from the stream with in the engine.
+    * @param out_stream, This is the output stream. The outgoing message contents is represented
as
+	*                 an instance of axutil_stream
+    * @param content_type, HTTP content type. This value should not be null.
+    * @param content_length, HTTP Content length value.
+    * @param soap_action_header, SOAPAction header value. This is only required in case of
SOAP 1.1.
+	*         For SOAP 1.2 , the action header will be within the ContentType header and
+	*         this method is able to obtain the extract the action header value from content
type.
+    * @param request_uri, This is the HTTP request uri. Should not be null.
+    * @returns AXIS2_SUCCESS on success, AXIS2_FAILURE Otherwise
     */
-
     AXIS2_EXTERN axis2_status_t AXIS2_CALL
-
     axis2_http_transport_utils_process_http_post_request(
         const axutil_env_t * env,
         axis2_msg_ctx_t * msg_ctx,
@@ -73,8 +173,21 @@
         axutil_string_t * soap_action_header,
         const axis2_char_t * request_uri);
 
-    AXIS2_EXTERN axis2_status_t AXIS2_CALL
 
+    /**
+    * This method handles the HTTP put request. Parameters are similar to that of post_request
+	* method.
+    * @param env, environment
+    * @param msg_ctx, in message context.
+    * @param in_stream, input stream
+    * @param out_stream, output stream.
+    * @param content_type, HTTP ContentType header value
+    * @param content_length, HTTP Content length value
+    * @param soap_action_header, SOAP Action header value
+    * @param request_uri, request uri
+    * @returns AXIS2_SUCCESS on success, AXIS2_FAILURE Otherwise
+    */
+    AXIS2_EXTERN axis2_status_t AXIS2_CALL
     axis2_http_transport_utils_process_http_put_request(
         const axutil_env_t * env,
         axis2_msg_ctx_t * msg_ctx,
@@ -86,7 +199,6 @@
         const axis2_char_t * request_uri);
 
     AXIS2_EXTERN axis2_bool_t AXIS2_CALL
-
     axis2_http_transport_utils_process_http_get_request(
         const axutil_env_t * env,
         axis2_msg_ctx_t * msg_ctx,
@@ -231,9 +343,14 @@
         axis2_msg_ctx_t * msg_ctx,
         const axis2_char_t * soap_ns_uri);
 
+	AXIS2_EXTERN axutil_array_list_t* AXIS2_CALL
+	axis2_http_transport_utils_process_accept_headers(
+		const axutil_env_t *env,
+		axis2_char_t *accept_value);
+
     /** @} */
 #ifdef __cplusplus
 }
 #endif
 
-#endif                          /* AXIS2_HTTP_TRANSPORT_UTILS_H */
+#endif       /* AXIS2_HTTP_TRANSPORT_UTILS_H */



Mime
View raw message