/usr/include/axis2-1.6.0/axis2_msg_ctx.h is in libaxis2c-dev 1.6.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 | /*
* 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_MSG_CTX_H
#define AXIS2_MSG_CTX_H
/**
* @defgroup axis2_msg_ctx message context
* @ingroup axis2_context
* message context captures all state information related to a message
* invocation. It holds information on the service and operation to be invoked
* as well as context hierarchy information related to the service and operation.
* It also has information on transports, that are to be used in invocation. The
* phase information is kept, along with the phase at which message invocation was
* paused as well as the handler in the phase from which the invocation is to be
* resumed. message context would hold the request SOAP message along the out
* path and would capture response along the in path.
* message context also has information on various engine specific information,
* such as if it should be doing MTOM, REST.
* As message context is inherited form context, it has the capability of
* storing user defined properties.
* @{
*/
/**
* @file axis2_msg_ctx.h
*/
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axis2_ctx.h>
#include <axis2_relates_to.h>
#include <axutil_param.h>
#include <axis2_handler_desc.h>
#include <axutil_qname.h>
#include <axutil_stream.h>
#include <axis2_msg_info_headers.h>
#ifdef __cplusplus
extern "C"
{
#endif
/** transport headers */
#define AXIS2_TRANSPORT_HEADERS "AXIS2_TRANSPORT_HEADERS"
/** transport in */
#define AXIS2_TRANSPORT_OUT "AXIS2_TRANSPORT_OUT"
/** transport out */
#define AXIS2_TRANSPORT_IN "AXIS2_TRANSPORT_IN"
/** character set encoding */
#define AXIS2_CHARACTER_SET_ENCODING "AXIS2_CHARACTER_SET_ENCODING"
/** UTF_8; This is the 'utf-8' value for AXIS2_CHARACTER_SET_ENCODING property */
#define AXIS2_UTF_8 "UTF-8"
/** UTF_16; This is the 'utf-16' value for AXIS2_CHARACTER_SET_ENCODING property */
#define AXIS2_UTF_16 "utf-16"
/** default char set encoding; This is the default value for AXIS2_CHARACTER_SET_ENCODING property */
#define AXIS2_DEFAULT_CHAR_SET_ENCODING "UTF-8"
/** transport succeeded */
#define AXIS2_TRANSPORT_SUCCEED "AXIS2_TRANSPORT_SUCCEED"
/** HTTP Client */
#define AXIS2_HTTP_CLIENT "AXIS2_HTTP_CLIENT"
/** Transport URL */
#define AXIS2_TRANSPORT_URL "TransportURL"
/** PEER IP Address of Server */
#define AXIS2_SVR_PEER_IP_ADDR "peer_ip_addr"
/* Message flows */
/* In flow */
/*#define AXIS2_IN_FLOW 1*/
/* In fault flow */
/*#define AXIS2_IN_FAULT_FLOW 2*/
/* Out flow */
/*#define AXIS2_OUT_FLOW 3*/
/* Out fault flow */
/*#define AXIS2_OUT_FAULT_FLOW 4*/
/** Type name for struct axis2_msg_ctx */
typedef struct axis2_msg_ctx axis2_msg_ctx_t;
struct axis2_svc;
struct axis2_op;
struct axis2_conf_ctx;
struct axis2_svc_grp_ctx;
struct axis2_svc_ctx;
struct axis2_op_ctx;
struct axis2_conf;
struct axiom_soap_envelope;
struct axis2_options;
struct axis2_transport_in_desc;
struct axis2_transport_out_desc;
struct axis2_out_transport_info;
/** Type name for pointer to a function to find a service */
typedef struct axis2_svc *(
AXIS2_CALL
* AXIS2_MSG_CTX_FIND_SVC) (
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/** Type name for pointer to a function to find an operation in a service */
typedef struct axis2_op *(
AXIS2_CALL
* AXIS2_MSG_CTX_FIND_OP) (
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_svc * svc);
/**
* Creates a message context struct instance.
* @param env pointer to environment struct
* @param conf_ctx pointer to configuration context struct, message context
* does not assume the ownership of the struct
* @param transport_in_desc pointer to transport in description struct,
* message context does not assume the ownership of the struct
* @param transport_out_desc pointer to transport out description struct,
* message context does not assume the ownership of the struct
* @return pointer to newly created message context instance
*/
AXIS2_EXTERN axis2_msg_ctx_t *AXIS2_CALL
axis2_msg_ctx_create(
const axutil_env_t * env,
struct axis2_conf_ctx *conf_ctx,
struct axis2_transport_in_desc *transport_in_desc,
struct axis2_transport_out_desc *transport_out_desc);
/**
* Gets the base, which is of type context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to base context struct
*/
AXIS2_EXTERN axis2_ctx_t *AXIS2_CALL
axis2_msg_ctx_get_base(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets parent. Parent of a message context is of type operation
* context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to operation context which is the parent
*/
AXIS2_EXTERN struct axis2_op_ctx *AXIS2_CALL
axis2_msg_ctx_get_parent(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets parent. Parent of a message context is of type operation
* context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param parent pointer to parent operation context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_parent(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_op_ctx *parent);
/**
* Frees message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return void
*/
AXIS2_EXTERN void AXIS2_CALL
axis2_msg_ctx_free(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Initializes the message context. Based on the transport, service and
* operation qnames set on top of message context, correct instances of
* those struct instances would be extracted from configuration and
* set within message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param conf pointer to configuration
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_init(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_conf *conf);
/**
* Gets WS-Addressing fault to address. Fault to address tells where to
* send the fault in case there is an error.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to endpoint reference struct representing the fault
* to address, returns a reference not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_msg_ctx_get_fault_to(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets WS-Addressing from endpoint. From address tells where the
* request came from.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to endpoint reference struct representing the from
* address, returns a reference not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_msg_ctx_get_from(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Checks if there is a SOAP fault on in flow.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if there is an in flow fault, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_in_fault_flow(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets the SOAP envelope. This SOAP envelope could be either request
* SOAP envelope or the response SOAP envelope, based on the state
* the message context is in.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to SOAP envelope stored within message context
*/
AXIS2_EXTERN struct axiom_soap_envelope *AXIS2_CALL
axis2_msg_ctx_get_soap_envelope(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets the SOAP envelope of the response.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to response SOAP envelope stored within message context
*/
AXIS2_EXTERN struct axiom_soap_envelope *AXIS2_CALL
axis2_msg_ctx_get_response_soap_envelope(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets fault SOAP envelope.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to fault SOAP envelope stored within message context
*/
AXIS2_EXTERN struct axiom_soap_envelope *AXIS2_CALL
axis2_msg_ctx_get_fault_soap_envelope(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets message ID.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param msg_id
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_msg_id(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_char_t * msg_id);
/**
* Gets message ID.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return message ID string corresponding to the message the message
* context is related to
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_msg_id(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets process fault status.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if process fault is on, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_process_fault(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets relates to information for the message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to relates to struct
*/
AXIS2_EXTERN axis2_relates_to_t *AXIS2_CALL
axis2_msg_ctx_get_relates_to(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets WS-Addressing reply to endpoint. Reply to address tells where
* the the response should be sent to.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to endpoint reference struct representing the reply
* to address, returns a reference not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_msg_ctx_get_reply_to(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Checks if it is on the server side that the message is being dealt
* with, or on the client side.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if it is server side, AXIS2_FALSE if it is client
* side
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_server_side(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets WS-Addressing to endpoint. To address tells where message should
* be sent to.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to endpoint reference struct representing the
* to address, returns a reference not a cloned copy
*/
AXIS2_EXTERN axis2_endpoint_ref_t *AXIS2_CALL
axis2_msg_ctx_get_to(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets WS-Addressing fault to endpoint. Fault to address tells where
* the fault message should be sent when there is an error.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param reference pointer to endpoint reference representing fault to
* address. message context assumes the ownership of endpoint struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_fault_to(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_endpoint_ref_t * reference);
/**
* Sets WS-Addressing from endpoint. From address tells where
* the message came from.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param reference pointer to endpoint reference representing from
* address. message context assumes the ownership of endpoint struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_from(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_endpoint_ref_t * reference);
/**
* Sets in fault flow status.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param in_fault_flow AXIS2_TRUE if there is a fault on in path,
* else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_in_fault_flow(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t in_fault_flow);
/**
* Sets SOAP envelope. The fact that if it is the request SOAP envelope
* or that of response depends on the current status represented by
* message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param soap_envelope pointer to SOAP envelope, message context
* assumes ownership of SOAP envelope
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_soap_envelope(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axiom_soap_envelope *soap_envelope);
/**
* Sets response SOAP envelope.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param soap_envelope pointer to SOAP envelope, message context
* assumes ownership of SOAP envelope
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_response_soap_envelope(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axiom_soap_envelope *soap_envelope);
/**
* Sets fault SOAP envelope.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param soap_envelope pointer to SOAP envelope, message context
* assumes ownership of SOAP envelope
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_fault_soap_envelope(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axiom_soap_envelope *soap_envelope);
/**
* Sets message ID.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param message_id message ID string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_message_id(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * message_id);
/**
* Sets process fault bool value.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param process_fault AXIS2_TRUE if SOAP faults are to be processed,
* else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_process_fault(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t process_fault);
/**
* Sets relates to struct.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param reference pointer to relates to struct, message context
* assumes ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_relates_to(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_relates_to_t * reference);
/**
* Sets WS-Addressing reply to address indicating the location to which
* the reply would be sent.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param reference pointer to endpoint reference representing reply to
* address
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_reply_to(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_endpoint_ref_t * reference);
/**
* Sets the bool value indicating if it is the server side or the
* client side.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param server_side AXIS2_TRUE if it is server side, AXIS2_FALSE if it
* is client side
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_server_side(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t server_side);
/**
* Sets WS-Addressing to address.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param reference pointer to endpoint reference struct representing
* the address where the request should be sent to. message context
* assumes ownership of endpoint struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_to(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_endpoint_ref_t * reference);
/**
* Gets the bool value indicating if it is required to have a new thread
* for the invocation, or if the same thread of execution could be used.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if new thread is required, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_new_thread_required(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the bool value indicating if it is required to have a new thread
* for the invocation, or if the same thread of execution could be used.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param new_thread_required AXIS2_TRUE if a new thread is required,
* else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_new_thread_required(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t new_thread_required);
/**
* Sets WS-Addressing action.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param action_uri WSA action URI string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_wsa_action(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * action_uri);
/**
* Gets WS-Addressing action.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to WSA action URI string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_wsa_action(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets WS-Addressing message ID.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param message_id pointer to message ID string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_wsa_message_id(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * message_id);
/**
* Gets WS-Addressing message ID.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return WSA message ID string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_wsa_message_id(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets WS-Addressing message information headers.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to message information headers struct with
* WS-Addressing information. Returns a reference, not a cloned copy
*/
AXIS2_EXTERN axis2_msg_info_headers_t *AXIS2_CALL
axis2_msg_ctx_get_msg_info_headers(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets the bool value indicating the paused status. It is possible
* to pause the engine invocation by any handler. By calling this method
* one can find out if some handler has paused the invocation.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if message context is paused, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_paused(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the bool value indicating the paused status of invocation.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param paused paused
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_paused(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t paused);
/**
* Gets the bool value indicating the keep alive status. It is possible
* to keep alive the message context by any handler. By calling this method
* one can see whether it is possible to clean the message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if message context is keep alive, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_is_keep_alive(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the bool value indicating the keep alive status of invocation.
* By setting this one can indicate the engine not to clean the message
* context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param keep_alive keep alive
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_keep_alive(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t keep_alive);
/**
* Gets transport in description.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to transport in description struct, returns a
* reference not a cloned copy
*/
AXIS2_EXTERN struct axis2_transport_in_desc *AXIS2_CALL
axis2_msg_ctx_get_transport_in_desc(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets transport out description.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to transport out description struct, returns a
* reference not a cloned copy
*/
AXIS2_EXTERN struct axis2_transport_out_desc *AXIS2_CALL
axis2_msg_ctx_get_transport_out_desc(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets transport in description.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param transport_in_desc pointer to transport in description struct,
* message context does not assume the ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_transport_in_desc(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_transport_in_desc *transport_in_desc);
/**
* Sets transport out description.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param transport_out_desc pointer to transport out description,
* message context does not assume the ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_transport_out_desc(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_transport_out_desc *transport_out_desc);
/**
* Gets operation context related to the operation that this message
* context is related to.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to operation context struct
*/
AXIS2_EXTERN struct axis2_op_ctx *AXIS2_CALL
axis2_msg_ctx_get_op_ctx(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets operation context related to the operation that this message
* context is related to.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param op_ctx pointer to operation context, message context does not
* assume the ownership of operation context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_op_ctx(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_op_ctx *op_ctx);
/**
* Gets the bool value indicating the output written status.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if output is written, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_output_written(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the bool value indicating the output written status.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param output_written AXIS2_TRUE if output is written, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_output_written(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t output_written);
/**
* Gets the HTTP Method that relates to the service that is
* related to the message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return HTTP Method string, returns a reference,
* not a cloned copy
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_rest_http_method(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the HTTP Method that relates to the service that is
* related to the message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param rest_http_method HTTP Method string, msg_ctx does not assume
* ownership of rest_http_method.
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_rest_http_method(
struct axis2_msg_ctx * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * rest_http_method);
/**
* Gets the ID of service context that relates to the service that is
* related to the message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return service context ID string
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_svc_ctx_id(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the ID of service context that relates to the service that is
* related to the message context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param svc_ctx_id The service context ID string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_svc_ctx_id(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * svc_ctx_id);
/**
* Gets configuration context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to configuration context
*/
AXIS2_EXTERN struct axis2_conf_ctx *AXIS2_CALL
axis2_msg_ctx_get_conf_ctx(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets service context that relates to the service that the message
* context is related to.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to message context struct
*/
AXIS2_EXTERN struct axis2_svc_ctx *AXIS2_CALL
axis2_msg_ctx_get_svc_ctx(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets configuration context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param conf_ctx pointer to configuration context struct, message
* context does not assume the ownership of struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_conf_ctx(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_conf_ctx *conf_ctx);
/**
* Sets service context.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param svc_ctx pointer to service context struct, message
* context does not assume the ownership of struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_svc_ctx(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_svc_ctx *svc_ctx);
/**
* Sets message information headers.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param msg_info_headers pointer to message information headers,
* message context assumes the ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_msg_info_headers(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_msg_info_headers_t * msg_info_headers);
/**
* Gets configuration descriptor parameter with given key. This method
* recursively search the related description hierarchy for the parameter
* with given key until it is found or the parent of the description
* hierarchy is reached. The order of search is as follows:
* \n
* 1. search in operation description, if its there return
* \n
* 2. if the parameter is not found in operation or operation is NULL,
* search in service
* \n
* 3. if the parameter is not found in service or service is NULL search
* in configuration
* @param msg_ctx message context
* @param env pointer to environment struct
* @param key parameter key
* @return pointer to parameter struct corresponding to the given key
*/
AXIS2_EXTERN axutil_param_t *AXIS2_CALL
axis2_msg_ctx_get_parameter(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * key);
/**
* Gets parameters related to a named module and a given handler
* description. The order of searching for parameter is as follows:
* \n
* 1. search in module configuration stored inside corresponding operation
* description if its there
* \n
* 2. search in corresponding operation if its there
* \n
* 3. search in module configurations stored inside corresponding
* service description if its there
* \n
* 4. search in corresponding service description if its there
* \n
* 5. search in module configurations stored inside configuration
* \n
* 6. search in configuration for parameters
* \n
* 7. get the corresponding module and search for the parameters
* \n
* 8. search in handler description for the parameter
* @param msg_ctx pointer to message context
* @param env pointer to environment struct
* @param key parameter key
* @param module_name name of the module
* @param handler_desc pointer to handler description
* @return pointer to parameter
*/
AXIS2_EXTERN axutil_param_t *AXIS2_CALL
axis2_msg_ctx_get_module_parameter(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * key,
const axis2_char_t * module_name,
axis2_handler_desc_t * handler_desc);
/**
* Gets property corresponding to the given key.
* @param msg_ctx pointer to message context
* @param env pointer to environment struct
* @param key key string with which the property is stored
* @return pointer to property struct
*/
AXIS2_EXTERN axutil_property_t *AXIS2_CALL
axis2_msg_ctx_get_property(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * key);
/**
* Gets property value corresponding to the property given key.
* @param msg_ctx pointer to message context
* @param env pointer to environment struct
* @param property_str key string with which the property is stored
* @return pointer to property struct
*/
AXIS2_EXTERN void *AXIS2_CALL
axis2_msg_ctx_get_property_value(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * property_str);
/**
* Sets property with given key.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param key key string
* @param value property to be stored
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_property(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * key,
axutil_property_t * value);
/**
* Gets the QName of the handler at which invocation was paused.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to QName of the paused handler
*/
AXIS2_EXTERN const axutil_string_t *AXIS2_CALL
axis2_msg_ctx_get_paused_handler_name(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets the name of the phase at which the invocation was paused.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return name string of the paused phase.
*/
AXIS2_EXTERN const axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_paused_phase_name(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the name of the phase at which the invocation was paused.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param paused_phase_name paused phase name string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_paused_phase_name(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * paused_phase_name);
/**
* Gets SOAP action.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return SOAP action string
*/
AXIS2_EXTERN axutil_string_t *AXIS2_CALL
axis2_msg_ctx_get_soap_action(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets SOAP action.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param soap_action SOAP action string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_soap_action(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_string_t * soap_action);
/**
* Gets the boolean value indicating if MTOM is enabled or not.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if MTOM is enabled, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_doing_mtom(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the boolean value indicating if MTOM is enabled or not.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param doing_mtom AXIS2_TRUE if MTOM is enabled, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_doing_mtom(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t doing_mtom);
/**
* Gets the boolean value indicating if REST is enabled or not.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if REST is enabled, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_doing_rest(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the boolean value indicating if REST is enabled or not.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param doing_rest AXIS2_TRUE if REST is enabled, else AXIS2_FALSE
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_doing_rest(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t doing_rest);
/**
* Sets the boolean value indicating if REST should be done through
* HTTP POST or not.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param do_rest_through_post AXIS2_TRUE if REST is to be done with
* HTTP POST, else AXIS2_FALSE if REST is not to be done with HTTP POST
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_do_rest_through_post(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t do_rest_through_post);
/**
* Sets the boolean value indicating if REST should be done through
* HTTP POST or not.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if REST is to be done with HTTP POST, else
* AXIS2_FALSE if REST is not to be done with HTTP POST
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_do_rest_through_post(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets manage session bool value.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if session is managed, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_manage_session(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets manage session bool value.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param manage_session manage session bool value
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_manage_session(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t manage_session);
/**
* Gets the bool value indicating the SOAP version being used either
* SOAP 1.1 or SOAP 1.2
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if SOAP 1.1 is being used, else AXIS2_FALSE if
* SOAP 1.2 is being used
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_is_soap_11(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the bool value indicating the SOAP version being used either
* SOAP 1.1 or SOAP 1.2
* @param msg_ctx message context
* @param env pointer to environment struct
* @param is_soap11 AXIS2_TRUE if SOAP 1.1 is being used, else
* AXIS2_FALSE if SOAP 1.2 is being used
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_is_soap_11(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t is_soap11);
/**
* Gets service group context. The returned service group context
* relates to the service group to which the service, related to the
* message context, belongs.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to service group struct
*/
AXIS2_EXTERN struct axis2_svc_grp_ctx *AXIS2_CALL
axis2_msg_ctx_get_svc_grp_ctx(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets service group context. The returned service group context
* relates to the service group to which the service, related to the
* message context, belongs.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param svc_grp_ctx pointer to service group context
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_svc_grp_ctx(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_svc_grp_ctx *svc_grp_ctx);
/**
* Gets the operation that is to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to operation, returns a reference not a cloned copy
*/
AXIS2_EXTERN struct axis2_op *AXIS2_CALL
axis2_msg_ctx_get_op(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the operation that is to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param op pointer to operation, message context does not assume the
* ownership of operation
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_op(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_op *op);
/**
* Gets the service to which the operation to be invoked belongs.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to service struct, returns a reference not a cloned copy
*/
AXIS2_EXTERN struct axis2_svc *AXIS2_CALL
axis2_msg_ctx_get_svc(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the service to which the operation to be invoked belongs.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param svc pointer to service struct, message context does not assume
* the ownership of struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_svc(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_svc *svc);
/**
* Gets the service group to which the service to be invoked belongs.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to service group struct, returns a reference not
* a cloned copy
*/
AXIS2_EXTERN struct axis2_svc_grp *AXIS2_CALL
axis2_msg_ctx_get_svc_grp(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the service group to which the service to be invoked belongs.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param svc_grp pointer to service group struct, message context does
* not assume the ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_svc_grp(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_svc_grp *svc_grp);
/**
* Gets the service group context ID.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return service group context ID string
*/
AXIS2_EXTERN const axutil_string_t *AXIS2_CALL
axis2_msg_ctx_get_svc_grp_ctx_id(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the service group context ID.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param svc_grp_ctx_id service group context ID string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_svc_grp_ctx_id(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_string_t * svc_grp_ctx_id);
/**
* Sets function to be used to find a service. This function is used by dispatchers
* to locate the service to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param func function to be used to find an operation
* @return pointer to service to be invoked
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_find_svc(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
AXIS2_MSG_CTX_FIND_SVC func);
/**
* Sets function to be used to find an operation in the given service.
* This function is used by dispatchers to locate the operation to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param func function to be used to find an operation
* @return pointer to the operation to be invoked
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_find_op(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
AXIS2_MSG_CTX_FIND_OP func);
/**
* Finds the service to be invoked. This function is used by dispatchers
* to locate the service to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer to service to be invoked
*/
AXIS2_EXTERN struct axis2_svc *AXIS2_CALL
axis2_msg_ctx_find_svc(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Finds the operation to be invoked in the given service. This function
* is used by dispatchers to locate the operation to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param svc pointer to service to whom the operation belongs
* @return pointer to the operation to be invoked
*/
AXIS2_EXTERN struct axis2_op *AXIS2_CALL
axis2_msg_ctx_find_op(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_svc *svc);
/**
* Gets the options to be used in invocation.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return options pointer to options struct, message context does not
* assume the ownership of the struct
*/
AXIS2_EXTERN struct axis2_options *AXIS2_CALL
axis2_msg_ctx_get_options(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets the bool value indicating the paused status.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if invocation is paused, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_is_paused(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the options to be used in invocation.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param options pointer to options struct, message context does not
* assume the ownership of the struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_options(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_options *options);
/**
* Sets the flow to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param flow int value indicating the flow
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_flow(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
int flow);
/**
* Gets the flow to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return int value indicating the flow
*/
AXIS2_EXTERN int AXIS2_CALL
axis2_msg_ctx_get_flow(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the list of supported REST HTTP Methods
* @param msg_ctx message context
* @param env pointer to environment struct
* @param supported_rest_http_methods pointer array list containing
* the list of HTTP Methods supported. Message context does
* assumes the ownership of the array list. Anything added to this
* array list will be freed by the msg_ctx
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_supported_rest_http_methods(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_array_list_t * supported_rest_http_methods);
/**
* Gets the list of supported REST HTTP Methods
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer array list containing
* the list of HTTP Methods supported. Message context does
* assumes the ownership of the array list
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_get_supported_rest_http_methods(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the execution chain to be invoked. The execution chain is a
* list of phases containing the handlers to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param execution_chain pointer array list containing the list of
* handlers that constitute the execution chain. Message context does
* not assume the ownership of the array list
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_execution_chain(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_array_list_t * execution_chain);
/**
* Gets the execution chain to be invoked. The execution chain is a
* list of phases containing the handlers to be invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return pointer array list containing the list of handlers that
* constitute the execution chain. Message context does not assume
* the ownership of the array list
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_get_execution_chain(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets current handler index, indicating which handler is currently
* being invoked in the execution chain
* @param msg_ctx message context
* @param env pointer to environment struct
* @param index index of currently executed handler
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_current_handler_index(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const int index);
/**
* Gets current handler index, indicating which handler is currently
* being invoked in the execution chain
* @param msg_ctx message context
* @param env pointer to environment struct
* @return index of currently executed handler
*/
AXIS2_EXTERN int AXIS2_CALL
axis2_msg_ctx_get_current_handler_index(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets paused handler index, indicating at which handler the execution
* chain was paused.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return index of handler at which invocation was paused
*/
AXIS2_EXTERN int AXIS2_CALL
axis2_msg_ctx_get_paused_handler_index(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets index of the current phase being invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param index index of current phase
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_current_phase_index(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const int index);
/**
* Gets index of the current phase being invoked.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return index of current phase
*/
AXIS2_EXTERN int AXIS2_CALL
axis2_msg_ctx_get_current_phase_index(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets the phase at which the invocation was paused.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return index of paused phase
*/
AXIS2_EXTERN int AXIS2_CALL
axis2_msg_ctx_get_paused_phase_index(
const axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets character set encoding to be used.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axutil_string_t *AXIS2_CALL
axis2_msg_ctx_get_charset_encoding(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets character set encoding to be used.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param str pointer to string struct representing encoding
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_charset_encoding(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_string_t * str);
/**
* Gets the integer value indicating http status_code.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return status value
*/
AXIS2_EXTERN int AXIS2_CALL
axis2_msg_ctx_get_status_code(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the int value indicating http status code
* @param msg_ctx message context
* @param env pointer to environment struct
* @param status_code of the http response
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_status_code(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const int status_code);
/**
* Gets the Transport Out Stream
* @param msg_ctx message context
* @param env pointer to environment struct
* @return reference to Transport Out Stream
*/
AXIS2_EXTERN axutil_stream_t *AXIS2_CALL
axis2_msg_ctx_get_transport_out_stream(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the Transport Out Stream
* @param msg_ctx message context
* @param env pointer to environment struct
* @param stream reference to Transport Out Stream
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_transport_out_stream(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_stream_t * stream);
/**
* Resets Transport Out Stream
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_reset_transport_out_stream(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets the HTTP Out Transport Info associated
* @param msg_ctx message context
* @param env pointer to environment struct
* @return reference to HTTP Out Transport Info associated
*/
AXIS2_EXTERN struct axis2_out_transport_info *AXIS2_CALL
axis2_msg_ctx_get_out_transport_info(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the HTTP Out Transport Info associated
* @param msg_ctx message context
* @param env pointer to environment struct
* @param out_transport_info reference to HTTP Out
* Transport Info associated
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_out_transport_info(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
struct axis2_out_transport_info *out_transport_info);
/**
* Resets the HTTP Out Transport Info associated
* @param msg_ctx message context
* @param env pointer to environment struct
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_reset_out_transport_info(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Retrieves Transport Headers.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return Transport Headers associated.
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_msg_ctx_get_transport_headers(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Retrieves Transport Headers, and removes them
* from the message context
* @param msg_ctx message context
* @param env pointer to environment struct
* @return Transport Headers associated.
*/
AXIS2_EXTERN axutil_hash_t *AXIS2_CALL
axis2_msg_ctx_extract_transport_headers(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the Transport Headers
* @param msg_ctx message context
* @param env pointer to environment struct
* @param transport_headers a Hash containing the
* Transport Headers
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_transport_headers(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_hash_t * transport_headers);
/**
* Retrieves HTTP Accept-Charset records.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return HTTP Accept-Charset records associated.
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_get_http_accept_charset_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Retrieves HTTP Accept-Charset records, and removes them
* from the message context
* @param msg_ctx message context
* @param env pointer to environment struct
* @return HTTP Accept-Charset records associated.
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_extract_http_accept_charset_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the HTTP Accept-Charset records
* @param msg_ctx message context
* @param env pointer to environment struct
* @param accept_charset_record_list an Array List containing the
* HTTP Accept-Charset records
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_http_accept_charset_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_array_list_t * accept_charset_record_list);
/**
* Retrieves HTTP Accept-Language records.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return HTTP Accept-Language records associated.
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_get_http_accept_language_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Retrieves HTTP Accept-Language records, and removes them
* from the message context
* @param msg_ctx message context
* @param env pointer to environment struct
* @return HTTP Accept-Language records associated.
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_extract_http_accept_language_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the HTTP Accept-Language records
* @param msg_ctx message context
* @param env pointer to environment struct
* @param accept_language_record_list an Array List containing the
* HTTP Accept-Language records
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_http_accept_language_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_array_list_t * accept_language_record_list);
/**
* Gets the Content Language used
* @param msg_ctx message context
* @param env pointer to environment struct
* @return Content Language string
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_content_language(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the Content Language used
* @param msg_ctx message context
* @param env pointer to environment struct
* @param str Content Language string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_content_language(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_char_t * str);
/**
* Retrieves HTTP Accept records.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return HTTP Accept records associated.
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_get_http_accept_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Retrieves HTTP Accept records, and removes them
* from the message context
* @param msg_ctx message context
* @param env pointer to environment struct
* @return HTTP Accept records associated.
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_extract_http_accept_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the HTTP Accept records
* @param msg_ctx message context
* @param env pointer to environment struct
* @param accept_record_list an Array List containing the
* HTTP Accept records
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_http_accept_record_list(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_array_list_t * accept_record_list);
/**
* Gets the transfer encoding used
* @param msg_ctx message context
* @param env pointer to environment struct
* @return Transfer encoding string
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_transfer_encoding(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the transfer encoding used
* @param msg_ctx message context
* @param env pointer to environment struct
* @param str Transfer encoding string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_transfer_encoding(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_char_t * str);
/**
* Gets the Transport URL
* @param msg_ctx message context
* @param env pointer to environment struct
* @return Transport URL string
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_transport_url(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the Transport URL
* @param msg_ctx message context
* @param env pointer to environment struct
* @param str Transport URL string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_transport_url(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axis2_char_t * str);
/**
* Gets whether there was no content in the response.
* This will cater for a situation where the invoke
* method in a service returns NULL when no fault has
* occured.
* @param msg_ctx message context
* @param env pointer to environment struct
* @return returns AXIS2_TRUE if there was no content
* occured or AXIS2_FALSE otherwise
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_no_content(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets that there was no content in the response.
* @param msg_ctx message context
* @param env pointer to environment struct
* @param no_content expects AXIS2_TRUE if there was no
* content in the response or AXIS2_FALSE otherwise
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_no_content(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t no_content);
/**
* Gets whether an authentication failure occured
* @param msg_ctx message context
* @param env pointer to environment struct
* @return returns AXIS2_TRUE if an authentication failure
* occured or AXIS2_FALSE if not
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_auth_failed(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets whether an authentication failure occured
* @param msg_ctx message context
* @param env pointer to environment struct
* @param status expects AXIS2_TRUE if an authentication failure
* occured or AXIS2_FALSE if not
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_auth_failed(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t status);
/**
* Gets whether HTTP Authentication is required or
* whether Proxy Authentication is required
* @param msg_ctx message context
* @param env pointer to environment struct
* @return returns AXIS2_TRUE for HTTP Authentication
* and AXIS2_FALSE for Proxy Authentication
*/
AXIS2_EXTERN axis2_bool_t AXIS2_CALL
axis2_msg_ctx_get_required_auth_is_http(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets whether HTTP Authentication is required or
* whether Proxy Authentication is required
* @param msg_ctx message context
* @param env pointer to environment struct
* @param is_http use AXIS2_TRUE for HTTP Authentication
* and AXIS2_FALSE for Proxy Authentication
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_required_auth_is_http(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_bool_t is_http);
/**
* Sets the authentication type
* @param msg_ctx message context
* @param env pointer to environment struct
* @param auth_type Authentication type string
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_auth_type(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
const axis2_char_t * auth_type);
/**
* Gets the authentication type
* @param msg_ctx message context
* @param env pointer to environment struct
* @return Authentication type string
*/
AXIS2_EXTERN axis2_char_t *AXIS2_CALL
axis2_msg_ctx_get_auth_type(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Gets the Output Header list
* @param msg_ctx message context
* @param env pointer to environment struct
* @return Output Header list
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_get_http_output_headers(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Retrieves the Output Headers, and removes them
* from the message context
* @param msg_ctx message context
* @param env pointer to environment struct
* @return Output Header list
*/
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_extract_http_output_headers(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/**
* Sets the Output Header list
* @param msg_ctx message context
* @param env pointer to environment struct
* @param output_headers Output Header list
* @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_set_http_output_headers(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_array_list_t * output_headers);
AXIS2_EXTERN axutil_array_list_t *AXIS2_CALL
axis2_msg_ctx_get_mime_parts(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
AXIS2_EXTERN void AXIS2_CALL
axis2_msg_ctx_set_mime_parts(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env,
axutil_array_list_t *mime_parts);
/**
* Incrementing the msg_ctx ref count. This is necessary when
* prevent freeing msg_ctx through op_client when it is in use
* as in sandesha2.
* @param msg_ctx pointer to message context
* @param env pointer to environment struct
* @return AXIS2_TRUE if still in use, else AXIS2_FALSE
*/
AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_msg_ctx_increment_ref(
axis2_msg_ctx_t * msg_ctx,
const axutil_env_t * env);
/** @} */
#ifdef __cplusplus
}
#endif
#endif /* AXIS2_MSG_CTX_H */
|