1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef AXIS2_HTTP_SIMPLE_RESPONSE_H
#define AXIS2_HTTP_SIMPLE_RESPONSE_H
/**
* @defgroup axis2_http_simple_response http simple response
* @ingroup axis2_core_trans_http
* @{
*/
/**
* @file axis2_simple_http_response.h
* @brief axis2 HTTP Simple Response
*/
#include <axis2_const.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axutil_array_list.h>
#include <axis2_http_status_line.h>
#include <axis2_http_header.h>
#include <axutil_stream.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** Type name for struct axis2_http_simple_response */
typedef struct axis2_http_simple_response axis2_http_simple_response_t;
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param http_ver pointer to http_ver
* @param status_code pointer to status code
* @param phrase pointer to phrase
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_http_simple_response_set_status_line(
struct axis2_http_simple_response *simple_response,
const axutil_env_t * env,
const axis2_char_t * http_ver,
const int status_code,
const axis2_char_t * phrase);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_http_simple_response_get_phrase(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN int AXIS2_CALL
axis2_http_simple_response_get_status_code(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_http_simple_response_get_http_version(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_http_simple_response_get_status_line(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param name pointer to name
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_http_simple_response_contains_header(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
const axis2_char_t * name);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_http_simple_response_get_headers(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_http_simple_response_extract_headers(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param str pointer to str
*/
AXIS2_EXTERN axis2_http_header_t *AXIS2_CALL
axis2_http_simple_response_get_first_header(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
const axis2_char_t * str);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param str pointer to str
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_http_simple_response_remove_headers(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
const axis2_char_t * str);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param header pointer to header
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_http_simple_response_set_header(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
axis2_http_header_t * header);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param headers double pointer to headers
* @param array_size
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_http_simple_response_set_headers(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
axis2_http_header_t ** headers,
axis2_ssize_t array_size);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_http_simple_response_get_charset(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN axis2_ssize_t AXIS2_CALL
axis2_http_simple_response_get_content_length(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_http_simple_response_get_content_type(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param str pointer to str
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_http_simple_response_set_body_string(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
axis2_char_t * str);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param stream pointer to stream
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_http_simple_response_set_body_stream(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
axutil_stream_t * stream);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
*/
AXIS2_EXTERN axutil_stream_t *AXIS2_CALL
axis2_http_simple_response_get_body(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @param buf double pointer to buf
*/
AXIS2_EXTERN axis2_ssize_t AXIS2_CALL
axis2_http_simple_response_get_body_bytes(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
axis2_char_t ** buf);
/**
* @param simple_response pointer to simple response struct
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_http_simple_response_free(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
/**
* @param env pointer to environment struct
* @param status_line pointer to status line
* @param http_headers double pointer to http_headers
* @param http_hdr_count
* @param content pointer to content
*/
AXIS2_EXTERN axis2_http_simple_response_t *AXIS2_CALL
axis2_http_simple_response_create(
const axutil_env_t * env,
axis2_http_status_line_t * status_line,
const axis2_http_header_t ** http_headers,
const axis2_ssize_t http_hdr_count,
axutil_stream_t * content);
/**
* @param env pointer to environment struct
*/
AXIS2_EXTERN axis2_http_simple_response_t *AXIS2_CALL
axis2_http_simple_response_create_default(
const axutil_env_t * env);
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_http_simple_response_get_mime_parts(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
AXIS2_EXTERN void AXIS2_CALL
axis2_http_simple_response_set_mime_parts(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
axutil_array_list_t *mime_parts);
axis2_status_t AXIS2_CALL
axis2_http_simple_response_set_http_version(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
axis2_char_t *http_version);
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_http_simple_response_get_mtom_sending_callback_name(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env);
void AXIS2_EXTERN AXIS2_CALL
axis2_http_simple_response_set_mtom_sending_callback_name(
axis2_http_simple_response_t * simple_response,
const axutil_env_t * env,
axis2_char_t *mtom_sending_callback_name);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_HTTP_SIMPLE_RESPONSE_H */
|