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 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661
|
<pre>Internet Engineering Task Force (IETF) M. Barnes
Request for Comments: 6503 Polycom
Category: Standards Track C. Boulton
ISSN: 2070-1721 NS-Technologies
S. Romano
University of Napoli
H. Schulzrinne
Columbia University
March 2012
<span class="h1">Centralized Conferencing Manipulation Protocol</span>
Abstract
The Centralized Conferencing Manipulation Protocol (CCMP) allows a
Centralized Conferencing (XCON) system client to create, retrieve,
change, and delete objects that describe a centralized conference.
CCMP is a means to control basic and advanced conference features
such as conference state and capabilities, participants, relative
roles, and details. CCMP is a stateless, XML-based, client server
protocol that carries, in its request and response messages,
conference information in the form of XML documents and fragments
conforming to the centralized conferencing data model schema.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc6503">http://www.rfc-editor.org/info/rfc6503</a>.
<span class="grey">Barnes, et al. Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
Copyright Notice
Copyright (c) 2012 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-4">4</a>
<a href="#section-2">2</a>. Conventions and Terminology .....................................<a href="#page-5">5</a>
<a href="#section-3">3</a>. XCON Conference Control System Architecture .....................<a href="#page-5">5</a>
<a href="#section-3.1">3.1</a>. Conference Objects .........................................<a href="#page-7">7</a>
<a href="#section-3.2">3.2</a>. Conference Users ...........................................<a href="#page-7">7</a>
<a href="#section-4">4</a>. Protocol Overview ...............................................<a href="#page-8">8</a>
<a href="#section-4.1">4.1</a>. Protocol Operations ........................................<a href="#page-9">9</a>
<a href="#section-4.2">4.2</a>. Data Management ...........................................<a href="#page-10">10</a>
<a href="#section-4.3">4.3</a>. Data Model Compliance .....................................<a href="#page-11">11</a>
<a href="#section-4.4">4.4</a>. Implementation Approach ...................................<a href="#page-12">12</a>
<a href="#section-5">5</a>. CCMP Messages ..................................................<a href="#page-13">13</a>
<a href="#section-5.1">5.1</a>. CCMP Request Message Type .................................<a href="#page-13">13</a>
<a href="#section-5.2">5.2</a>. CCMP Response Message Type ................................<a href="#page-15">15</a>
<a href="#section-5.3">5.3</a>. Detailed Messages .........................................<a href="#page-17">17</a>
<a href="#section-5.3.1">5.3.1</a>. blueprintsRequest and blueprintsResponse ...........<a href="#page-20">20</a>
<a href="#section-5.3.2">5.3.2</a>. confsRequest and confsResponse .....................<a href="#page-22">22</a>
<a href="#section-5.3.3">5.3.3</a>. blueprintRequest and blueprintResponse .............<a href="#page-24">24</a>
<a href="#section-5.3.4">5.3.4</a>. confRequest and confResponse .......................<a href="#page-26">26</a>
<a href="#section-5.3.5">5.3.5</a>. usersRequest and usersResponse .....................<a href="#page-30">30</a>
<a href="#section-5.3.6">5.3.6</a>. userRequest and userResponse .......................<a href="#page-32">32</a>
<a href="#section-5.3.7">5.3.7</a>. sidebarsByValRequest and sidebarsByValResponse .....<a href="#page-37">37</a>
<a href="#section-5.3.8">5.3.8</a>. sidebarByValRequest and sidebarByValResponse .......<a href="#page-39">39</a>
<a href="#section-5.3.9">5.3.9</a>. sidebarsByRefRequest and sidebarsByRefResponse .....<a href="#page-42">42</a>
<a href="#section-5.3.10">5.3.10</a>. sidebarByRefRequest and sidebarByRefResponse ......<a href="#page-44">44</a>
<a href="#section-5.3.11">5.3.11</a>. extendedRequest and extendedResponse ..............<a href="#page-47">47</a>
<a href="#section-5.3.12">5.3.12</a>. optionsRequest and optionsResponse ................<a href="#page-49">49</a>
<a href="#section-5.4">5.4</a>. CCMP Response Codes .......................................<a href="#page-53">53</a>
<a href="#section-6">6</a>. A Complete Example of CCMP in Action ...........................<a href="#page-57">57</a>
<a href="#section-6.1">6.1</a>. Alice Retrieves the Available Blueprints ..................<a href="#page-58">58</a>
6.2. Alice Gets Detailed Information about a Specific
Blueprint .................................................<a href="#page-60">60</a>
<span class="grey">Barnes, et al. Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
6.3. Alice Creates a New Conference through a Cloning
Operation .................................................<a href="#page-62">62</a>
<a href="#section-6.4">6.4</a>. Alice Updates Conference Information ......................<a href="#page-65">65</a>
<a href="#section-6.5">6.5</a>. Alice Inserts a List of Users into the Conference Object ..66
<a href="#section-6.6">6.6</a>. Alice Joins the Conference ................................<a href="#page-68">68</a>
<a href="#section-6.7">6.7</a>. Alice Adds a New User to the Conference ...................<a href="#page-70">70</a>
<a href="#section-6.8">6.8</a>. Alice Asks for the CCMP Server Capabilities ...............<a href="#page-72">72</a>
<a href="#section-6.9">6.9</a>. Alice Makes Use of a CCMP Server Extension ................<a href="#page-75">75</a>
<a href="#section-7">7</a>. Locating a Conference Server ...................................<a href="#page-78">78</a>
<a href="#section-8">8</a>. Managing Notifications .........................................<a href="#page-79">79</a>
<a href="#section-9">9</a>. HTTP Transport .................................................<a href="#page-80">80</a>
<a href="#section-10">10</a>. Security Considerations .......................................<a href="#page-82">82</a>
10.1. Assuring That the Proper Conference Server Has
Been Contacted ...........................................<a href="#page-83">83</a>
<a href="#section-10.2">10.2</a>. User Authentication and Authorization ....................<a href="#page-84">84</a>
<a href="#section-10.3">10.3</a>. Security and Privacy of Identity .........................<a href="#page-85">85</a>
<a href="#section-10.4">10.4</a>. Mitigating DoS Attacks ...................................<a href="#page-86">86</a>
<a href="#section-11">11</a>. XML Schema ....................................................<a href="#page-87">87</a>
<a href="#section-12">12</a>. IANA Considerations ..........................................<a href="#page-105">105</a>
<a href="#section-12.1">12.1</a>. URN Sub-Namespace Registration ..........................<a href="#page-105">105</a>
<a href="#section-12.2">12.2</a>. XML Schema Registration .................................<a href="#page-106">106</a>
12.3. MIME Media Type Registration for
'application/ccmp+xml' ..................................<a href="#page-106">106</a>
<a href="#section-12.4">12.4</a>. DNS Registrations .......................................<a href="#page-107">107</a>
12.4.1. Registration of a Conference Server
Application Service Tag ..........................<a href="#page-108">108</a>
12.4.2. Registration of a Conference Server
Application Protocol Tag for CCMP ................<a href="#page-108">108</a>
<a href="#section-12.5">12.5</a>. CCMP Protocol Registry ..................................<a href="#page-108">108</a>
<a href="#section-12.5.1">12.5.1</a>. CCMP Message Types ...............................<a href="#page-109">109</a>
<a href="#section-12.5.2">12.5.2</a>. CCMP Response Codes ..............................<a href="#page-111">111</a>
<a href="#section-13">13</a>. Acknowledgments ..............................................<a href="#page-113">113</a>
<a href="#section-14">14</a>. References ...................................................<a href="#page-113">113</a>
<a href="#section-14.1">14.1</a>. Normative References ....................................<a href="#page-113">113</a>
<a href="#section-14.2">14.2</a>. Informative References ..................................<a href="#page-114">114</a>
<a href="#appendix-A">Appendix A</a>. Evaluation of Other Protocol Models and
Transports Considered for CCMP ......................<a href="#page-116">116</a>
<a href="#appendix-A.1">A.1</a>. Using SOAP for CCMP ......................................<a href="#page-117">117</a>
<a href="#appendix-A.2">A.2</a>. A RESTful Approach for CCMP ..............................<a href="#page-117">117</a>
<span class="grey">Barnes, et al. Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
"A Framework for Centralized Conferencing" [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>] (XCON framework)
defines a signaling-agnostic framework, naming conventions, and
logical entities required for building advanced conferencing systems.
The XCON framework introduces the conference object as a logical
representation of a conference instance, representing the current
state and capabilities of a conference.
The Centralized Conferencing Manipulation Protocol (CCMP) defined in
this document allows authenticated and authorized users to create,
manipulate, and delete conference objects. Operations on conferences
include adding and removing participants, changing their roles, as
well as adding and removing media streams and associated endpoints.
CCMP implements the client-server model within the XCON framework,
with the conferencing client and conference server acting as client
and server, respectively. CCMP uses HTTP [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>] as the protocol
to transfer requests and responses, which contain the domain-specific
XML-encoded data objects defined in [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>] "Conference Information
Data Model for Centralized Conferencing (XCON)".
<a href="#section-2">Section 2</a> clarifies the conventions and terminology used in the
document. <a href="#section-3">Section 3</a> provides an overview of the conference control
functionality of the XCON framework, together with a description of
the main targets CCMP deals with, namely conference objects and
conference users. A general description of the operations associated
with protocol messages is given in <a href="#section-4">Section 4</a> together with
implementation details. <a href="#section-5">Section 5</a> delves into the details of
specific CCMP messages. A complete, non-normative, example of the
operation of CCMP, describing a typical call flow associated with
conference creation and manipulation, is provided in <a href="#section-6">Section 6</a>. A
survey of the methods that can be used to locate a conference server
is provided in <a href="#section-7">Section 7</a>, and <a href="#section-8">Section 8</a> discusses potential
approaches to notifications management. CCMP transport over HTTP is
highlighted in <a href="#section-9">Section 9</a>. Security considerations are presented in
<a href="#section-10">Section 10</a>. Finally, <a href="#section-11">Section 11</a> provides the XML schema.
<span class="grey">Barnes, et al. Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Conventions and Terminology</span>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
[<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
In addition to the terms defined in "A Framework for Centralized
Conferencing" [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>], this document uses the following terms and
acronyms:
XCON-aware client: An XCON conferencing system client that is able
to issue CCMP requests.
First-Party Request: A request issued by the client to manipulate
its own conferencing data.
Third-Party Request: A request issued by a client to manipulate the
conference data of another client.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. XCON Conference Control System Architecture</span>
CCMP supports the XCON framework. Figure 1 depicts a subset of the
"Conferencing System Logical Decomposition" architecture from the
XCON framework document. It illustrates the role that CCMP assumes
within the overall centralized architecture.
<span class="grey">Barnes, et al. Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
........................................................
. Conferencing System .
. .
. +---------------------------------------+ .
. | C O N F E R E N C E O B J E C T | .
. +-+-------------------------------------+ | .
. | C O N F E R E N C E O B J E C T | | .
. +-+-------------------------------------+ | | .
. | C O N F E R E N C E O B J E C T | | | .
. | | |-+ .
. | |-+ .
. +---------------------------------------+ .
. ^ .
. | .
. v .
. +-------------------+ .
. | Conference Control| .
. | Server | .
. +-------------------+ .
. ^ .
.........................|..............................
|
|Centralized
|Conferencing
|Manipulation
|Protocol
|
.........................|..............................
. V .
. +----------------+ .
. | Conference | .
. | Control | .
. | Client | .
. +----------------+ .
. .
. Conferencing Client .
........................................................
Figure 1: Conferencing Client Interaction
The Centralized Conferencing Manipulation Protocol (CCMP) allows the
conference control client (conferencing client) to interface with the
conference object maintained by the conferencing system, as depicted
in Figure 1. Note that additional functionality of the conferencing
client and conferencing system is discussed in the XCON framework and
related documents.
<span class="grey">Barnes, et al. Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
This section provides details of the identifiers REQUIRED to address
and manage the clients associated with a conferencing system using
CCMP.
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Conference Objects</span>
Conference objects feature a simple dynamic inheritance-and-override
mechanism. Conference objects are linked into a tree known as a
"cloning tree" (see <a href="./rfc5239#section-7.1">Section 7.1 of [RFC5239]</a>). Each cloning tree
node inherits attributes from its parent node. The roots of these
inheritance trees are conference templates also known as
"blueprints". Nodes in the inheritance tree can be active
conferences or simply descriptions that do not currently have any
resources associated with them (i.e., conference reservations). An
object can mark certain of its properties as unalterable, so that
they cannot be overridden. Per the framework, a client may specify a
parent object (a conference or blueprint) from which to inherit
values when a conference is created using the conference control
protocol.
Conference objects are uniquely identified by the XCON-URI within the
scope of the conferencing system. The XCON-URI is introduced in the
XCON framework and defined in the XCON common data model.
Conference objects are comprehensively represented through XML
documents compliant with the XML schema defined in the XCON data
model [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>]. The root element of such documents, called
<conference-info>, is of type "conference-type". It encompasses
other XML elements describing different conference features and users
as well. Using CCMP, conferencing clients can use these XML
structures to express their preferences in creating or updating a
conference. A conference server can convey conference information
back to the clients using the XML elements.
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Conference Users</span>
Each conference can have zero or more users. All conference
participants are users, but some users may have only administrative
functions and do not contribute or receive media. Users are added
one user at a time to simplify error reporting. When a conference is
cloned from a parent object, users are inherited as well, so that it
is easy to set up a conference that has the same set of participants
or a common administrator. The conference server creates individual
users, assigning them a unique conference user identifier (XCON-
USERID). The XCON-USERID as identifier of each conferencing system
client is introduced in the XCON framework and defined in the XCON
<span class="grey">Barnes, et al. Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
common data model. Each CCMP request, with an exception pointed out
in <a href="#section-5.3.6">Section 5.3.6</a> representing the case of a user at his first
entrance in the system as a conference participant, must carry the
XCON-USERID of the requestor in the proper <confUserID> parameter.
The XCON-USERID acts as a pointer to the user's profile as a
conference actor, e.g., her signaling URI and other XCON protocol
URIs in general, her role (moderator, participant, observer, etc.),
her display text, her joining information, and so on. A variety of
elements defined in the common <conference-info> element as specified
in the XCON data model are used to describe the users related to a
conference including the <users> element, as well as each <user>
element included within it. For example, it is possible to determine
how a specific user expects and is allowed to join a conference by
looking at the <allowed-users-list> in <users>: each <target> element
involved in such a list represents a user and shows a 'method'
attribute defining how the user is expected to join the conference,
i.e., "dial-in" for users that are allowed to dial, "dial-out" for
users that the conference focus will be trying to reach (with
"dial-in" being the default mode). If the conference is currently
active, dial-out users are contacted immediately; otherwise, they are
contacted at the start of the conference. CCMP, acting as the
conference control protocol, provides a means to manipulate these and
other kinds of user-related features.
As a consequence of an explicit user registration to a specific XCON
conferencing system, conferencing clients are usually provided
(besides the XCON-USERID) with log-in credentials (i.e., username and
password). Such credentials can be used to authenticate the XCON-
aware client issuing CCMP requests. Thus, both username and password
should be carried in a CCMP request as part of the "subject"
parameter whenever a registered conferencing client wishes to contact
a CCMP server. CCMP does not maintain a user's subscriptions at the
conference server; hence, it does not provide any specific mechanism
allowing clients to register their conferencing accounts. The
"subject" parameter is just used for carrying authentication data
associated with pre-registered clients, with the specific
registration modality outside the scope of this document.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Protocol Overview</span>
CCMP is a client-server, XML-based protocol for user creation,
retrieval, modification, and deletion of conference objects. CCMP is
a stateless protocol, such that implementations can safely handle
transactions independently from each other. CCMP messages are XML
documents or XML document fragments compliant with the XCON data
model representation [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>].
<span class="grey">Barnes, et al. Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<a href="#section-4.1">Section 4.1</a> specifies the basic operations that can create, retrieve,
modify, and delete conference-related information in a centralized
conference. The core set of objects manipulated by CCMP includes
conference blueprints, the conference object, users, and sidebars.
Each operation in the protocol model, as summarized in <a href="#section-4.1">Section 4.1</a>,
is atomic and either succeeds or fails as a whole. The conference
server MUST ensure that the operations are atomic in that the
operation invoked by a specific conferencing client completes prior
to another client's operation on the same conference object. While
the details for this data locking functionality are out of scope for
the CCMP specification and are implementation specific for a
conference server, some core functionality for ensuring the integrity
of the data is provided by CCMP as described in <a href="#section-4.2">Section 4.2</a>.
While the XML documents that are carried in CCMP need to comply with
the XCON data model, there are situations in which the values for
mandatory elements are unknown by the client. The mechanism for
ensuring compliance with the data model in these cases is described
in <a href="#section-4.3">Section 4.3</a>.
CCMP is completely independent from underlying protocols, which means
that there can be different ways to carry CCMP messages from a
conferencing client to a conference server. The specification
describes the use of HTTP as a transport solution, including CCMP
requests in HTTP POST messages and CCMP responses in HTTP 200 OK
replies. This implementation approach is further described in
<a href="#section-4.4">Section 4.4</a>.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Protocol Operations</span>
The main operations provided by CCMP belong in four general
categories:
create: for the creation of a conference object, a conference user,
a sidebar, or a blueprint.
retrieve: to get information about the current state of either a
conference object (be it an actual conference, a blueprint, or a
sidebar) or a conference user. A retrieve operation can also be
used to obtain the XCON-URIs of the current conferences (active or
registered) handled by the conferencing server and/or the
available blueprints.
update: to modify the current features of a specified conference or
conference user.
<span class="grey">Barnes, et al. Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
delete: to remove from the system a conference object or a
conference user.
Thus, the main targets of CCMP operations are as follows:
o conference objects associated with either active or registered
conferences,
o conference objects associated with blueprints,
o conference objects associated with sidebars, both embedded in the
main conference (i.e., <entry> elements in <sidebars-by-value>)
and external to it (i.e., whose XCON-URIs are included in the
<entry> elements of <sidebars-by-ref>),
o <user> elements associated with conference users, and
o the list of XCON-URIs related to conferences and blueprints
available at the server, for which only retrieval operations are
allowed.
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Data Management</span>
The XCON framework defines a model whereby the conference server
centralizes and maintains the conference information. Since multiple
clients can modify the same conference objects, a conferencing client
might not have the latest version of a specific conference object
when it initiates operations. To determine whether the client has
the most up-to-date conference information, CCMP defines a versioning
approach. Each conference object is associated with a version
number. All CCMP response messages containing a conference document
(or a fragment thereof) MUST contain a <version> parameter. When a
client sends an update message to the server, which includes
modifications to a conference object, if the modifications are all
successfully applied, the server MUST return a response, with a
<response-code> of "200", containing the version number of the
modified object. With this approach, a client working on version "X"
of a conference object that receives a response, with a <response-
code> of "200", with a version number that is "X+1" can be certain
that the version it manipulated was the most up to date. However, if
the response contains a version that is at least "X+2", the client
knows that the object modified by the server was more up to date than
the object the client was manipulating. In order to ensure that the
client always has the latest version of the modified object, the
client can send a request to the conference server to retrieve the
conference object. The client can then update the relevant data
elements in the conference object prior to invoking a specific
operation. Note that a client subscribed to the XCON event package
<span class="grey">Barnes, et al. Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
[<a id="ref-RFC6502">RFC6502</a>] notifications about conference object modifications, will
receive the most up-to-date version of that object upon receipt of a
notification.
The "version" parameter is OPTIONAL for requests, since it is not
needed by the server: as long as the required modifications can be
applied to the target conference object without conflicts, the server
does not care whether the client has stored an up-to-date view of the
information. In addition, to ensure the integrity of the data, the
conference server first checks all the parameters, before making any
changes to the internal representation of the conference object. For
example, it would be undesirable to change the <subject> of the
conference, but then detect an invalid URI in one of the <service-
uris> and abort the remaining updates.
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. Data Model Compliance</span>
The XCON data model [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>] identifies some elements and attributes
as mandatory. Since the XML documents carried in the body of the
CCMP requests and responses need to be compliant with the XCON data
model, there can be a problem in cases of client-initiated
operations, such as the initial creation of conference objects and
cases whereby a client updates a conference object adding new
elements, such as a new user. In such cases, not all of the
mandatory data can be known in advance by the client issuing a CCMP
request. As an example, a client cannot know, at the time it issues
a conference creation request, the XCON-URI that the server will
assign to the yet-to-be-created conference; hence, it is not able to
populate the mandatory 'entity' attribute of the conference document
contained in the request with the correct value. To solve this
issue, the CCMP client fills all mandatory data model fields, for
which no value is available at the time the request is constructed,
with placeholder values in the form of a wildcard string,
AUTO_GENERATE_X (all uppercase), with X being a unique numeric index
for each data model field for which the value is unknown. This form
of wildcard string is chosen, rather than the use of random unique
strings (e.g., FOO_BAR_LA) or non-numeric values for X, to simplify
processing at the server. The values of AUTO_GENERATE_X are only
unique within the context of the specific request. The placeholder
AUTO_GENERATE_X values MUST be within the value part of an attribute
or element (e.g., <userinfo
entity="xcon-userid:AUTO_GENERATE_1@example.com">).
<span class="grey">Barnes, et al. Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
When the server receives requests containing values in the form of
AUTO_GENERATE_X, the server does the following:
(a) Generates the proper identifier for each instance of
AUTO_GENERATE_X in the document. If an instance of
AUTO_GENERATE_X is not within the value part of the attribute/
element, the server MUST send a <response-code> of "400 Bad
Request". In cases where AUTO_GENERATE_X appears only in the
user part of a URI (i.e., in the case of XCON-USERIDs or XCON-
URIs), the server needs to ensure that the domain name is one
that is within the server's domain of responsibility. If the
domain name is not within the server's domain of responsibility,
then the server MUST send a <response-code> of "427 Invalid
Domain Name". The server MUST replace each instance of a
specific wildcard field (e.g., AUTO_GENERATE_1) with the same
identifier. The identifiers MUST be unique for each instance of
AUTO_GENERATE_X within the same XML document received in the
request; for example, the value that replaces AUTO_GENERATE_1
MUST NOT be the same as the value that replaces AUTO_GENERATE_2.
Note that the values that replace the instances of
AUTO_GENERATE_X are not the same across all conference objects;
for example, different values can be used to replace
AUTO_GENERATE_1 in two different documents.
(b) Sends a response in which all values of AUTO_GENERATE_X received
in the request have been replaced by the newly created one(s).
With this approach, compatibility with the data model requirements is
maintained, while allowing for client-initiated manipulation of
conference objects at the server's side. Note that the use of this
mechanism could be avoided in come cases by using multiple
operations, such as creating a new user and then adding the new user
to an existing conference. However, the AUTO_GENERATE_X mechanism
allows a single operation to be used to effect the same change on the
conference object.
<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. Implementation Approach</span>
CCMP is implemented using HTTP, placing the CCMP request messages
into the body of an HTTP POST operation and placing the CCMP
responses into the body of the HTTP response messages. A non-
exhaustive summary of the other approaches that were considered and
the perceived advantages of the HTTP solution described in this
document are provided in <a href="#appendix-A">Appendix A</a>.
Most CCMP commands can pend indefinitely, thus increasing the
potential that pending requests can continue to increase when a
server is receiving more requests than it can process within a
<span class="grey">Barnes, et al. Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
specific time period. In this case, a server SHOULD return a
<response-code> of "510" to the pending requests. In addition, to
mitigate the situation, clients MUST NOT wait indefinitely for a
response and MUST implement a timer such that when it expires, the
client MUST close the connection. Thirty seconds is RECOMMENDED as
the default value for this timer. Sixty seconds is considered a
reasonable upper range. Note that there may be cases where a
response message is lost and a request has been successful (e.g.,
user added to a conference); yet, the client will be unaware and
close the connection. However, as described in <a href="#section-4.2">Section 4.2</a>, there is
a versioning mechanism for the conference objects; thus, there is a
mechanism for the conference object stored by the client to be
brought up to date.
CCMP messages have a MIME-type of "application/ccmp+xml", which
appears inside the Content-Type and Accept header fields of HTTP
requests and responses. The XML documents in the CCMP messages MUST
be encoded in UTF-8. This specification follows the recommendations
and conventions described in [<a href="./rfc3023" title=""XML Media Types"">RFC3023</a>], including the naming
convention of the type ('+xml' suffix) and the usage of the 'charset'
parameter. The 'charset' parameter MUST be included with the XML
document. <a href="#section-9">Section 9</a> provides the complete requirements for an HTTP
implementation to support CCMP.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. CCMP Messages</span>
CCMP messages are either requests or responses. The general CCMP
request message is defined in <a href="#section-5.1">Section 5.1</a>. The general CCMP response
message is defined in <a href="#section-5.2">Section 5.2</a>. The details of the specific
message type that is carried in the CCMP request and response
messages are described in <a href="#section-5.3">Section 5.3</a>. CCMP response codes are
listed in <a href="#section-5.4">Section 5.4</a>.
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. CCMP Request Message Type</span>
A CCMP request message is comprised of the following parameters:
subject: An OPTIONAL parameter containing the username and password
of the client registered at the conferencing system. Each user
who subscribes to the conferencing system is assumed to be
equipped with those credentials and SHOULD enclose them in each
CCMP request she issues. These fields can be used to control that
the user sending the CCMP request has the authority to perform the
requested operation. The same fields can also be used for other
authorization and authentication procedures.
<span class="grey">Barnes, et al. Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
confUserID: An OPTIONAL parameter containing the XCON-USERID of the
client. The XCON-USERID is used to identify any conferencing
client within the context of the conferencing system and it is
assigned by the conference server for each conferencing client who
interacts with it. The <confUserID> parameter is REQUIRED in the
CCMP request and response messages with the exception of the case
of a user who has no XCON-USERID and who wants to enter, via CCMP,
a conference whose identifier is known. In such case, a side
effect of the request is that the user is provided with an
appropriate XCON-USERID. An example of the aforementioned case
will be provided in <a href="#section-5.3.6">Section 5.3.6</a>.
confObjID: An OPTIONAL parameter containing the XCON-URI of the
target conference object.
operation: An OPTIONAL parameter refining the type of specialized
request message. The <operation> parameter is REQUIRED in all
requests except for the blueprintsRequest and confsRequest
specialized messages.
conference-password: The parameter is OPTIONAL except that it MUST
be inserted in all requests whose target conference object is
password-protected i.e., contains the <conference-password>
element in [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>]). A CCMP <response-code> of "423" MUST be
returned if a conference-password is not included in the request
when required.
specialized request message: This is a specialization of the generic
request message (e.g., blueprintsRequest), containing parameters
that are dependent on the specific request sent to the server. A
specialized request message MUST be included in the CCMP request
message. The details for the specialized messages and associated
parameters are provided in <a href="#section-5.3">Section 5.3</a>.
<span class="grey">Barnes, et al. Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- Definition of CCMP Request -->
<xs:element name="ccmpRequest" type="ccmp-request-type" />
<!-- Definition of ccmp-request-type-->
<xs:complexType name="ccmp-request-type">
<xs:sequence>
<xs:element name="ccmpRequest"
type="ccmp-request-message-type" />
</xs:sequence>
</xs:complexType>
<!-- Definition of ccmp-request-message-type -->
<xs:complexType abstract="true"
name="ccmp-request-message-type">
<xs:sequence>
<xs:element name="subject" type="subject-type"
minOccurs="0" maxOccurs="1" />
<xs:element name="confUserID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="confObjID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="operation" type="operationType"
minOccurs="0" maxOccurs="1" />
<xs:element name="conference-password" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 2: Structure of CCMP Request Messages
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. CCMP Response Message Type</span>
A CCMP response message is comprised of the following parameters:
confUserID: A REQUIRED parameter in CCMP response messages
containing the XCON-USERID of the conferencing client that issued
the CCMP request message.
confObjID: An OPTIONAL parameter containing the XCON-URI of the
target conference object.
<span class="grey">Barnes, et al. Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
operation: An OPTIONAL parameter for CCMP response messages. This
parameter is REQUIRED in all responses except for the
"blueprintsResponse" and "confsResponse" specialized messages.
response-code: A REQUIRED parameter containing the response code
associated with the request. The response code MUST be chosen
from the codes listed in <a href="#section-5.4">Section 5.4</a>.
response-string: An OPTIONAL reason string associated with the
response. In case of an error, in particular, this string can be
used to provide the client with detailed information about the
error itself.
version: An OPTIONAL parameter reflecting the current version number
of the conference object referred by the confObjID. This number
is contained in the 'version' attribute of the <conference-info>
element related to that conference. This parameter is REQUIRED in
CCMP response messages and SHOULD NOT be included in CCMP request
messages.
specialized response message: This is specialization of the generic
response message, containing parameters that are dependent on the
specific request sent to the server (e.g., "blueprintsResponse").
A specialized response message SHOULD be included in the CCMP
response message, except in an error situation where the CCMP
request message did not contain a valid specialized message. In
this case, the conference server MUST return a <response-code> of
"400". The details for the specialized messages and associated
parameters are provided in <a href="#section-5.3">Section 5.3</a>.
<span class="grey">Barnes, et al. Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- Definition of CCMP Response -->
<xs:element name="ccmpResponse" type="ccmp-response-type" />
<!-- Definition of ccmp-response-type -->
<xs:complexType name="ccmp-response-type">
<xs:sequence>
<xs:element name="ccmpResponse"
type="ccmp-response-message-type" />
</xs:sequence>
</xs:complexType>
<!-- Definition of ccmp-response-message-type -->
<xs:complexType abstract="true"
name="ccmp-response-message-type">
<xs:sequence>
<xs:element name="confUserID" type="xs:string"
minOccurs="1" maxOccurs="1" />
<xs:element name="confObjID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="operation" minOccurs="0"
maxOccurs="1" />
<xs:element name="response-code"
type="response-codeType"
minOccurs="1" maxOccurs="1" />
<xs:element name="response-string" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="version" type="xs:positiveInteger"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 3: Structure of CCMP Response Message
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. Detailed Messages</span>
Based on the request and response message structures described in
Sections <a href="#section-5.1">5.1</a> and <a href="#section-5.2">5.2</a>, the following summarizes the specialized CCMP
request and response types described in this document:
1. blueprintsRequest/blueprintsResponse
2. confsRequest/confsResponse
<span class="grey">Barnes, et al. Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
3. blueprintRequest/blueprintResponse
4. confRequest/confResponse
5. usersRequest/usersResponse
6. userRequest/userResponse
7. sidebarsByValRequest/sidebarsByValResponse
8. sidebarsByRefRequest/sidebarsByRefResponse
9. sidebarByValRequest/sidebarByValResponse
10. sidebarByRefRequest/sidebarByRefResponse
11. extendedRequest/extendedResponse
12. optionsRequest/optionsResponse
These CCMP request/response pairs use the fundamental CCMP operations
as defined in <a href="#section-4.1">Section 4.1</a> to manipulate the conference data. These
request/response pairs are included in an IANA registry as defined in
<a href="#section-12.5">Section 12.5</a>. Table 1 summarizes the remaining CCMP operations and
corresponding actions that are valid for a specific CCMP request
type, noting that neither the blueprintsRequest/blueprintsResponse
nor confsRequest/confsResponse require an <operation> parameter. An
entity MUST support the response message for each of the request
messages that is supported. The corresponding response message MUST
contain the same <operation> parameter. Note that some entries are
labeled "N/A", indicating that the operation is invalid for that
request type. In the case of an "N/A*" label, the operation MAY be
allowed for specific privileged users or system administrators but is
not part of the functionality included in this document.
<span class="grey">Barnes, et al. Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
+---------------+------------+------------+------------+------------+
| Operation | Retrieve | Create | Update | Delete |
| ------------- | | | | |
| Request Type | | | | |
+---------------+------------+------------+------------+------------+
| blueprints | Get list | N/A | N/A | N/A |
| Request | of | | | |
| | blueprints | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| blueprint | Get | N/A* | N/A* | N/A* |
| Request | blueprint | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| confsRequest | Get list | N/A | N/A | N/A |
| | of confs | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| confRequest | Get | Create | Change | Delete |
| | conference | conference | conference | conference |
| | object | object | object | object |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| usersRequest | Get | N/A(**) | Change | N/A(**) |
| | <users> | | <users> | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| userRequest | Get | Add a | Change | Delete |
| | specified | <user> to | specified | specified |
| | <user> | a conf | <user> | <user> |
| | | (***) | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| sidebarsByVal | Get | N/A | N/A | N/A |
| Request | <sidebars- | | | |
| | by-val> | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| sidebarsByRef | Get | N/A | N/A | N/A |
| Request | <sidebars- | | | |
| | by-ref> | | | |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| sidebarByValR | Get | Create | Change | Delete |
| equest | sidebar- | sidebar- | sidebar- | sidebar- |
| | by-val | by-val | by-val | by-val |
| ------------- | ---------- | ---------- | ---------- | ---------- |
| sidebarByRefR | Get | Create | Change | Delete |
| equest | sidebar- | sidebar- | sidebar- | sidebar- |
| | by-ref | by-ref | by-ref | by-ref |
+---------------+------------+------------+------------+------------+
Table 1: Request Type Operation-Specific Processing
<span class="grey">Barnes, et al. Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
(**): These operations are not allowed for a usersRequest message,
since the <users> section, which is the target element of such a
request, is created and removed in conjunction with the creation and
deletion, respectively, of the associated conference document. Thus,
"update" and "retrieve" are the only semantically correct operations
for such message.
(***): This operation can involve the creation of an XCON-USERID, if
the sender does not add it in the <confUserID> parameter and/or if
the entity field of the <userInfo> parameter is void.
Additional parameters included in the specialized CCMP request and
response messages are detailed in the subsequent sections. If a
required parameter is not included in a request, the conference
server MUST return a <response-code> of "400" per <a href="#section-5.4">Section 5.4</a>.
<span class="h4"><a class="selflink" id="section-5.3.1" href="#section-5.3.1">5.3.1</a>. blueprintsRequest and blueprintsResponse</span>
A blueprintsRequest (Figure 4) message is sent to request the list of
XCON-URIs associated with the available blueprints from the
conference server. These XCON-URIs can be subsequently used by the
client to access detailed information about a specified blueprint
with a specific blueprintRequest message per <a href="#section-5.3.3">Section 5.3.3</a>.
The <confUserID> parameter MUST be included in every
blueprintsRequest/Response message and reflect the XCON-USERID of the
conferencing client issuing the request. Since a blueprintsRequest
message is not targeted to a specific conference instance and is a
"retrieve-only" request, the <confObjID> and <operation> parameters
MUST NOT be included in the blueprintsRequest/Response messages.
In order to obtain a specific subset of the available blueprints, a
client may specify a selection filter providing an appropriate xpath
query in the OPTIONAL "xpathFilter" parameter of the request. The
information in the blueprints typically represents general
capabilities and characteristics. For example, to select blueprints
having both audio and video stream support, a possible xpathFilter
value could be: "/conference-info[conference-description/
available-media/entry/type='audio' and conference-description/
available-media/entry/type='video']". A conference server SHOULD NOT
provide any sensitive information (e.g., passwords) in the
blueprints.
The associated blueprintsResponse message SHOULD contain, as shown in
Figure 4, a "blueprintsInfo" parameter containing the above mentioned
XCON-URI list.
<span class="grey">Barnes, et al. Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- blueprintsRequest -->
<xs:complexType name="ccmp-blueprints-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="blueprintsRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintsRequestType -->
<xs:element name="blueprintsRequest" type="blueprintsRequestType"/>
<xs:complexType name="blueprintsRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- blueprintsResponse -->
<xs:complexType name="ccmp-blueprints-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="blueprintsResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- blueprintsResponseType -->
<xs:element name="blueprintsResponse" type="blueprintsResponseType"/>
<xs:complexType name="blueprintsResponseType">
<xs:sequence>
<xs:element name="blueprintsInfo"
type="info:uris-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 4: Structure of the blueprintsRequest and
blueprintsResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.2" href="#section-5.3.2">5.3.2</a>. confsRequest and confsResponse</span>
A confsRequest message is used to retrieve, from the server, the list
of XCON-URIs associated with active and registered conferences
currently handled by the conferencing system. The <confUserID>
parameter MUST be included in every confsRequest/Response message and
reflect the XCON-USERID of the conferencing client issuing the
request. The <confObjID> parameter MUST NOT be included in the
confsRequest message. The confsRequest message is of a retrieve-only
type, since the sole purpose is to collect information available at
the conference server. Thus, an <operation> parameter MUST NOT be
included in a confsRequest message. In order to retrieve a specific
subset of the available conferences, a client may specify a selection
filter providing an appropriate xpath query in the OPTIONAL
"xpathFilter" parameter of the request. For example, to select only
the registered conferences, a possible xpathFilter value could be "/
conference-info[conference-description/conference-state/
active='false']". The associated confsResponse message SHOULD
contain the list of XCON-URIs in the "confsInfo" parameter. A user,
upon receipt of the response message, can interact with the available
conference objects through further CCMP messages.
<span class="grey">Barnes, et al. Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- confsRequest -->
<xs:complexType name="ccmp-confs-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="confsRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confsRequestType -->
<xs:element name="confsRequest" type="confsRequestType" />
<xs:complexType name="confsRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confsResponse -->
<xs:complexType name="ccmp-confs-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="confsResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- confsResponseType -->
<xs:element name="confsResponse" type="confsResponseType"/>
<xs:complexType name="confsResponseType">
<xs:sequence>
<xs:element name="confsInfo" type="info:uris-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 5: Structure of the confsRequest and confsResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.3" href="#section-5.3.3">5.3.3</a>. blueprintRequest and blueprintResponse</span>
Through a blueprintRequest, a client can manipulate the conference
object associated with a specified blueprint. Along with the
<confUserID> parameter, the request MUST include the <confObjID> and
the <operation> parameters. Again, the <confUserID> parameter MUST
be included in every blueprintRequest/Response message and reflect
the XCON-USERID of the conferencing client issuing the request. The
<confObjID> parameter MUST contain the XCON-URI of the blueprint,
which might have been previously retrieved through a
blueprintsRequest message.
The blueprintRequest message SHOULD NOT contain an <operation>
parameter with a value other than "retrieve". An <operation>
parameter with a value of "create", "update", or "delete" SHOULD NOT
be included in a blueprintRequest message except in the case of
privileged users (e.g., the conference server administration staff),
who might authenticate themselves by the mean of the "subject"
request parameter.
A blueprintRequest/retrieve carrying a <confObjID> parameter whose
value is not associated with one of the available system's
blueprints, will generate, on the server's side, a blueprintResponse
message containing a <response-code> of "404". This also holds for
the case in which the mentioned <confObjID> parameter value is
related to an existing conference document stored at the server, but
associated with an actual conference (be it active or registered) or
with a sidebar rather than a blueprint.
<span class="grey">Barnes, et al. Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
For a <response-code> of "200" in a "retrieve" operation, the
<blueprintInfo> parameter MUST be included in the blueprintResponse
message. The <blueprintInfo> parameter contains the conference
document associated with the blueprint as identified by the
<confObjID> parameter specified in the blueprintRequest.
<!-- blueprintRequest -->
<xs:complexType name="ccmp-blueprint-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="blueprintRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintRequestType -->
<xs:element name="blueprintRequest" type="blueprintRequestType" />
<xs:complexType name="blueprintRequestType">
<xs:sequence>
<xs:element name="blueprintInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- blueprintResponse -->
<xs:complexType name="ccmp-blueprint-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="blueprintResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- blueprintResponseType -->
<xs:element name="blueprintResponse" type="blueprintResponseType"/>
<xs:complexType name="blueprintResponseType">
<xs:sequence>
<xs:element name="blueprintInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded">
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 6: Structure of the blueprintRequest and
blueprintResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.4" href="#section-5.3.4">5.3.4</a>. confRequest and confResponse</span>
With a confRequest message, CCMP clients can manipulate conference
objects associated with either active or registered conferences. The
<confUserID> parameter MUST be included in every confRequest/Response
message and reflect the XCON-USERID of the conferencing client
issuing the request. confRequest and confResponse messages MUST also
include an <operation> parameter. ConfResponse messages MUST return
to the requestor a <response-code> and MAY contain a <response-
string> explaining it. Depending upon the type of operation, a
<confObjID> and <confInfo> parameter MAY be included in the
confRequest and response. For each type of operation, the text below
describes whether the <confObjID> and <confInfo> parameters need to
be included in the confRequest and confResponse messages.
The creation case deserves care. To create a new conference through
a confRequest message, two approaches can be considered:
1. Creation through explicit cloning: the <confObjID> parameter MUST
contain the XCON-URI of the blueprint or of the conference to be
cloned, while the <confInfo> parameter MUST NOT be included in
the confRequest. Note that cloning of an active conference is
only done in the case of a sidebar operation per the XCON
framework and as described in <a href="#section-5.3.8">Section 5.3.8</a>.
2. Creation through implicit cloning (also known as "direct
creation"): the <confObjID> parameter MUST NOT be included in the
request and the CCMP client can describe the desired conference
to be created using the <confInfo> parameter. If no <confInfo>
parameter is provided in the request, the new conference will be
created as a clone of the system default blueprint.
<span class="grey">Barnes, et al. Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
In both creation cases, the confResponse, for a successful completion
of a "create" operation, contains a <response-code> of "200" and MUST
contain the XCON-URI of the newly created conference in the
<confObjID> parameter, in order to allow the conferencing client to
manipulate that conference through following CCMP requests. In
addition, the <confInfo> parameter containing the conference document
created MAY be included, at the discretion of the conferencing system
implementation, along with the REQUIRED <version> parameter
initialized at "1", since, at creation time, the conference object is
at its first version.
In the case of a confRequest with an <operation> parameter of
"retrieve", the <confObjID> parameter representing the XCON-URI of
the target conference MUST be included and the <confInfo> parameter
MUST NOT be included in the request. The conference server MUST
ignore any <confInfo> parameter that is received in a confRequest
"retrieve" operation. If the confResponse for the retrieve operation
contains a <response-code> of "200", the <confInfo> parameter MUST be
included in the response. The <confInfo> parameter MUST contain the
entire conference document describing the target conference object in
its current state. The current state of the retrieved conference
object MUST also be reported in the proper "version" response
parameter.
In case of a confRequest with an <operation> parameter of "update",
the <confInfo> and <confObjID> parameters MUST be included in the
request. The <confInfo> represents an object of type
"conference-type" containing all the changes to be applied to the
conference whose identifier has the same value as the <confObjID>
parameter. Note that, in such a case, though the <confInfo>
parameter indeed has to follow the rules indicated in the XCON data
model, it does not represent the entire updated version of the target
conference, since it conveys just the modifications to apply to that
conference. For example, in order to change the conference title,
the <confInfo> parameter will be of the form:
<confInfo entity="xcon:8977777@example.com">
<conference-description>
<display-text> *** NEW CONFERENCE TITLE *** </display-text>
</conference-description>
</confInfo>
Figure 7: Updating a Conference Object: Modifying the
Title of a Conference
Similarly, to remove the title of an existing conference, a
confRequest/update carrying the following <confInfo> parameter would
do the job.
<span class="grey">Barnes, et al. Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<confInfo entity="xcon:8977777@example.com">
<conference-description>
<display-text/>
</conference-description>
</confInfo>
Figure 8: Updating a Conference Object:
Removing the Title of a Conference
In the case of a confResponse/update with a <response-code> of "200",
no additional information is REQUIRED in the response message, which
means the return of a <confInfo> parameter is OPTIONAL. A subsequent
confRequest/retrieve transaction might provide the CCMP client with
the current status of the conference after the modification, or the
notification protocol might address that task as well. A <response-
code> of "200" indicates that the conference object has been changed
according to the request by the conference server. The <version>
parameter MUST be enclosed in the confResponse/update message, in
order to let the client understand what is the current conference-
object version, upon the applied modifications. A <response-code> of
"409" indicates that the changes reflected in the <confInfo>
parameter of the request are not feasible. This could be due to
policies, requestor roles, specific privileges, unacceptable values,
etc., with the reason specific to a conferencing system and its
configuration. Together with a <response-code> of "409", the
<version> parameter MUST be attached in the confResponse/update,
allowing the client to later retrieve the current version of the
target conference if the one she attempted to modify was not the most
up to date.
In the case of a confRequest with an <operation> parameter of
"delete", the <confObjID> parameter representing the XCON-URI of the
target conference MUST be included while the <confInfo> parameter
MUST NOT be included in the request. The conference server MUST
ignore any <confInfo> parameter that is received within such a
request. The confResponse MUST contain the same value for the
<confObjID> parameter that was included in the confRequest. If the
confResponse/delete operation contains a <response-code> of "200",
the conference indicated in the <confObjID> parameter has been
successfully deleted. A confResponse/delete with a <response-code>
of "200" MUST NOT contain the <confInfo> parameter. The <version>
parameter SHOULD NOT be returned in any confResponse/delete. If the
conference server cannot delete the conference referenced by the
<confObjID> parameter received in the confRequest because it is the
parent of another conference object that is in use, the conference
server MUST return a <response-code> of "425".
<span class="grey">Barnes, et al. Standards Track [Page 28]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
A confRequest with an <operation> parameter of "retrieve", "update",
or "delete" carrying a <confObjID> parameter which is not associated
with one of the conferences (active or registered) that the system is
holding will generate, on the server's side, a confResponse message
containing a <response-code> of "404". This also holds for the case
in which the mentioned <confObjID> parameter is related to an
existing conference object stored at the server, but associated with
a blueprint or with a sidebar rather than an actual conference.
The schema for the confRequest/confResponse pair is shown in
Figure 9.
<!-- confRequest -->
<xs:complexType name="ccmp-conf-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="confRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confRequestType -->
<xs:element name="confRequest" type="confRequestType" />
<xs:complexType name="confRequestType">
<xs:sequence>
<xs:element name="confInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 29]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- confResponse -->
<xs:complexType name="ccmp-conf-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="confResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confResponseType -->
<xs:element name="confResponse" type="confResponseType" />
<xs:complexType name="confResponseType">
<xs:sequence>
<xs:element name="confInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 9: Structure of the confRequest and confResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.5" href="#section-5.3.5">5.3.5</a>. usersRequest and usersResponse</span>
The usersRequest message allows a client to manipulate the <users>
element of the conference object represented by the <confObjID>
parameter. The <users> element contains the list of <user> elements
associated with conference participants, the list of the users to
which access to the conference is allowed/denied, conference
participation policies, etc. The <confObjID> parameter MUST be
included in a usersRequest message.
A <usersInfo> parameter MAY be included in a usersRequest message
depending upon the operation. If the <usersInfo> parameter is
included in the usersRequest message, the parameter MUST be compliant
with the <users> field of the XCON data model.
Two operations are allowed for a usersRequest message:
1. "retrieve": In this case the request MUST NOT include a
<usersInfo> parameter, while the successful response MUST contain
the desired <users> element in the <usersInfo> parameter. The
<span class="grey">Barnes, et al. Standards Track [Page 30]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
conference server MUST ignore a <usersInfo> parameter if it is
received in a request with an <operation> parameter of
"retrieve".
2. "update": In this case, the <usersInfo> parameter MUST contain
the modifications to be applied to the <users> element indicated.
If the <response-code> is "200", then the <usersInfo> parameter
SHOULD NOT be returned. Any <usersInfo> parameter that is
returned SHOULD be ignored. A <response-code> of "426" indicates
that the conferencing client is not allowed to make the changes
reflected in the <usersInfo> contained in the usersRequest
message. This could be due to policies, roles, specific
privileges, etc., with the reason being specific to a
conferencing system and its configuration.
Operations of "create" and "delete" are not applicable to a
usersRequest message and MUST NOT be considered by the server, which
means that a <response-code> of "403" MUST be included in the
usersResponse message.
<!-- usersRequest -->
<xs:complexType name="ccmp-users-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="usersRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- usersRequestType -->
<xs:element name="usersRequest" type="usersRequestType" />
<xs:complexType name="usersRequestType">
<xs:sequence>
<xs:element name="usersInfo"
type="info:users-type" minOccurs="0" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 31]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- usersResponse -->
<xs:complexType name="ccmp-users-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="usersResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- usersResponseType -->
<xs:element name="usersResponse" type="usersResponseType" />
<xs:complexType name="usersResponseType">
<xs:sequence>
<xs:element name="usersInfo" type="info:users-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 10: Structure of the usersRequest and usersResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.6" href="#section-5.3.6">5.3.6</a>. userRequest and userResponse</span>
A userRequest message is used to manipulate <user> elements inside a
conference document associated with a conference identified by the
<confObjID> parameter. Besides retrieving information about a
specific conference user, the message is used to request that the
conference server either create, modify, or delete information about
a user. A userRequest message MUST include the <confObjID> and the
<operation> parameters, and it MAY include a <userInfo> parameter
containing the detailed user's information depending upon the
operation and whether the <userInfo> has already been populated for a
specific user. Note that a user may not necessarily be a
conferencing control client (i.e., some participants in a conference
are not "XCON aware").
An XCON-USERID SHOULD be assigned to each and every user subscribed
to the system. In such a way, a user who is not a conference
participant can make requests (provided she has successfully passed
authorization and authentication checks), like creating a conference
or retrieving conference information.
<span class="grey">Barnes, et al. Standards Track [Page 32]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
Conference users can be created in a number of different ways. In
each of these cases, the <operation> parameter MUST be set to
"create" in the userRequest message. Each of the userResponse
messages for these cases MUST include the <confObjID>, <confUserID>,
<operation>, and <response-code> parameters. In the case of a
<response-code> of "200", the userResponse message MAY include the
<userInfo> parameter depending upon the manner in which the user was
created:
o A conferencing client with an XCON-USERID adds itself to the
conference: In this case, the <userInfo> parameter MAY be included
in the userRequest. The <userInfo> parameter MUST contain a
<user> element (compliant with the XCON data model) and the
'entity' attribute MUST be set to a value that represents the
XCON-USERID of the user initiating the request. No additional
parameters beyond those previously described are required in the
userResponse message, in the case of a <response-code> of "200".
o A conferencing client acts on behalf of another user whose XCON-
USERID is known: In this case, the <userInfo> parameter MUST be
included in the userRequest. The <userInfo> parameter MUST
contain a <user> element and the 'entity' attribute value MUST be
set to the XCON-USERID of the other user in question. No
additional parameters beyond those previously described are
required in the userResponse message, in the case of a <response-
code> of "200".
o A conferencing client who has no XCON-USERID and who wants to
enter, via CCMP, a conference whose identifier is known: In this
case, a side effect of the request is that the user is provided
with a new XCON-USERID (created by the server) carried inside the
<confUserID> parameter of the response. This is the only case in
which a CCMP request can be valid though carrying a void
<confUserID> parameter. A <userInfo> parameter MUST be enclosed
in the request, providing at least a contact URI of the joining
client, in order to let the focus initiate the signaling phase
needed to add her to the conference. The mandatory 'entity'
attribute of the <userInfo> parameter in the request MUST be
filled with a placeholder value with the user part of the XCON-
USERID containing a value of AUTO_GENERATE_X as described in
<a href="#section-4.3">Section 4.3</a>, to conform to the rules contained in the XCON data
model XML schema. The messages (userRequest and userResponse) in
this case should look like the following:
<span class="grey">Barnes, et al. Standards Track [Page 33]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
Request fields:
confUserID=null;
confObjID=confXYZ;
operation=create;
userInfo=
<userInfo entity="xcon-userid:AUTO_GENERATE_1@example.com">
<endpoint entity="sip:GHIL345@example.com">
...
Response fields (in case of success):
confUserID=user345;
confObjID=confXYZ;
operation=create;
response-code=200;
userInfo=null; //or the entire userInfo object
Figure 11: userRequest and userResponse in the
Absence of an xcon-userid
o A conferencing client is unaware of the XCON-USERID of a third
user: In this case, the XCON-USERID in the request, <confUserID>,
is the sender's and the 'entity' attribute of the attached
<userInfo> parameter is filled with the placeholder value
"xcon-userid:AUTO_GENERATE_1@example.com". The XCON-USERID for
the third user MUST be returned to the client issuing the request
in the 'entity' attribute of the response <userInfo> parameter, if
the <response-code> is "200". This scenario is intended to
support both the case where a brand new conferencing system user
is added to a conference by a third party (i.e., a user who has
not yet been provided with an XCON-USERID) and the case where the
CCMP client issuing the request does not know the to-be-added
user's XCON-USERID (which means such an identifier could already
exist on the server's side for that user). In this last case, the
conference server is in charge of avoiding XCON-URI duplicates for
the same conferencing client, looking at key fields in the
request-provided <userInfo> parameter, such as the signaling URI.
If the joining user is brand new, then the generation of a new
XCON-USERID is needed; otherwise, if that user exists already, the
server must recover the corresponding XCON-USERID.
In the case of a userRequest with an <operation> parameter of
"retrieve", the <confObjID> parameter representing the XCON-URI of
the target conference MUST be included. The <confUserID>, containing
the CCMP client's XCON-USERID, MUST also be included in the
<span class="grey">Barnes, et al. Standards Track [Page 34]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
userRequest message. If the client wants to retrieve information
about her profile in the specified conference, no <userInfo>
parameter is needed in the retrieve request. On the other hand, if
the client wants to obtain someone else's info within the given
conference, she MUST include in the userRequest/retrieve a <userInfo>
parameter whose 'entity' attribute conveys the desired user's XCON-
USERID. If the userResponse for the retrieve operation contains a
<response-code> of "200", the <userInfo> parameter MUST be included
in the response.
In case of a userRequest with an <operation> parameter of "update",
the <confObjID>, <confUserID>, and <userInfo> parameters MUST be
included in the request. The <userInfo> parameter is of type "user-
type" and contains all the changes to be applied to a specific <user>
element in the conference object identified by the <confObjID>
parameter in the userRequest message. The user to be modified is
identified through the 'entity' attribute of the <userInfo> parameter
included in the request. In the case of a userResponse with a
<response-code> of "200", no additional information is required in
the userResponse message. A <response-code> of "200" indicates that
the referenced <user> element has been updated by the conference
server. A <response-code> of "426" indicates that the conferencing
client is not allowed to make the changes reflected in the <userInfo>
in the initial request. This could be due to policies, roles,
specific privileges, etc., with the reason specific to a conferencing
system and its configuration.
In the case of a userRequest with an <operation> parameter of
"delete", the <confObjID> representing the XCON-URI of the target
conference MUST be included. The <confUserID> parameter, containing
the CCMP client's XCON-USERID, MUST be included in the userRequest
message. If the client wants to exit the specified conference, no
<userInfo> parameter is needed in the delete request. On the other
hand, if the client wants to remove another participant from the
given conference, she MUST include in the userRequest/delete a
<userInfo> parameter whose 'entity' attribute conveys the XCON-USERID
of that participant. The userResponse MUST contain the same value
for the <confObjID> parameter that was included in the <confObjID>
parameter in the userRequest. The userResponse MUST contain a
<response-code> of "200" if the target <user> element has been
successfully deleted. If the userResponse for the delete operation
contains a <response-code> of "200", the userResponse MUST NOT
contain the <userInfo> parameter.
<span class="grey">Barnes, et al. Standards Track [Page 35]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- userRequest -->
<xs:complexType name="ccmp-user-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="userRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- userRequestType -->
<xs:element name="userRequest" type="userRequestType" />
<xs:complexType name="userRequestType">
<xs:sequence>
<xs:element name="userInfo"
type="info:user-type" minOccurs="0" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- userResponse -->
<xs:complexType name="ccmp-user-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="userResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 36]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- userResponseType -->
<xs:element name="userResponse" type="userResponseType" />
<xs:complexType name="userResponseType">
<xs:sequence>
<xs:element name="userInfo" type="info:user-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 12: Structure of the userRequest and userResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.7" href="#section-5.3.7">5.3.7</a>. sidebarsByValRequest and sidebarsByValResponse</span>
A sidebarsByValRequest message is used to execute a retrieve-only
operation on the <sidebars-by-val> field of the conference object
represented by the <confObjID>. The sidebarsByValRequest message is
of a retrieve-only type, so an <operation> parameter MUST NOT be
included in a sidebarsByValRequest message. As with blueprints and
conferences, CCMP allows for the use of xpath filters whenever a
selected subset of the sidebars available at the server's side has to
be retrieved by the client. This applies both to sidebars by
reference and sidebars by value. A sidebarsByValResponse message
with a <response-code> of "200" MUST contain a <sidebarsByValInfo>
parameter containing the desired <sidebars-by-val> element. A
sidebarsByValResponse message MUST return to the client a <version>
element related to the current version of the main conference object
(i.e., the one whose identifier is contained in the <confObjID> field
of the request) with which the sidebars in question are associated.
The <sidebarsByValInfo> parameter contains the list of the conference
objects associated with the sidebars by value derived from the main
conference. The retrieved sidebars can then be updated or deleted
using the sidebarByValRequest message, which is described in
<a href="#section-5.3.8">Section 5.3.8</a>.
<span class="grey">Barnes, et al. Standards Track [Page 37]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarsByValRequest -->
<xs:complexType name="ccmp-sidebarsByVal-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarsByValRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByValRequestType -->
<xs:element name="sidebarsByValRequest"
type="sidebarsByValRequestType" />
<xs:complexType name="sidebarsByValRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByValResponse -->
<xs:complexType name="ccmp-sidebarsByVal-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarsByValResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 38]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarsByValResponseType -->
<xs:element name="sidebarsByValResponse"
type="sidebarsByValResponseType" />
<xs:complexType name="sidebarsByValResponseType">
<xs:sequence>
<xs:element name="sidebarsByValInfo"
type="info:sidebars-by-val-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 13: Structure of the sidebarsByValRequest and
sidebarsByValResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.8" href="#section-5.3.8">5.3.8</a>. sidebarByValRequest and sidebarByValResponse</span>
A sidebarByValRequest message MUST contain the <operation> parameter,
which distinguishes among retrieval, creation, modification, and
deletion of a specific sidebar. The other required parameters depend
upon the type of operation.
In the case of a "create" operation, the <confObjID> parameter MUST
be included in the sidebyValRequest message. In this case, the
<confObjID> parameter contains the XCON-URI of the main conference in
which the sidebar has to be created. If no "sidebarByValInfo"
parameter is included, the sidebar is created by cloning the main
conference, as envisioned in the XCON framework [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>] following
the implementation specific cloning rules. Otherwise, similar to the
case of direct creation, the sidebar conference object is built on
the basis of the "sidebarByValInfo" parameter provided by the
requestor. As a consequence of a sidebar-by-val creation, the
conference server MUST update the main conference object reflected by
the <confObjID> parameter in the sidebarbyValRequest/create message
introducing the new sidebar object as a new <entry> in the proper
section <sidebars-by-val>. The newly created sidebar conference
object MAY be included in the sidebarByValResponse in the
<sidebarByValInfo> parameter, if the <response-code> is "200". The
XCON-URI of the newly created sidebar MUST appear in the <confObjID>
parameter of the response. The conference server can notify any
conferencing clients that have subscribed to the conference event
package and that are authorized to receive the notification of the
addition of the sidebar to the conference.
<span class="grey">Barnes, et al. Standards Track [Page 39]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
In the case of a sidebarByValRequest message with an <operation>
parameter of "retrieve", the URI for the conference object created
for the sidebar (received in response to a create operation or in a
sidebarsByValResponse message) MUST be included in the <confObjID>
parameter in the request. This retrieve operation is handled by the
conference server in the same manner as in the case of an <operation>
parameter of "retrieve" included in a confRequest message, as
described in <a href="#section-5.3.4">Section 5.3.4</a>.
In the case of a sidebarByValRequest message with an <operation>
parameter of "update", the <sidebarByValInfo> MUST also be included
in the request. The <confObjID> parameter contained in the request
message identifies the specific sidebar instance to be updated. An
update operation on the specific sidebar instance contained in the
<sidebarByValInfo> parameter is handled by the conference server in
the same manner as an update operation on the conference instance as
reflected by the <confInfo> parameter included in a confRequest
message as detailed in <a href="#section-5.3.4">Section 5.3.4</a>. A sidebarByValResponse message
MUST return to the client a <version> element related to the current
version of the sidebar whose identifier is contained in the
<confObjID> field of the request.
If an <operation> parameter of "delete" is included in the
sidebarByVal request, the <sidebarByValInfo> parameter MUST NOT be
included in the request. Any <sidebarByValInfo> included in the
request MUST be ignored by the conference server. The URI for the
conference object associated with the sidebar MUST be included in the
<confObjID> parameter in the request. If the specific conferencing
user, as reflected by the <confUserID> parameter, in the request is
authorized to delete the conference, the conference server deletes
the conference object reflected by the <confObjID> parameter and
updates the data in the conference object from which the sidebar was
cloned. The conference server can notify any conferencing clients
that have subscribed to the conference event package and that are
authorized to receive the notification of the deletion of the sidebar
from the conference.
If a sidebarByValRequest with an <operation> parameter of "retrieve",
"update", or "delete" carries a <confObjID> parameter which is not
associated with any existing sidebar-by-val, a confResponse message
containing a <response-code> of "404" will be generated on the
server's side. This also holds for the case in which the mentioned
<confObjID> parameter is related to an existing conference object
stored at the server, but associated with a blueprint or with an
actual conference or with a sidebar-by-ref rather than a sidebar-by-
val.
<span class="grey">Barnes, et al. Standards Track [Page 40]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarByValRequest -->
<xs:complexType name="ccmp-sidebarByVal-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarByValRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByValRequestType -->
<xs:element name="sidebarByValRequest"
type="sidebarByValRequestType" />
<xs:complexType name="sidebarByValRequestType">
<xs:sequence>
<xs:element name="sidebarByValInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByValResponse -->
<xs:complexType name="ccmp-sidebarByVal-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarByValResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 41]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarByValResponseType -->
<xs:element name="sidebarByValResponse"
type="sidebarByValResponseType" />
<xs:complexType name="sidebarByValResponseType">
<xs:sequence>
<xs:element name="sidebarByValInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 14: Structure of the sidebarByValRequest and
sidebarByValResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.9" href="#section-5.3.9">5.3.9</a>. sidebarsByRefRequest and sidebarsByRefResponse</span>
Similar to the sidebarsByValRequest, a sidebarsByRefRequest can be
invoked to retrieve the <sidebars-by-ref> element of the conference
object identified by the <confObjID> parameter. The
sidebarsByRefRequest message is of a retrieve-only type, so an
<operation> parameter MUST NOT be included in a sidebarsByRefRequest
message. In the case of a <response-code> of "200", the
<sidebarsByRefInfo> parameter, containing the <sidebars-by-ref>
element of the conference object, MUST be included in the response.
The <sidebars-by-ref> element represents the set of URIs of the
sidebars associated with the main conference, whose description (in
the form of a standard XCON conference document) is external to the
main conference itself. Through the retrieved URIs, it is then
possible to access single sidebars using the sidebarByRefRequest
message, described in <a href="#section-5.3.10">Section 5.3.10</a>. A sidebarsByRefResponse
message MUST carry back to the client a <version> element related to
the current version of the main conference object (i.e., the one
whose identifier is contained in the <confObjId> field of the
request) with which the sidebars in question are associated.
<span class="grey">Barnes, et al. Standards Track [Page 42]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarsByRefRequest -->
<xs:complexType name="ccmp-sidebarsByRef-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarsByRefRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByRefRequestType -->
<xs:element name="sidebarsByRefRequest"
type="sidebarsByRefRequestType" />
<xs:complexType name="sidebarsByRefRequestType">
<xs:sequence>
<xs:element name="xpathFilter"
type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByRefResponse -->
<xs:complexType name="ccmp-sidebarsByref-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarsByRefResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 43]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarsByRefResponseType -->
<xs:element name="sidebarsByRefResponse"
type="sidebarsByRefResponseType" />
<xs:complexType name="sidebarsByRefResponseType">
<xs:sequence>
<xs:element name="sidebarsByRefInfo"
type="info:uris-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 15: Structure of the sidebarsByRefRequest
and sidebarsByRefResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.10" href="#section-5.3.10">5.3.10</a>. sidebarByRefRequest and sidebarByRefResponse</span>
A sidebarByValResponse message MUST return to the client a <version>
element related to the current version of the sidebar whose
identifier is contained in the <confObjID> field of the request.
In the case of a create operation, the <confObjID> parameter MUST be
included in the sidebyRefRequest message. In this case, the
<confObjID> parameter contains the XCON-URI of the main conference in
which the sidebar has to be created. If no <sidebarByRefInfo>
parameter is included, following the XCON framework [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>], the
sidebar is created by cloning the main conference, observing the
implementation-specific cloning rules. Otherwise, similar to the
case of direct creation, the sidebar conference object is built on
the basis of the <sidebarByRefInfo> parameter provided by the
requestor. If the creation of the sidebar is successful, the
conference server MUST update the <sidebars-by-ref> element in the
conference object from which the sidebar was created (i.e., as
identified by the <confObjID> in the original sidebarByRefRequest),
with the URI of the newly created sidebar. The newly created
conference object MAY be included in the response in the
<sidebarByRefInfo> parameter with a <response-code> of "200". The
URI for the conference object associated with the newly created
sidebar object MUST appear in the <confObjID> parameter of the
response. The conference server can notify any conferencing clients
that have subscribed to the conference event package and that are
authorized to receive the notification of the addition of the sidebar
to the conference.
<span class="grey">Barnes, et al. Standards Track [Page 44]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
In the case of a sidebarByRefRequest message with an <operation>
parameter of "retrieve", the URI for the conference object created
for the sidebar MUST be included in the <confObjID> parameter in the
request. A retrieve operation on the <sidebarByRefInfo> is handled
by the conference server in the same manner as a retrieve operation
on the confInfo included in a confRequest message as detailed in
<a href="#section-5.3.4">Section 5.3.4</a>.
In the case of a sidebarByRefRequest message with an <operation>
parameter of "update", the URI for the conference object created for
the sidebar MUST be included in the <confObjID> parameter in the
request. The <sidebarByRefInfo> MUST also be included in the request
in the case of an "update" operation. An update operation on the
<sidebarByRefInfo> is handled by the conference server in the same
manner as an update operation on the <confInfo> included in a
confRequest message as detailed in <a href="#section-5.3.4">Section 5.3.4</a>. A
sidebarByRefResponse message MUST carry back to the client a
<version> element related to the current version of the sidebar whose
identifier is contained in the <confObjID> field of the request.
If an <operation> parameter of "delete" is included in the
sidebarByRefRequest, the <sidebarByRefInfo> parameter MUST NOT be
included in the request. Any <sidebarByRefInfo> included in the
request MUST be ignored by the conference server. The URI for the
conference object for the sidebar MUST be included in the <confObjID>
parameter in the request. If the specific conferencing user as
reflected by the <confUserID> parameter in the request is authorized
to delete the conference, the conference server SHOULD delete the
conference object reflected by the <confObjID> parameter and SHOULD
update the <sidebars-by-ref> element in the conference object from
which the sidebar was originally cloned. The conference server can
notify any conferencing clients that have subscribed to the
conference event package and that are authorized to receive the
notification of the deletion of the sidebar.
If a sidebarByRefRequest with an <operation> parameter of "retrieve",
"update", or "delete" carries a <confObjID> parameter that is not
associated with any existing sidebar-by-ref, a confResponse message
containing a <response-code> of "404" will be generated on the
server's side. This also holds for the case in which the value of
the mentioned <confObjID> parameter is related to an existing
conference object stored at the server, but associated with a
blueprint or with an actual conference or with a sidebar-by-val
rather than a sidebar-by-ref.
<span class="grey">Barnes, et al. Standards Track [Page 45]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarByRefRequest -->
<xs:complexType name="ccmp-sidebarByRef-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarByRefRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByRefRequestType -->
<xs:element name="sidebarByRefRequest"
type="sidebarByRefRequestType" />
<xs:complexType name="sidebarByRefRequestType">
<xs:sequence>
<xs:element name="sidebarByRefInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByRefResponse -->
<xs:complexType name="ccmp-sidebarByRef-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarByRefResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 46]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarByRefResponseType -->
<xs:element name="sidebarByRefResponse"
type="sidebarByRefResponseType" />
<xs:complexType name="sidebarByRefResponseType">
<xs:sequence>
<xs:element name="sidebarByRefInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 16: Structure of the sidebarByRefRequest
and sidebarByRefResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.11" href="#section-5.3.11">5.3.11</a>. extendedRequest and extendedResponse</span>
In order to allow specifying new request and response pairs for
conference control, CCMP defines the extendedRequest and
extendedResponse messages. Such messages constitute a CCMP skeleton
in which implementers can transport the information needed to realize
conference control mechanisms not explicitly envisioned in the CCMP
specification; these mechanisms are called, in this context,
"extensions". Each extension is assumed to be characterized by an
appropriate name that MUST be carried in the extendedRequest/
extendedResponse pair in the provided <extensionName> field.
Extension-specific information can be transported in the form of
schema-defined XML elements inside the <any> element present in both
extendedRequest and extendedResponse.
The conferencing client SHOULD be able to determine the extensions
supported by a CCMP server and to recover the XML schema defining the
related specific elements by means of an optionsRequest/
optionsResponse CCMP transaction (see <a href="#section-5.3.12">Section 5.3.12</a>).
The meaning of the common CCMP parameters inherited by the
extendedRequest and extendedResponse from the basic CCMP request and
response messages SHOULD be preserved and exploited appropriately
while defining an extension.
<span class="grey">Barnes, et al. Standards Track [Page 47]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- extendedRequest -->
<xs:complexType name="ccmp-extended-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="extendedRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- extendedRequestType -->
<xs:element name="extendedRequest" type="extendedRequestType"/>
<xs:complexType name="extendedRequestType">
<xs:sequence>
<xs:element name="extensionName"
type="xs:string" minOccurs="1"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!-- extendedResponse -->
<xs:complexType name="ccmp-extended-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="extendedResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 48]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- extendedResponseType -->
<xs:element name="extendedResponse" type="extendedResponseType"/>
<xs:complexType name="extendedResponseType">
<xs:sequence>
<xs:element name="extensionName"
type="xs:string"
minOccurs="1"/>
<xs:any namespace="##other"
processContents="lax"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
Figure 17: Structure of the extendedRequest and
extendedResponse Messages
<span class="h4"><a class="selflink" id="section-5.3.12" href="#section-5.3.12">5.3.12</a>. optionsRequest and optionsResponse</span>
The optionsRequest message (Figure 18) retrieves general information
about conference server capabilities. These capabilities include the
standard CCMP messages (request/response pairs) and potential
extension messages supported by the conference server. As such, it
is a basic CCMP message, rather than a specialization of the general
CCMP request.
The optionsResponse returns, in the appropriate <options> field, a
list of the supported CCMP message pairs as defined in this
specification. These messages are in the form of a list: <standard-
message-list> including each of the supported messages as reflected
by <standard-message> elements. The optionsResponse message also
allows for an <extended-message-list>, which is a list of additional
message types in the form of <extended-message-list> elements that
are currently undefined, to allow for future extensibility. The
following information is provided for both types of messages:
o <name> (REQUIRED): in case of standard messages, it can be one of
the 10 standard message names defined in this document (i.e.,
"blueprintsRequest", "confsRequest", etc.). In case of
extensions, this element MUST carry the same value of the
<extension-name> inserted in the corresponding extendedRequest/
extendedResponse message pair.
o <operations> (OPTIONAL): this field is a list of <operation>
entries, each representing the Create, Read, Update, Delete (CRUD)
operation supported by the server for the message. If this
element is absent, the client SHOULD assume the server is able to
<span class="grey">Barnes, et al. Standards Track [Page 49]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
handle the entire set of CRUD operations or, in case of standard
messages, all the operations envisioned for that message in this
document.
o <schema-ref> (OPTIONAL): since all CCMP messages can potentially
contain XML elements not envisioned in the CCMP schema (due to the
presence of <any> elements and attributes), a reference to a
proper schema definition specifying such new elements/attributes
can also be sent back to the clients by means of such field. If
this element is absent, no new elements are introduced in the
messages other than those explicitly defined in the CCMP
specification.
o <description> (OPTIONAL): human-readable information about the
related message.
The only parameter needed in the optionsRequest is the sender
confUserID, which is mirrored in the same parameter of the
corresponding optionsResponse.
The CCMP server MUST include the <standard-message-list> containing
at least one <operation> element in the optionsResponse, since a CCMP
server is REQUIRED to be able to handle both the request and response
messages for at least one of the operations.
<!-- optionsRequest -->
<xs:complexType name="ccmp-options-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type"/>
</xs:complexContent>
</xs:complexType>
<!-- optionsResponse -->
<xs:complexType name="ccmp-options-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="optionsResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 50]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- optionsResponseType -->
<xs:element name="optionsResponse"
type="optionsResponseType" />
<xs:complexType name="optionsResponseType">
<xs:sequence>
<xs:element name="options"
type="options-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- options-type -->
<xs:complexType name="options-type">
<xs:sequence>
<xs:element name="standard-message-list"
type="standard-message-list-type"
minOccurs="1"/>
<xs:element name="extended-message-list"
type="extended-message-list-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-list-type -->
<xs:complexType name="standard-message-list-type">
<xs:sequence>
<xs:element name="standard-message"
type="standard-message-type"
minOccurs="1" maxOccurs="10"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 51]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- standard-message-type -->
<xs:complexType name="standard-message-type">
<xs:sequence>
<xs:element name="name"
type="standard-message-name-type"
minOccurs="1"/>
<xs:element name="operations"
type="operations-type"
minOccurs="0"/>
<xs:element name="schema-def"
type="xs:string" minOccurs="0"/>
<xs:element name="description"
type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-name-type -->
<xs:simpleType name="standard-message-name-type">
<xs:restriction base="xs:token">
<xs:enumeration value="confsRequest"/>
<xs:enumeration value="confRequest"/>
<xs:enumeration value="blueprintsRequest"/>
<xs:enumeration value="blueprintRequest"/>
<xs:enumeration value="usersRequest"/>
<xs:enumeration value="userRequest"/>
<xs:enumeration value="sidebarsByValRequest"/>
<xs:enumeration value="sidebarByValRequest"/>
<xs:enumeration value="sidebarsByRefRequest"/>
<xs:enumeration value="sidebarByRefRequest"/>
</xs:restriction>
</xs:simpleType>
<span class="grey">Barnes, et al. Standards Track [Page 52]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- operations-type -->
<xs:complexType name="operations-type">
<xs:sequence>
<xs:element name="operation" type="operationType"
minOccurs="1" maxOccurs="4"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
Figure 18: Structure of the optionsRequest and
optionsResponse Messages
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. CCMP Response Codes</span>
All CCMP response messages MUST include a <response-code>. This
document defines an IANA registry for the CCMP response codes, as
described in <a href="#section-12.5.2">Section 12.5.2</a>. The following summarizes the CCMP
response codes:
200 Success:
Successful completion of the requested operation.
400 Bad Request:
Syntactically malformed request.
401 Unauthorized:
User not allowed to perform the required operation.
403 Forbidden:
Operation not allowed (e.g., cancellation of a blueprint).
404 Object Not Found:
The target conference object does not exist at the server (The
object in the error message refers to the <confObjID> parameter in
the generic request message).
409 Conflict:
A generic error associated with all those situations in which a
requested client operation cannot be successfully completed by the
server. An example of such a situation is when the modification
of an object cannot be applied due to conflicts arising at the
<span class="grey">Barnes, et al. Standards Track [Page 53]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
server's side, e.g., because the client version of the object is
an obsolete one and the requested modifications collide with the
up-to-date state of the object stored at the server. Such code
would also be used if a client attempts to create an object
(conference or user) with an entity that already exists.
420 User Not Found:
Target user missing at the server (it is related to the XCON-
USERID in the 'entity' attribute of the <userInfo> parameter when
it is included in userRequests).
421 Invalid confUserID:
User does not exist at the server (This code is returned for
requests where the <confUserID> parameter is invalid).
422 Invalid Conference Password:
The password for the target conference object contained in the
request is wrong.
423 Conference Password Required:
"conference-password" missing in a request to access a password-
protected conference object.
424 Authentication Required:
User's authentication information is missing or invalid.
425 Forbidden Delete Parent:
Cancel operation failed since the target object is a parent of
child objects that depend on it, or because it affects, based on
the "parent-enforceable" mechanism, the corresponding element in a
child object.
426 Forbidden Change Protected:
Update refused by the server because the target element cannot be
modified due to its implicit dependence on the value of a parent
object ("parent-enforceable" mechanism).
427 Invalid Domain Name:
The domain name in an AUTO_GENERATE_X instance in the conference
object is not within the CCMP server's domain of responsibility.
<span class="grey">Barnes, et al. Standards Track [Page 54]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
500 Server Internal Error:
The server cannot complete the required service due to a system
internal error.
501 Not Implemented:
Operation defined by the protocol, but not implemented by this
server.
510 Request Timeout:
The time required to serve the request has exceeded the configured
service threshold.
511 Resources Not Available:
This code is used when the CCMP server cannot execute a command
because of resource issues, e.g., it cannot create a sub-
conference because the system has reached its limits on the number
of sub-conferences, or if a request for adding a new user fails
because the max number of users has been reached for the
conference or the max number of users has been reached for the
conferencing system.
The handling of a <response-code> of "404", "409", "420", "421",
"425", "426", or "427" is only applicable to specific operations for
specialized message responses and the details are provided in
<a href="#section-5.3">Section 5.3</a>. The following table summarizes these response codes and
the specialized message and operation to which they are applicable:
<span class="grey">Barnes, et al. Standards Track [Page 55]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
+----------+-------------+--------------+-------------+-------------+
| Response | Create | Retrieve | Update | Delete |
| code | | | | |
+----------+-------------+--------------+-------------+-------------+
| 404 | userRequest | All retrieve | All update | All delete |
| | sidebarBy | requests | requests | requests |
| | ValRequest, | EXCEPT: | | |
| | sidebarsBy | blueprints | | |
| | RefRequest | Request, | | |
| | | confsRequest | | |
| -------- | ----------- | ------------ | ----------- | ----------- |
| 409 | N/A | N/A | All update | N/A |
| | | | requests | |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 420 | userRequest | userRequest | userRequest | userRequest |
| | (third- | | | |
| | party | | | |
| | invite with | | | |
| | third-user | | | |
| | entity) (*) | | | |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 421 | All create | All retrieve | All update | All delete |
| | requests | requests | requests | requests |
| | EXCEPT: | | | |
| | userRequest | | | |
| | with no | | | |
| | confUserID | | | |
| | (**) | | | |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 425 | N/A | N/A | N/A | All delete |
| | | | | request |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 426 | N/A | N/A | All update | N/A |
| | | | requests | |
| -------- | ----------- | ----------- | ----------- | ----------- |
| 427 | ConfRequest | N/A | All update | N/A |
| | UserRequest | | requests | |
+----------+-------------+--------------+-------------+-------------+
Table 2: Response Codes and Associated Operations
(*) "420" in answer to a "userRequest/create" operation: In the case
of a third-party invite, this code can be returned if the
<confUserID> (contained in the 'entity' attribute of the <userInfo>
parameter) of the user to be added is unknown. In the case above, if
instead it is the <confUserID> parameter of the sender of the request
that is invalid, a <response-code> of "421" is returned to the
client.
<span class="grey">Barnes, et al. Standards Track [Page 56]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
(**) "421" is not sent in answer to userRequest/create messages
having a "null" confUserID, since this case is associated with a user
who is unaware of his own XCON-USERID, but wants to enter a known
conference.
In the case of a <response-code> of "510", a conferencing client MAY
re-attempt the request within a period of time that would be specific
to a conferencing client or conference server.
A <response-code> of "400" indicates that the conferencing client
sent a malformed request, which is indicative of an error in the
conferencing client or in the conference server. The handling is
specific to the conferencing client implementation (e.g., generate a
log, display an error message, etc.). It is NOT RECOMMENDED that the
client re-attempt the request in this case.
A <response-code> of "401" or "403" indicates the client does not
have the appropriate permissions, or there is an error in the
permissions: re-attempting the request would likely not succeed and
thus it is NOT RECOMMENDED.
Any unexpected or unknown <response-code> SHOULD be treated by the
client in the same manner as a <response-code> of "500", the handling
of which is specific to the conferencing client implementation.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. A Complete Example of CCMP in Action</span>
In this section a typical, non-normative, scenario in which CCMP
comes into play is described, by showing the actual composition of
the various CCMP messages. In the call flows of the example, the
conferencing client is a CCMP-enabled client, and the conference
server is a CCMP-enabled server. The XCON-USERID of the client,
Alice, is "xcon-userid:alice@example.com" and it appears in the
<confUserID> parameter in all requests. The sequence of operations
is as follows:
1. Alice retrieves the list of available blueprints from the server
(<a href="#section-6.1">Section 6.1</a>);
2. Alice asks for detailed information about a specific blueprint
(<a href="#section-6.2">Section 6.2</a>);
3. Alice decides to create a new conference by cloning the retrieved
blueprint (<a href="#section-6.3">Section 6.3</a>);
4. Alice modifies information (e.g., XCON-URI, name, and
description) associated with the newly created blueprint
(<a href="#section-6.4">Section 6.4</a>);
<span class="grey">Barnes, et al. Standards Track [Page 57]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
5. Alice specifies a list of users to be contacted when the
conference is activated (<a href="#section-6.5">Section 6.5</a>);
6. Alice joins the conference (<a href="#section-6.6">Section 6.6</a>);
7. Alice lets a new user, Ciccio, (whose XCON-USERID is
"xcon-userid:Ciccio@example.com") join the conference
(<a href="#section-6.7">Section 6.7</a>).
8. Alice asks for the CCMP server capabilities (<a href="#section-6.8">Section 6.8</a>);
9. Alice exploits an extension of the CCMP server (<a href="#section-6.9">Section 6.9</a>).
Note that the examples do not include any details beyond the basic
operation.
In the following sections, we deal with each of the aforementioned
actions separately.
<span class="h3"><a class="selflink" id="section-6.1" href="#section-6.1">6.1</a>. Alice Retrieves the Available Blueprints</span>
This section illustrates the transaction associated with retrieval of
the blueprints, together with a dump of the two messages exchanged
(blueprintsRequest and blueprintsResponse). As shown in the figure,
the blueprintsResponse message contains, in the <blueprintsInfo>
parameter, information about the available blueprints, in the form of
the standard XCON-URI of the blueprint, plus additional (and
optional) information, like its display-text and purpose.
Alice retrieves from the server the list of available blueprints:
CCMP Client CCMP Server
| |
| CCMP blueprintsRequest message |
| - confUserID: Alice |
| - confObjID: (null) |
|------------------------------------------------------>|
| |
| CCMP blueprintsResponse message |
| - confUserID: Alice |
| - confObjID: (null) |
| - response-code: 200 |
| - blueprintsInfo: bp123,bp124,.. |
|<------------------------------------------------------|
| |
. .
. .
<span class="grey">Barnes, et al. Standards Track [Page 58]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
1. blueprintsRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-blueprints-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<ccmp:blueprintsRequest/>
</ccmpRequest>
</ccmp:ccmpRequest>
2. blueprintsResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-blueprints-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<response-code>200</response-code>
<ccmp:blueprintsResponse>
<blueprintsInfo>
<info:entry>
<info:uri>xcon:AudioRoom@example.com</info:uri>
<info:display-text>AudioRoom</info:display-text>
<info:purpose>Simple Room:
conference room with public access,
where only audio is available, more users
can talk at the same time
and the requests for the AudioFloor
are automatically accepted.
</info:purpose>
</info:entry>
<info:entry>
<info:uri>xcon:VideoRoom@example.com</info:uri>
<info:display-text>VideoRoom</info:display-text>
<info:purpose>Video Room:
conference room with public access,
where both audio and video are available,
8 users can talk and be seen at the same time,
and the floor requests are automatically accepted.
</info:purpose>
<span class="grey">Barnes, et al. Standards Track [Page 59]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
</info:entry>
<info:entry>
<info:uri>xcon:AudioConference1@example.com</info:uri>
<info:display-text>AudioConference1</info:display-text>
<info:purpose>Public Audio Conference:
conference with public access,
where only audio is available,
only one user can talk at the same time,
and the requests for the AudioFloor MUST
be accepted by a Chair.
</info:purpose>
</info:entry>
<info:entry>
<info:uri>xcon:VideoConference1@example.com</info:uri>
<info:display-text>VideoConference1</info:display-text>
<info:purpose>Public Video Conference: conference
where both audio and video are available,
only one user can talk.
</info:purpose>
</info:entry>
<info:entry>
<info:uri>xcon:AudioConference2@example.com</info:uri>
<info:display-text>AudioConference2</info:display-text>
<info:purpose>Basic Audio Conference:
conference with private access,
where only audio is available,
only one user can talk at the same time,
and the requests for the AudioFloor MUST
be accepted by a Chair.
</info:purpose>
</info:entry>
</blueprintsInfo>
</ccmp:blueprintsResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 19: Getting Blueprints from the Server
<span class="h3"><a class="selflink" id="section-6.2" href="#section-6.2">6.2</a>. Alice Gets Detailed Information about a Specific Blueprint</span>
This section illustrates the second transaction in the overall flow.
In this case, Alice, who now knows the XCON-URIs of the blueprints
available at the server, makes a drill-down query, in the form of a
CCMP blueprintRequest message, to get detailed information about one
of them (the one called with XCON-URI "xcon:AudioRoom@example.com").
The picture shows such a transaction. Notice that the response
contains, in the <blueprintInfo> parameter, a document compliant with
the standard XCON data model.
<span class="grey">Barnes, et al. Standards Track [Page 60]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
Alice retrieves detailed information about a specified blueprint:
CCMP Client CCMP Server
| |
| CCMP blueprintRequest message |
| - confUserID: Alice |
| - confObjID: bp123 |
| - operation: retrieve |
| - blueprintInfo: (null) |
|------------------------------------------------------>|
| |
| CCMP blueprintResponse message |
| - confUserID: Alice |
| - confObjID: bp123 |
| - operation: retrieve |
| - response-code: 200 |
| - blueprintInfo: bp123Info |
|<------------------------------------------------------|
| |
. .
. .
1. blueprintRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-blueprint-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:AudioRoom@example.com</confObjID>
<operation>retrieve</operation>
<ccmp:blueprintRequest/>
</ccmpRequest>
</ccmp:ccmpRequest>
2. blueprintResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-blueprint-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<span class="grey">Barnes, et al. Standards Track [Page 61]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<confObjID>xcon:AudioRoom@example.com</confObjID>
<operation>retrieve</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<ccmp:blueprintResponse>
<blueprintInfo entity="xcon:AudioRoom@example.com">
<info:conference-description>
<info:display-text>AudioRoom</info:display-text>
<info:available-media>
<info:entry label="audioLabel">
<info:display-text>audio stream</info:display-text>
<info:type>audio</info:type>
</info:entry>
</info:available-media>
</info:conference-description>
<info:users>
<xcon:join-handling>allow</xcon:join-handling>
</info:users>
<xcon:floor-information>
<xcon:floor-request-handling>confirm</xcon:floor-request-handling>
<xcon:conference-floor-policy>
<xcon:floor id="audioFloor">
<xcon:media-label>audioLabel</xcon:media-label>
</xcon:floor>
</xcon:conference-floor-policy>
</xcon:floor-information>
</blueprintInfo>
</ccmp:blueprintResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 20: Getting Information about a Specific Blueprint
<span class="h3"><a class="selflink" id="section-6.3" href="#section-6.3">6.3</a>. Alice Creates a New Conference through a Cloning Operation</span>
This section illustrates the third transaction in the overall flow.
Alice decides to create a new conference by cloning the blueprint
having XCON-URI "xcon:AudioRoom@example.com", for which she just
retrieved detailed information through the blueprintRequest message.
This is achieved by sending a confRequest/create message having the
blueprint's URI in the <confObjID> parameter. The picture shows such
a transaction. Notice that the response contains, in the <confInfo>
parameter, the document associated with the newly created conference,
which is compliant with the standard XCON data model. The
<confObjID> parameter in the response is set to the XCON-URI of the
new conference (in this case, "xcon:8977794@example.com"). We also
<span class="grey">Barnes, et al. Standards Track [Page 62]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
notice that this value is equal to the value of the 'entity'
attribute of the <conference-info> element of the document
representing the newly created conference object.
Alice creates a new conference by cloning the
"xcon:AudioRoom@example.com" blueprint:
CCMP Client CCMP Server
| |
| CCMP confRequest message |
| - confUserID: Alice |
| - confObjID: AudioRoom |
| - operation: create |
| - confInfo: (null) |
|------------------------------------------------------>|
| |
| CCMP confResponse message |
| - confUserID: Alice |
| - confObjID: newConfId |
| - operation: create |
| - response-code: 200 |
| - version: 1 |
| - confInfo: newConfInfo |
|<------------------------------------------------------|
| |
. .
. .
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. confRequest message:</span>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-conf-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:AudioRoom@example.com</confObjID>
<operation>create</operation>
<ccmp:confRequest/>
</ccmpRequest>
</ccmp:ccmpRequest>
<span class="grey">Barnes, et al. Standards Track [Page 63]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. confResponse message from the server:</span>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-conf-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<version>1</version>
<ccmp:confResponse>
<confInfo entity="xcon:8977794@example.com">
<info:conference-description>
<info:display-text>
New conference by Alice cloned from AudioRoom
</info:display-text>
<info:available-media>
<info:entry label="333">
<info:display-text>audio stream</info:display-text>
<info:type>audio</info:type>
</info:entry>
</info:available-media>
</info:conference-description>
<info:users>
<xcon:join-handling>allow</xcon:join-handling>
</info:users>
<xcon:floor-information>
<xcon:floor-request-handling>confirm</xcon:floor-request-handling>
<xcon:conference-floor-policy>
<xcon:floor id="11">
<xcon:media-label>333</xcon:media-label>
</xcon:floor>
</xcon:conference-floor-policy>
</xcon:floor-information>
</confInfo>
</ccmp:confResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 21: Creating a New Conference by Cloning a Blueprint
<span class="grey">Barnes, et al. Standards Track [Page 64]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h3"><a class="selflink" id="section-6.4" href="#section-6.4">6.4</a>. Alice Updates Conference Information</span>
This section illustrates the fourth transaction in the overall flow.
Alice decides to modify some of the details associated with the
conference she just created. More precisely, she changes the
<display-text> element under the <conference-description> element of
the document representing the conference. This is achieved through a
confRequest/update message carrying the fragment of the conference
document to which the required changes have to be applied. As shown
in the picture, the response contains a code of "200", which
acknowledges the modifications requested by the client, while also
updating the conference version number from 1 to 2, as reflected in
the "version" parameter.
Alice updates information about the conference she just created:
CCMP Client CCMP Server
| |
| CCMP confRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: update |
| - confInfo: confUpdates |
|------------------------------------------------------>|
| |
| CCMP confResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: update |
| - response-code: 200 |
| - version: 2 |
| - confInfo: (null) |
|<------------------------------------------------------|
| |
. .
. .
1. confRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-conf-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<span class="grey">Barnes, et al. Standards Track [Page 65]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>update</operation>
<ccmp:confRequest>
<confInfo entity="xcon:8977794@example.com">
<info:conference-description>
<info:display-text>
Alice's conference
</info:display-text>
</info:conference-description>
</confInfo>
</ccmp:confRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
2. confResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-conf-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>update</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<version>2</version>
<ccmp:confResponse/>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 22: Updating Conference Information
<span class="h3"><a class="selflink" id="section-6.5" href="#section-6.5">6.5</a>. Alice Inserts a List of Users into the Conference Object</span>
This section illustrates the fifth transaction in the overall flow.
Alice modifies the <allowed-users-list> under the <users> element in
the document associated with the conference she created. To achieve
this, she makes use of the usersRequest message provided by CCMP.
Alice updates information about the list of users to whom access to
the conference is permitted:
<span class="grey">Barnes, et al. Standards Track [Page 66]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
CCMP Client CCMP Server
| |
| CCMP usersRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: update |
| - usersInfo: usersUpdates |
|------------------------------------------------------>|
| |
| CCMP usersResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: update |
| - response-code: 200 |
| - version: 3 |
| - usersInfo: (null) |
|<------------------------------------------------------|
| |
. .
. .
1. usersRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-users-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>update</operation>
<ccmp:usersRequest>
<usersInfo>
<xcon:allowed-users-list>
<xcon:target method="dial out"
uri="xmpp:cicciolo@pippozzo.com"/>
<xcon:target method="refer"
uri="tel:+1-972-555-1234"/>
<xcon:target method="refer"
uri="sip:Carol@example.com"/>
</xcon:allowed-users-list>
</usersInfo>
</ccmp:usersRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
<span class="grey">Barnes, et al. Standards Track [Page 67]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
2. usersResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-users-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>retrieve</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<version>3</version>
<ccmp:usersResponse/>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 23: Updating the List of Allowed Users for the
Conference 'xcon:8977794@example.com'
<span class="h3"><a class="selflink" id="section-6.6" href="#section-6.6">6.6</a>. Alice Joins the Conference</span>
This section illustrates the sixth transaction in the overall flow.
Alice uses CCMP to add herself to the newly created conference. This
is achieved through a userRequest/create message containing, in the
<userInfo> parameter, a <user> element compliant with the XCON data
model representation. Notice that such an element includes
information about the user's Addresses of Record, as well as her
current endpoint. The picture below shows the transaction. Notice
how the <confUserID> parameter is equal to the 'entity' attribute of
the <userInfo> element, which indicates that the request issued by
the client is a first-party one.
Alice joins the conference by issuing a userRequest/create message
with her own ID to the server:
<span class="grey">Barnes, et al. Standards Track [Page 68]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
CCMP Client CCMP Server
| |
| CCMP userRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: create |
| - userInfo: AliceUserInfo |
|------------------------------------------------------>|
| |
| CCMP userResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: create |
| - response-code: 200 |
| - version: 4 |
| - userInfo: (null) |
|<------------------------------------------------------|
| |
. .
. .
1. userRequest message:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-user-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<ccmp:userRequest>
<userInfo entity="xcon-userid:alice@example.com">
<info:associated-aors>
<info:entry>
<info:uri>
mailto:Alice83@example.com
</info:uri>
<info:display-text>email</info:display-text>
</info:entry>
</info:associated-aors>
<info:endpoint entity="sip:alice_789@example.com"/>
</userInfo>
</ccmp:userRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
<span class="grey">Barnes, et al. Standards Track [Page 69]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
2. userResponse message from the server:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-user-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<response-code>200</response-code>
<response-string>Success</response-string>
<version>4</version>
<ccmp:userResponse/>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 24: Alice Joins the Conference through CCMP
<span class="h3"><a class="selflink" id="section-6.7" href="#section-6.7">6.7</a>. Alice Adds a New User to the Conference</span>
This section illustrates the seventh and last transaction in the
overall flow. Alice uses CCMP to add a new conferencing system user,
Ciccio, to the conference. This "third-party" request is realized
through a userRequest/create message containing, in the <userInfo>
parameter, a <user> element compliant with the XCON data model
representation. Notice that such an element includes information
about Ciccio's Addresses of Record, as well as his current endpoint,
but has a placeholder 'entity' attribute,
"AUTO_GENERATE_1@example.com" as discussed in <a href="#section-4.3">Section 4.3</a>, since the
XCON-USERID is initially unknown to Alice. Thus, the conference
server is in charge of generating a new XCON-USERID for the user
Alice indicates (i.e., Ciccio), and returning it in the 'entity'
attribute of the <userInfo> parameter carried in the response, as
well as adding the user to the conference. The picture below shows
the transaction.
Alice adds user "Ciccio" to the conference by issuing a third-party
userRequest/create message to the server:
<span class="grey">Barnes, et al. Standards Track [Page 70]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
CCMP Client CCMP Server
| |
| CCMP userRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: create |
| - userInfo: dummyUserID, CiccioUserInfo |
|------------------------------------------------------>|
| |
| CCMP optionsResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: create |
| - response-code: 200 |
| - version: 5 |
| - userInfo: userIDCiccio, |
| CiccioUserInfo |
| |
|<------------------------------------------------------|
| |
. .
. .
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. "third-party" userRequest message from Alice:</span>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-user-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<ccmp:userRequest>
<userInfo entity="xcon-userid:AUTO_GENERATE_1@example.com">
<info:associated-aors>
<info:entry>
<info:uri>
mailto:Ciccio@example.com
</info:uri>
<info:display-text>email</info:display-text>
</info:entry>
</info:associated-aors>
<info:endpoint entity="sip:Ciccio@example.com"/>
</userInfo>
<span class="grey">Barnes, et al. Standards Track [Page 71]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
</ccmp:userRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. "third-party" userResponse message from the server:</span>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-user-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>create</operation>
<response-code>200</response-code>
<version>5</version>
<ccmp:userResponse>
<userInfo entity="xcon-userid:Ciccio@example.com">
<info:associated-aors>
<info:entry>
<info:uri>
mailto:Ciccio@example.com
</info:uri>
<info:display-text>email</info:display-text>
</info:entry>
</info:associated-aors>
<info:endpoint entity="sip:Ciccio@example.com"/>
</userInfo>
</ccmp:userResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 25: Alice Adds a New User to the Conference through CCMP
<span class="h3"><a class="selflink" id="section-6.8" href="#section-6.8">6.8</a>. Alice Asks for the CCMP Server Capabilities</span>
This section illustrates how Alice can discover which standard CCMP
messages and what extensions are supported by the CCMP server with
which she interacts through an optionsRequest/optionsResponse
transaction.
To prepare the optionsRequest, Alice just puts her XCON-USERID in the
<confUserID> parameter. Looking at the <options> element in the
received optionsResponse, Alice infers the following server
capabilities as regards standard CCMP messages:
<span class="grey">Barnes, et al. Standards Track [Page 72]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
o the server doesn't support sidebarsByValRequest nor the
sidebarByValRequest messages, since they do not appear in the
<standard-message-list>;
o the only implemented operation for the blueprintRequest message is
"retrieve", since no other <operation> entries are included in the
related <operations> field.
By analyzing the <extended-message-list>, Alice discovers the server
implements a bluePrint extension, referred to as "confSummaryRequest"
in this example. This extension allows Alice to recover via CCMP a
brief description of a specific conference; the XML elements involved
in this extended conference control transaction are available at the
URL indicated in the <schema-ref> element, and the only operation
provided by this extension is "retrieve". To better understand how
Alice can exploit the "confSummaryRequest" extension via CCMP, see
<a href="#section-6.9">Section 6.9</a>.
The figure below shows the optionsRequest/optionsResponse message
exchange between Alice and the CCMP server.
CCMP Client CCMP Server
| |
| CCMP optionsRequest message |
| - confUserID: Alice |
|------------------------------------------------------>|
| |
| CCMP userResponse message |
| - confUserID: Alice |
| - response-code: 200 |
| - options (list of both |
| standard and extended |
| supported messages) |
|<------------------------------------------------------|
| |
. .
. .
1. optionsRequest (Alice asks for CCMP server capabilities)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-options-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<span class="grey">Barnes, et al. Standards Track [Page 73]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
</ccmpRequest>
</ccmp:ccmpRequest>
2. optionsResponse (the server returns the list of its conference
control capabilities)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-options-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<response-code>200</response-code>
<response-string>success</response-string>
<ccmp:optionsResponse>
<options>
<standard-message-list>
<standard-message>
<name>blueprintsRequest</name>
</standard-message>
<standard-message>
<name>blueprintRequest</name>
<operations>
<operation>retrieve</operation>
</operations>
</standard-message>
<standard-message>
<name>confsRequest</name>
</standard-message>
<standard-message>
<name>confRequest</name>
</standard-message>
<standard-message>
<name>usersRequest</name>
</standard-message>
<standard-message>
<name>userRequest</name>
</standard-message>
<standard-message>
<name>sidebarsByRefRequest</name>
</standard-message>
<standard-message>
<name>sidebarByRefRequest</name>
</standard-message>
</standard-message-list>
<extended-message-list>
<span class="grey">Barnes, et al. Standards Track [Page 74]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<extended-message>
<name>confSummaryRequest</name>
<operations>
<operation>retrieve</operation>
</operations>
<schema-def>
http://example.com/ccmp-extension-schema.xsd
</schema-def>
<description>
confSummaryRequest is intended
to allow the requestor to retrieve
a brief description
of the conference indicated in the
confObjID request parameter
</description>
</extended-message>
</extended-message-list>
</options>
</ccmp:optionsResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 26: Alice Asks for the Server Control Capabilities
<span class="h3"><a class="selflink" id="section-6.9" href="#section-6.9">6.9</a>. Alice Makes Use of a CCMP Server Extension</span>
In this section, a very simple example of CCMP extension support is
provided. Alice can recover information about this and other server-
supported extensions by issuing an optionsRequest (see <a href="#section-6.8">Section 6.8</a>).
The extension in question is named "confSummaryRequest" and allows a
CCMP client to obtain from the CCMP server synthetic information
about a specific conference. The conference summary is carried in
the form of an XML element as follows:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://example.com/ccmp-extension"
xmlns="http://example.com/ccmp-extension">
<xs:element name="confSummary" type="conf-summary-type"/>
<xs:complexType name="conf-summary-type">
<xs:sequence>
<xs:element name="title" type="xs:string"/>
<xs:element name="status" type="xs:string"/>
<xs:element name="public" type="xs:boolean"/>
<xs:element name="media" type="xs:string"/>
<span class="grey">Barnes, et al. Standards Track [Page 75]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
</xs:sequence>
</xs:complexType>
</xs:schema>
Figure 27: Example of XML Schema defining an extension
parameter (ccmp-extension-schema.xsd)
As can be inferred from the schema file, the <confSummary> element
contains conference information related to the following:
o title
o status (active or registered)
o participation modality (if everyone is allowed to participate, the
boolean <public> element is set to "true")
o involved media
In order to retrieve a conference summary related to the conference
she participates in, Alice sends to the CCMP server an
extendedRequest with a "confSummaryRequest" <extensionName>,
specifying the conference XCON-URI in the confObjID request
parameter, as depicted in the figure below.
CCMP Client CCMP Server
| |
| CCMP extendedRequest message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: retrieve |
| - extensionName: confSummaryRequest |
|------------------------------------------------------>|
| |
| CCMP extendedResponse message |
| - confUserID: Alice |
| - confObjID: 8977794 |
| - operation: retrieve |
| - response-code: 200 |
| - extensionName: |
| confSummaryRequest |
| - confSummary |
|<------------------------------------------------------|
| |
. .
. .
<span class="grey">Barnes, et al. Standards Track [Page 76]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. extendedRequest (Alice makes use of the "confSummaryRequest")</span>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpRequest xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:example="http://example.com/ccmp-extension">
<ccmpRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-extended-request-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>retrieve</operation>
<ccmp:extendedRequest>
<extensionName>confRequestSummary</extensionName>
</ccmp:extendedRequest>
</ccmpRequest>
</ccmp:ccmpRequest>
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. extendedResponse (the server provides Alice with a brief description</span>
<span class="h2"> of the desired conference)</span>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ccmp:ccmpResponse xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:ccmp="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xcon="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:example="http://example.com/ccmp-extension">
<ccmpResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ccmp:ccmp-extended-response-message-type">
<confUserID>xcon-userid:alice@example.com</confUserID>
<confObjID>xcon:8977794@example.com</confObjID>
<operation>retrieve</operation>
<response-code>200</response-code>
<response-string>success</response-string>
<ccmp:extendedResponse>
<extensionName>confSummaryRequest</extensionName>
<example:confSummary>
<title> Alice's conference </title>
<status> active </status>
<public> true </public>
<media> audio </media>
</example:confSummary>
</ccmp:extendedResponse>
</ccmpResponse>
</ccmp:ccmpResponse>
Figure 28: Alice Exploits the 'confSummaryRequest' Extension
<span class="grey">Barnes, et al. Standards Track [Page 77]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Locating a Conference Server</span>
If a conferencing client is not pre-configured to use a specific
conference server for the requests, the client MUST first discover
the conference server before it can send any requests. The result of
the discovery process, is the address of the server supporting
conferencing. In this document, the result is an http: or https:
URI, which identifies a conference server.
DNS is RECOMMENDED to be used to locate a conference server in the
case that the client is not pre-configured to use a specific
conference server. URI-Enabled NAPTR (U-NAPTR) resolution for
conferencing takes a domain name as input and produces a URI that
identifies the conference server. This process also requires an
Application Service tag and an Application Protocol tag, which
differentiate conferencing-related NAPTR records from other records
for that domain.
<a href="#section-12.4.1">Section 12.4.1</a> defines an Application Service tag of "XCON", which is
used to identify the centralized conferencing (XCON) server for a
particular domain. The Application Protocol tag "CCMP", defined in
<a href="#section-12.4.2">Section 12.4.2</a>, is used to identify an XCON server that understands
CCMP.
The NAPTR records in the following example (Figure 29) demonstrate
the use of the Application Service and Application Protocol tags.
Iterative NAPTR resolution is used to delegate responsibility for the
conferencing service from "zonea.example.com." and
"zoneb.example.com." to "outsource.example.com.".
<span class="grey">Barnes, et al. Standards Track [Page 78]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-79" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
zonea.example.com.
;; order pref flags
IN NAPTR 100 10 "" "XCON-CCMP" ( ; service
"" ; regex
outsource.example.com. ; replacement
)
zoneb.example.com.
;; order pref flags
IN NAPTR 100 10 "" "XCON-CCMP" ( ; service
"" ; regex
outsource.example.com. ; replacement
)
outsource.example.com.
;; order pref flags
IN NAPTR 100 10 "u" "XCON-CCMP" ( ; service
"!*.!https://confs.example.com/!" ; regex
. ; replacement
)
Figure 29: Sample XCON-CCMP Service NAPTR Records
Details for the "XCON" Application Service tag and the "CCMP"
Application Protocol tag are included in <a href="#section-12.4">Section 12.4</a>.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Managing Notifications</span>
As per [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>], CCMP is one of the following four protocols, which
have been formally identified within the XCON framework:
Conference Control Protocol:
mediates between conference and media control client (conferencing
client) and conference server. This document describes such a
protocol.
Binary floor Control Protocol:
operates between the floor control client and the floor control
server. An example of such a protocol is the Binary Floor Control
Protocol (BFCP), specified in [<a href="./rfc4582" title=""The Binary Floor Control Protocol (BFCP)"">RFC4582</a>].
Call Signaling Protocol:
operates between the Call Signaling Client and the focus.
Examples of call signaling protocols include SIP, H.323 and IAX.
Such protocols are capable of negotiating a conferencing session.
<span class="grey">Barnes, et al. Standards Track [Page 79]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-80" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
Notification Protocol:
operates between the Notification Client and the XCON Notification
Service. This specification does not define a new notification
protocol. For clients that use SIP as the call signaling
protocol, the XCON event package [<a href="./rfc6502" title=""Conference Event Package Data Format Extension for Centralized Conferencing (XCON)"">RFC6502</a>] MUST be used by the
client for notifications of changes in the conference data as
described below.
The protocol specified in this document is a proactive one and is
used by a conferencing client to send requests to a conference server
in order to retrieve information about the conference objects stored
by the server and to possibly manipulate them. However, a complete
conferencing solution is not prohibited from providing clients with a
means for receiving asynchronous updates about the status of the
objects available at the server. The notification protocol, while
conceptually independent of all the mentioned companion protocols,
can nonetheless be chosen in a way that is consistent with the
overall protocol architecture characterizing a specific deployment,
as discussed in the following.
When the conferencing control client uses SIP [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] as the
signaling protocol to participate in the conference, SIP event
notification can be used. In such a case, the conferencing control
client MUST implement the conference event package for XCON
[<a href="./rfc6502" title=""Conference Event Package Data Format Extension for Centralized Conferencing (XCON)"">RFC6502</a>]. This is the default mechanism for conferencing clients as
is SIP for signaling per the XCON framework [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>].
In the case where the interface to the conference server is entirely
web based, there is a common mechanism for web-based systems that
could be used -- a "call back". With this mechanism, the
conferencing client provides the conference server with an HTTP URL
that is invoked when a change occurs. This is a common
implementation mechanism for e-commerce. This works well in the
scenarios whereby the conferencing client is a web server that
provides the graphical HTML user interface and uses CCMP as the back-
end interface to the conference server. This model can coexist with
the SIP event notification model. PC-based clients behind NATs could
provide a SIP event URI, whereas web-based clients using CCMP in the
back end would probably find the HTTP call back approach much easier.
The details of this approach are out of scope for CCMP; thus, we
expect a future specification will document this solution.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. HTTP Transport</span>
This section describes the use of HTTP [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>] and HTTP over TLS
[<a href="./rfc2818" title=""HTTP Over TLS"">RFC2818</a>] as transport mechanisms for CCMP, which a conforming
conference server and conferencing client MUST support.
<span class="grey">Barnes, et al. Standards Track [Page 80]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-81" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
Although CCMP uses HTTP as a transport, it uses a strict subset of
HTTP features, and due to the restrictions of some features, a
conferencing server might not be a fully compliant HTTP server. It
is intended that a conference server can easily be built using an
HTTP server with extensibility mechanisms, and that a conferencing
client can trivially use existing HTTP libraries. This subset of
requirements helps implementers avoid ambiguity with the many options
the full HTTP protocol offers.
Support of HTTP authentication [<a href="./rfc2617" title=""HTTP Authentication: Basic and Digest Access Authentication"">RFC2617</a>] and cookies [<a href="./rfc6265" title=""HTTP State Management Mechanism"">RFC6265</a>] is
OPTIONAL for a conferencing client that conforms to this
specification. These mechanisms are unnecessary because CCMP
requests carry their own authentication information (in the "subject"
field; see <a href="#section-5.1">Section 5.1</a>). A conferencing client SHOULD include
support for HTTP proxy authentication.
A CCMP request is carried in the body of an HTTP POST request. The
conferencing client MUST include a Host header in the request.
The MIME type of CCMP request and response bodies is "application/
ccmp+xml". The conference server and conferencing client MUST
provide this value in the HTTP Content-Type and Accept header fields.
If the conference server does not receive the appropriate Content-
Type and Accept header fields, the conference server SHOULD fail the
request, returning a 406 (Not Acceptable) response. CCMP responses
SHOULD include a Content-Length header.
Conferencing clients MUST NOT use the Expect header or the Range
header in CCMP requests. The conference server MAY return 501 (Not
Implemented) errors if either of these HTTP features are used. In
the case that the conference server receives a request from the
conferencing client containing an If-* (conditional) header, the
conference server SHOULD return a 412 (precondition failed) response.
The POST method is the only method REQUIRED for CCMP. If a
conference server chooses to support GET or HEAD, it SHOULD consider
the kind of application doing the GET. Since a conferencing client
only uses a POST method, the GET or HEAD MUST be either a URL that
was found outside its normal context (e.g., somebody found a URL in
protocol traces or log files and fed it into their browser) or
somebody is testing or debugging a system. The conference server
could provide information in the CCMP response indicating that the
URL corresponds to a conference server and only responds to CCMP POST
requests or the conference server could instead try to avoid any leak
of information by returning a very generic HTTP error message such as
405 (Method Not Allowed).
<span class="grey">Barnes, et al. Standards Track [Page 81]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-82" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
The conference server populates the HTTP headers of responses so that
they are consistent with the contents of the message. In particular,
the CacheControl header SHOULD be set to disable caching of any
conference information by HTTP intermediaries. Otherwise, there is
the risk of stale information and/or the unauthorized disclosure of
the information. The HTTP status code MUST indicate a 2xx series
response for all CCMP Response and Error messages.
The conference server MAY redirect a CCMP request. A conference
server MUST NOT include CCMP responses in a 3xx response. A
conferencing client MUST handle redirects by using the Location
header provided by the server in a 3xx response. When redirecting,
the conferencing client MUST observe the delay indicated by the
Retry-After header. The conferencing client MUST authenticate the
server that returns the redirect response before following the
redirect. A conferencing client SHOULD authenticate the conference
server indicated in a redirect.
The conference server SHOULD support persistent connections and
request pipelining. If pipelining is not supported, the conference
server MUST NOT allow persistent connections. The conference server
MUST support termination of a response by the closing of a
connection.
Implementations of CCMP that implement HTTP transport MUST implement
transport over TLS [<a href="./rfc2818" title=""HTTP Over TLS"">RFC2818</a>]. TLS provides message integrity and
confidentiality between the conferencing client and the conference
server. The conferencing client MUST implement the server
authentication method described in HTTPS [<a href="./rfc2818" title=""HTTP Over TLS"">RFC2818</a>]. The device uses
the URI obtained during conference server discovery to authenticate
the server. The details of this authentication method are provided
in <a href="#section-3.1">Section 3.1</a> of HTTPS [<a href="./rfc2818" title=""HTTP Over TLS"">RFC2818</a>]. When TLS is used, the
conferencing client SHOULD fail a request if server authentication
fails.
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Security Considerations</span>
As identified in the XCON framework [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>], there are a wide
variety of potential attacks related to conferencing, due to the
natural involvement of multiple endpoints and the capability to
manipulate the data on the conference server using CCMP. Examples of
attacks include the following: an endpoint attempting to listen to
conferences in which it is not authorized to participate, an endpoint
attempting to disconnect or mute other users, and an endpoint theft
of service in attempting to create conferences it is not allowed to
create.
<span class="grey">Barnes, et al. Standards Track [Page 82]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-83" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
The following summarizes the security considerations for CCMP:
1. The client MUST determine the proper conference server. The
conference server discovery is described in <a href="#section-7">Section 7</a>.
2. The client MUST connect to the proper conference server. The
mechanisms for addressing this security consideration are
described in <a href="#section-10.1">Section 10.1</a>.
3. The protocol MUST support a confidentiality and integrity
mechanism. As described in <a href="#section-9">Section 9</a>, implementations of CCMP
MUST implement the HTTP transport over TLS [<a href="./rfc2818" title=""HTTP Over TLS"">RFC2818</a>].
4. There are security issues associated with the authorization to
perform actions on the conferencing system to invoke specific
capabilities. A conference server SHOULD ensure that only
authorized entities can manipulate the conference data. The
mechanisms for addressing this security consideration are
described in <a href="#section-10.2">Section 10.2</a>.
5. The privacy and security of the identity of a user in the
conference MUST be assured. The mechanisms to ensure the
security and privacy of identity are discussed in <a href="#section-10.3">Section 10.3</a>.
6. A final issue is related to Denial-of-Service (DoS) attacks on
the conference server itself. The recommendations to minimize
the potential and impact of DoS attacks are discussed in
<a href="#section-10.4">Section 10.4</a>.
Of the considerations listed above, items 1 and 3 are addressed
within the referenced sections earlier in this document. The
remaining security considerations are addressed in detail in the
following sections.
<span class="h3"><a class="selflink" id="section-10.1" href="#section-10.1">10.1</a>. Assuring That the Proper Conference Server Has Been Contacted</span>
<a href="#section-7">Section 7</a> describes a mechanism using DNS by which a conferencing
client discovers a conference server. A primary concern is spoofed
DNS replies; thus, the use of DNS Security (DNSSEC) is RECOMMENDED to
ensure that the client receives a valid response from the DNS server
in cases where this is a concern.
When the CCMP transaction is conducted using TLS [<a href="./rfc5246" title=""The Transport Layer Security (TLS) Protocol Version 1.2"">RFC5246</a>], the
conference server can authenticate its identity, either as a domain
name or as an IP address, to the conferencing client by presenting a
certificate containing that identifier as a subjectAltName (i.e., as
an iPAddress or dNSName, respectively). Any implementation of CCMP
MUST be capable of being transacted over TLS so that the client can
<span class="grey">Barnes, et al. Standards Track [Page 83]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-84" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
request the above authentication. Note that, in order for the
presented certificate to be valid at the client, the client MUST be
able to validate the certificate following the procedures in
[<a href="./rfc2818" title=""HTTP Over TLS"">RFC2818</a>] in the case of HTTP as a transport. In particular, the
validation path of the certificate must end in one of the client's
trust anchors, even if that trust anchor is the conference server
certificate itself. If the client has external information as to the
expected identity or credentials of the proper conference server, the
authentication checks described above MAY be omitted.
<span class="h3"><a class="selflink" id="section-10.2" href="#section-10.2">10.2</a>. User Authentication and Authorization</span>
Many policy authorization decisions are based on the identity of the
user or the role that a user may have. The conference server MUST
implement mechanisms for authentication of users to validate their
identity. There are several ways that a user might authenticate its
identity to the system. For users joining a conference using one of
the call signaling protocols, the user authentication mechanisms for
the specific protocol can be used. For example, in the case of a
user joining the conference using SIP signaling, the user
authentication as defined in [<a href="./rfc3261" title=""SIP: Session Initiation Protocol"">RFC3261</a>] MUST be used. For the case of
users joining the conference using CCMP, the CCMP Request messages
provide a subject field that contains a username and password, which
can be used for authentication. Since the CCMP messages are
RECOMMENDED to be carried over TLS, this information can be sent
securely.
The XCON framework [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>] provides an overview of other
authorization mechanisms. In the cases where a user is authorized
via multiple mechanisms, it is RECOMMENDED that the conference server
associate the authorization of the CCMP interface with other
authorization mechanisms; for example, Public Switched Telephone
Network (PSTN) users that join with a PIN and control the conference
using CCMP. When a conference server presents the identity of
authorized users, it MAY provide information about the way the
identity was proven or verified by the system. A conference server
can also allow a completely unauthenticated user into the system --
this information SHOULD also be communicated to interested parties.
Once a user is authenticated and authorized through the various
mechanisms available on the conference server, the conference server
MUST allocate a conference user identifier (XCON-USERID) and SHOULD
associate the XCON-USERID with any signaling specific user
identifiers that were used for authentication and authorization.
This XCON-USERID can be provided to a specific user through the
conference notification interface and MUST be provided to users that
interact with the conferencing system using CCMP (i.e., in the
appropriate CCMP response messages). The XCON-USERIDs for each user/
<span class="grey">Barnes, et al. Standards Track [Page 84]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-85" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
participant in the conference are contained in the 'entity' attribute
in the <user> element in the conference object. The XCON-USERID is
REQUIRED for any subsequent operations by the user on the conference
object and is carried in the confUserID parameter in the CCMP
requests and responses.
Note that the policy management of an XCON-compliant conferencing
system is out of the scope of this document, as well as of the XCON
working group (WG). However, the specification of a policy
management framework is realizable with the overall XCON
architecture, in particular with regard to a Role-Based Access
Control (RBAC) approach. In RBAC, the following elements are
identified: (i) Users; (ii) Roles; (iii) Objects; (iv) Operations;
(v) Permissions. For all of the above elements, a direct mapping
exists onto the main XCON entities. As an example, RBAC objects map
onto XCON data model objects and RBAC operations map onto CCMP
operations.
Future documents can define an RBAC framework for XCON, by first
focusing on the definition of roles and then specifying the needed
permission policy sets and role policy sets (used to associate policy
permission sets with specific roles). With these policies in place,
access to a conference object compliant with the XCON data model can
be appropriately controlled. As far as assigning users to roles, the
Users in the RBAC model relate directly to the <users> element in the
conference object. The <users> element is comprised of <user>
elements representing a specific user in the conferencing system.
Each <user> element contains an 'entity' attribute with the XCON-
USERID and a <role> element. Thus, each authorized user (as
represented by an XCON-USERID) can be associated with a <role>
element.
<span class="h3"><a class="selflink" id="section-10.3" href="#section-10.3">10.3</a>. Security and Privacy of Identity</span>
An overview of the required privacy and anonymity for users of a
conferencing system are provided in the XCON framework [<a href="./rfc5239" title=""A Framework for Centralized Conferencing"">RFC5239</a>].
The security of the identity in the form of the XCON-USERID is
provided in CCMP through the use of TLS.
The conference server SHOULD support the mechanism to ensure the
privacy of the XCON-USERID. The conferencing client indicates the
desired level of privacy by manipulation of the <provide-anonymity>
element defined in the XCON data model [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>]. The <provide-
anonymity> element controls the degree to which a user reveals their
identity. The following summarizes the values for the <provide-
anonymity> element that the client includes in their requests:
<span class="grey">Barnes, et al. Standards Track [Page 85]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-86" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
"hidden": Ensures that other participants are not aware that there
is an additional participant (i.e., the user issuing the request)
in the conference. This could be used in cases of users that are
authorized with a special role in a conference (e.g., a supervisor
in a call center environment).
"anonymous": Ensures that other participants are aware that there
is another participant (i.e., the user issuing the request);
however, the other participants are not provided information as to
the identity of the user.
"semi-private": Ensures that the user's identity is only to be
revealed to other participants or users that have a higher-level
authorization (e.g., a conferencing system can be configured such
that a human administrator can see all users).
If the client desires privacy, the conferencing client SHOULD include
the <provide-anonymity> element in the <confInfo> parameter in a CCMP
confRequest message with an <operation> parameter of "update" or
"create" or in the <userInfo> parameter in a CCMP userRequest message
with an <operation> parameter of "update" or "create". If the
<provide-anonymity> element is not included in the conference object,
then other users can see the participant's identity. Participants
are made aware of other participants that are "anonymous" or "semi-
private" when they perform subsequent operations on the conference
object or retrieve the conference object or when they receive
subsequent notifications.
Note that independent of the level of anonymity requested by the
user, the identity of the user is always known by the conferencing
system as that is required to perform the necessary authorization as
described in <a href="#section-10.2">Section 10.2</a>. The degree to which human administrators
can see the information can be controlled using policies (e.g., some
information in the data model can be hidden from human
administrators).
<span class="h3"><a class="selflink" id="section-10.4" href="#section-10.4">10.4</a>. Mitigating DoS Attacks</span>
[<a id="ref-RFC4732">RFC4732</a>] provides an overview of possible DoS attacks. In order to
minimize the potential for DoS attacks, it is RECOMMENDED that
conferencing systems require user authentication and authorization
for any client participating in a conference. This can be
accomplished through the use of the mechanisms described in
<a href="#section-10.2">Section 10.2</a>, as well as by using the security mechanisms associated
with the specific signaling (e.g., Session Initiation Protocol Secure
(SIPS)) and media protocols (e.g., Secure Realtime Transport Protocol
(SRTP)). In addition, <a href="#section-4.4">Section 4.4</a> describes the use of a timer
mechanism to alleviate the situation whereby CCMP messages pend
<span class="grey">Barnes, et al. Standards Track [Page 86]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-87" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
indefinitely, thus increasing the potential that pending requests
continue to increase when is a server is receiving more requests than
it can process.
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. XML Schema</span>
This section gives the XML schema definition
[<a href="#ref-W3C.REC-xmlschema-1-20041028">W3C.REC-xmlschema-1-20041028</a>] [<a href="#ref-W3C.REC-xmlschema-2-20041028">W3C.REC-xmlschema-2-20041028</a>] of the
"application/ccmp+xml" format. This is presented as a formal
definition of the "application/ccmp+xml" format. A new XML
namespace, a new XML schema, and the MIME type for this schema are
registered with IANA as described in <a href="#section-12">Section 12</a>. Note that this XML
Schema Definition is not intended to be used with on-the-fly
validation of the presence XML document. Whitespaces are included in
the schema to conform to the line length restrictions of the RFC
format without having a negative impact on the readability of the
document. Any conforming processor should remove leading and
trailing white spaces.
<?xml version="1.0" encoding="utf-8"?>
<xs:schema
targetNamespace="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:tns="urn:ietf:params:xml:ns:xcon-ccmp"
xmlns:dm="urn:ietf:params:xml:ns:xcon-conference-info"
xmlns:info="urn:ietf:params:xml:ns:conference-info"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="urn:ietf:params:xml:ns:xcon-conference-info"
schemaLocation="DataModel.xsd"/>
<xs:import namespace="urn:ietf:params:xml:ns:conference-info"
schemaLocation="<a href="./rfc4575">rfc4575</a>.xsd"/>
<xs:element name="ccmpRequest" type="ccmp-request-type" />
<xs:element name="ccmpResponse" type="ccmp-response-type" />
<!-- CCMP request definition -->
<xs:complexType name="ccmp-request-type">
<xs:sequence>
<xs:element name="ccmpRequest"
type="ccmp-request-message-type" />
</xs:sequence>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 87]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-88" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- ccmp-request-message-type -->
<xs:complexType abstract="true"
name="ccmp-request-message-type">
<xs:sequence>
<xs:element name="subject" type="subject-type"
minOccurs="0" maxOccurs="1" />
<xs:element name="confUserID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="confObjID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="operation" type="operationType"
minOccurs="0" maxOccurs="1" />
<xs:element name="conference-password" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- CCMP response definition -->
<xs:complexType name="ccmp-response-type">
<xs:sequence>
<xs:element name="ccmpResponse"
type="ccmp-response-message-type" />
</xs:sequence>
</xs:complexType>
<!-- ccmp-response-message-type -->
<xs:complexType abstract="true" name="ccmp-response-message-type">
<xs:sequence>
<xs:element name="confUserID" type="xs:string"
minOccurs="1" maxOccurs="1" />
<xs:element name="confObjID" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="operation" type="operationType"
minOccurs="0"
maxOccurs="1" />
<xs:element name="response-code"
type="response-codeType"
minOccurs="1" maxOccurs="1" />
<xs:element name="response-string" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="version" type="xs:positiveInteger"
minOccurs="0" maxOccurs="1" />
<span class="grey">Barnes, et al. Standards Track [Page 88]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-89" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- CCMP REQUESTS -->
<!-- blueprintsRequest -->
<xs:complexType name="ccmp-blueprints-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="blueprintsRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintsRequestType -->
<xs:element name="blueprintsRequest" type="blueprintsRequestType"/>
<xs:complexType name="blueprintsRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- blueprintRequest -->
<xs:complexType name="ccmp-blueprint-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="blueprintRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 89]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-90" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- blueprintRequestType -->
<xs:element name="blueprintRequest" type="blueprintRequestType" />
<xs:complexType name="blueprintRequestType">
<xs:sequence>
<xs:element name="blueprintInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confsRequest -->
<xs:complexType name="ccmp-confs-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="confsRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confsRequestType -->
<xs:element name="confsRequest" type="confsRequestType" />
<xs:complexType name="confsRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confRequest -->
<xs:complexType name="ccmp-conf-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="confRequest" />
</xs:sequence>
</xs:extension>
<span class="grey">Barnes, et al. Standards Track [Page 90]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-91" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
</xs:complexContent>
</xs:complexType>
<!-- confRequestType -->
<xs:element name="confRequest" type="confRequestType" />
<xs:complexType name="confRequestType">
<xs:sequence>
<xs:element name="confInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- usersRequest -->
<xs:complexType name="ccmp-users-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="usersRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- usersRequestType -->
<xs:element name="usersRequest" type="usersRequestType" />
<xs:complexType name="usersRequestType">
<xs:sequence>
<xs:element name="usersInfo" type="info:users-type"
minOccurs="0" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- userRequest -->
<xs:complexType name="ccmp-user-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<span class="grey">Barnes, et al. Standards Track [Page 91]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-92" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<xs:sequence>
<xs:element ref="userRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- userRequestType -->
<xs:element name="userRequest" type="userRequestType" />
<xs:complexType name="userRequestType">
<xs:sequence>
<xs:element name="userInfo" type="info:user-type"
minOccurs="0" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByValRequest -->
<xs:complexType name="ccmp-sidebarsByVal-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarsByValRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByValRequestType -->
<xs:element name="sidebarsByValRequest"
type="sidebarsByValRequestType" />
<xs:complexType name="sidebarsByValRequestType">
<xs:sequence>
<xs:element name="xpathFilter"
type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 92]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-93" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarsByRefRequest -->
<xs:complexType name="ccmp-sidebarsByRef-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarsByRefRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByRefRequestType -->
<xs:element name="sidebarsByRefRequest"
type="sidebarsByRefRequestType" />
<xs:complexType name="sidebarsByRefRequestType">
<xs:sequence>
<xs:element name="xpathFilter" type="xs:string"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByValRequest -->
<xs:complexType name="ccmp-sidebarByVal-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarByValRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByValRequestType -->
<xs:element name="sidebarByValRequest"
type="sidebarByValRequestType"/>
<xs:complexType name="sidebarByValRequestType">
<xs:sequence>
<xs:element name="sidebarByValInfo"
type="info:conference-type" minOccurs="0"/>
<span class="grey">Barnes, et al. Standards Track [Page 93]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-94" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByRefRequest -->
<xs:complexType name="ccmp-sidebarByRef-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="sidebarByRefRequest" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByRefRequestType -->
<xs:element name="sidebarByRefRequest"
type="sidebarByRefRequestType" />
<xs:complexType name="sidebarByRefRequestType">
<xs:sequence>
<xs:element name="sidebarByRefInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- extendedRequest -->
<xs:complexType name="ccmp-extended-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
<xs:sequence>
<xs:element ref="extendedRequest"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 94]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-95" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- extendedRequestType -->
<xs:element name="extendedRequest" type="extendedRequestType"/>
<xs:complexType name="extendedRequestType">
<xs:sequence>
<xs:element name="extensionName"
type="xs:string" minOccurs="1"/>
<xs:any namespace="##other" processContents="lax" minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!-- optionsRequest -->
<xs:complexType name="ccmp-options-request-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-request-message-type">
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- CCMP RESPONSES -->
<!-- blueprintsResponse -->
<xs:complexType name="ccmp-blueprints-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="blueprintsResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintsResponseType -->
<xs:element name="blueprintsResponse" type="blueprintsResponseType"/>
<xs:complexType name="blueprintsResponseType">
<xs:sequence>
<xs:element name="blueprintsInfo" type="info:uris-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<span class="grey">Barnes, et al. Standards Track [Page 95]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-96" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- blueprintResponse -->
<xs:complexType name="ccmp-blueprint-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="blueprintResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- blueprintResponseType -->
<xs:element name="blueprintResponse" type="blueprintResponseType"/>
<xs:complexType name="blueprintResponseType">
<xs:sequence>
<xs:element name="blueprintInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confsResponse -->
<xs:complexType name="ccmp-confs-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="confsResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confsResponseType -->
<xs:element name="confsResponse" type="confsResponseType" />
<xs:complexType name="confsResponseType">
<xs:sequence>
<xs:element name="confsInfo" type="info:uris-type"
<span class="grey">Barnes, et al. Standards Track [Page 96]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-97" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- confResponse -->
<xs:complexType name="ccmp-conf-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="confResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- confResponseType -->
<xs:element name="confResponse" type="confResponseType" />
<xs:complexType name="confResponseType">
<xs:sequence>
<xs:element name="confInfo" type="info:conference-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- usersResponse -->
<xs:complexType name="ccmp-users-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="usersResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 97]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-98" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- usersResponseType -->
<xs:element name="usersResponse" type="usersResponseType" />
<xs:complexType name="usersResponseType">
<xs:sequence>
<xs:element name="usersInfo" type="info:users-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- userResponse -->
<xs:complexType name="ccmp-user-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="userResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- userResponseType -->
<xs:element name="userResponse" type="userResponseType" />
<xs:complexType name="userResponseType">
<xs:sequence>
<xs:element name="userInfo" type="info:user-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByValResponse -->
<xs:complexType name="ccmp-sidebarsByVal-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarsByValResponse" />
</xs:sequence>
<span class="grey">Barnes, et al. Standards Track [Page 98]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-99" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByValResponseType -->
<xs:element name="sidebarsByValResponse"
type="sidebarsByValResponseType" />
<xs:complexType name="sidebarsByValResponseType">
<xs:sequence>
<xs:element name="sidebarsByValInfo"
type="info:sidebars-by-val-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarsByRefResponse -->
<xs:complexType name="ccmp-sidebarsByRef-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarsByRefResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarsByRefResponseType -->
<xs:element name="sidebarsByRefResponse"
type="sidebarsByRefResponseType" />
<xs:complexType name="sidebarsByRefResponseType">
<xs:sequence>
<xs:element name="sidebarsByRefInfo" type="info:uris-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 99]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-100" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- sidebarByValResponse -->
<xs:complexType name="ccmp-sidebarByVal-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarByValResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByValResponseType -->
<xs:element name="sidebarByValResponse"
type="sidebarByValResponseType" />
<xs:complexType name="sidebarByValResponseType">
<xs:sequence>
<xs:element name="sidebarByValInfo"
type="info:conference-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- sidebarByRefResponse -->
<xs:complexType name="ccmp-sidebarByRef-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="sidebarByRefResponse" />
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- sidebarByRefResponseType -->
<xs:element name="sidebarByRefResponse"
type="sidebarByRefResponseType" />
<xs:complexType name="sidebarByRefResponseType">
<xs:sequence>
<xs:element name="sidebarByRefInfo"
type="info:conference-type" minOccurs="0"/>
<span class="grey">Barnes, et al. Standards Track [Page 100]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-101" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- extendedResponse -->
<xs:complexType name="ccmp-extended-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="extendedResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- extendedResponseType -->
<xs:element name="extendedResponse" type="extendedResponseType"/>
<xs:complexType name="extendedResponseType">
<xs:sequence>
<xs:element name="extensionName"
type="xs:string" minOccurs="1"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<!-- optionsResponse -->
<xs:complexType name="ccmp-options-response-message-type">
<xs:complexContent>
<xs:extension base="tns:ccmp-response-message-type">
<xs:sequence>
<xs:element ref="optionsResponse"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<!-- optionsResponseType -->
<xs:element name="optionsResponse"
type="optionsResponseType" />
<span class="grey">Barnes, et al. Standards Track [Page 101]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-102" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<xs:complexType name="optionsResponseType">
<xs:sequence>
<xs:element name="options"
type="options-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- CCMP ELEMENT TYPES -->
<!-- response-codeType-->
<xs:simpleType name="response-codeType">
<xs:restriction base="xs:positiveInteger">
<xs:pattern value="[0-9][0-9][0-9]" />
</xs:restriction>
</xs:simpleType>
<!-- operationType -->
<xs:simpleType name="operationType">
<xs:restriction base="xs:token">
<xs:enumeration value="retrieve"/>
<xs:enumeration value="create"/>
<xs:enumeration value="update"/>
<xs:enumeration value="delete"/>
</xs:restriction>
</xs:simpleType>
<!-- subject-type -->
<xs:complexType name="subject-type">
<xs:sequence>
<xs:element name="username" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:element name="password" type="xs:string"
minOccurs="0" maxOccurs="1" />
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 102]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-103" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- options-type -->
<xs:complexType name="options-type">
<xs:sequence>
<xs:element name="standard-message-list"
type="standard-message-list-type"
minOccurs="1"/>
<xs:element name="extended-message-list"
type="extended-message-list-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-list-type -->
<xs:complexType name="standard-message-list-type">
<xs:sequence>
<xs:element name="standard-message"
type="standard-message-type"
minOccurs="1" maxOccurs="10"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- standard-message-type -->
<xs:complexType name="standard-message-type">
<xs:sequence>
<xs:element name="name"
type="standard-message-name-type"
minOccurs="1"/>
<xs:element name="operations"
type="operations-type"
minOccurs="0"/>
<xs:element name="schema-def" type="xs:string" minOccurs="0"/>
<xs:element name="description" type="xs:string" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<span class="grey">Barnes, et al. Standards Track [Page 103]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-104" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<!-- standard-message-name-type -->
<xs:simpleType name="standard-message-name-type">
<xs:restriction base="xs:token">
<xs:enumeration value="confsRequest"/>
<xs:enumeration value="confRequest"/>
<xs:enumeration value="blueprintsRequest"/>
<xs:enumeration value="blueprintRequest"/>
<xs:enumeration value="usersRequest"/>
<xs:enumeration value="userRequest"/>
<xs:enumeration value="sidebarsByValRequest"/>
<xs:enumeration value="sidebarByValRequest"/>
<xs:enumeration value="sidebarsByRefRequest"/>
<xs:enumeration value="sidebarByRefRequest"/>
</xs:restriction>
</xs:simpleType>
<!-- operations-type -->
<xs:complexType name="operations-type">
<xs:sequence>
<xs:element name="operation" type="operationType"
minOccurs="1" maxOccurs="4"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- extended-message-list-type -->
<xs:complexType name="extended-message-list-type">
<xs:sequence>
<xs:element name="extended-message"
type="extended-message-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
<!-- extended-message-type -->
<xs:complexType name="extended-message-type">
<xs:sequence>
<xs:element name="name" type="xs:string" />
<xs:element name="operations"
type="operations-type"
minOccurs="0"/>
<span class="grey">Barnes, et al. Standards Track [Page 104]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-105" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<xs:element name="schema-def" type="xs:string" />
<xs:element name="description"
type="xs:string"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##any" processContents="lax"/>
</xs:complexType>
</xs:schema>
Figure 30: CCMP XML Schema
<span class="h2"><a class="selflink" id="section-12" href="#section-12">12</a>. IANA Considerations</span>
This document registers a new XML namespace, a new XML schema, and
the MIME type for the schema. This document also registers the
"XCON" Application Service tag and the "CCMP" Application Protocol
tag and defines registries for the CCMP operation types and response
codes.
<span class="h3"><a class="selflink" id="section-12.1" href="#section-12.1">12.1</a>. URN Sub-Namespace Registration</span>
This section registers a new XML namespace,
"urn:ietf:params:xml:ns:xcon-ccmp".
URI: urn:ietf:params:xml:ns:xcon-ccmp
Registrant Contact: IETF XCON working group (xcon@ietf.org), Mary
Barnes (mary.ietf.barnes@gmail.com).
<span class="grey">Barnes, et al. Standards Track [Page 105]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-106" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
XML:
BEGIN
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"<a href="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd</a>">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>CCMP Messages</title>
</head>
<body>
<h1>Namespace for CCMP Messages</h1>
<h2>urn:ietf:params:xml:ns:xcon-ccmp</h2>
<p>See <a href="http://www.rfc-editor.org/rfc/rfc6503.txt">
<a href="./rfc6503">RFC 6503</a></a>.</p>
</body>
</html>
END
<span class="h3"><a class="selflink" id="section-12.2" href="#section-12.2">12.2</a>. XML Schema Registration</span>
This section registers an XML schema per the guidelines in [<a href="./rfc3688" title=""The IETF XML Registry"">RFC3688</a>].
URI: urn:ietf:params:xml:schema:xcon-ccmp
Registrant Contact: IETF XCON working group (xcon@ietf.org), Mary
Barnes (mary.ietf.barnes@gmail.com).
Schema: The XML for this schema can be found as the entirety of
<a href="#section-11">Section 11</a> of this document.
<span class="h3"><a class="selflink" id="section-12.3" href="#section-12.3">12.3</a>. MIME Media Type Registration for 'application/ccmp+xml'</span>
This section registers the "application/ccmp+xml" MIME type.
To: ietf-types@iana.org
Subject: Registration of MIME media type application/ccmp+xml
MIME media type name: application
MIME subtype name: ccmp+xml
Required parameters: (none)
<span class="grey">Barnes, et al. Standards Track [Page 106]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-107" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
Optional parameters: charset
Same as the charset parameter of "application/xml" as specified in
<a href="./rfc3023#section-3.2">[RFC3023], Section 3.2</a>.
Encoding considerations: Same as the encoding considerations of
"application/xml" as specified in <a href="./rfc3023#section-3.2">[RFC3023], Section 3.2</a>.
Security considerations: This content type is designed to carry
protocol data related to conference control. Some of the data
could be considered private. This media type does not provide any
protection and thus other mechanisms such as those described in
<a href="#section-10">Section 10</a> are required to protect the data. This media type does
not contain executable content.
Interoperability considerations: None.
Published specification: <a href="./rfc6503">RFC 6503</a>.
Applications that use this media type: Centralized Conferencing
control clients and servers.
Additional Information: Magic Number(s): (none)
File extension(s): .ccmp
Macintosh File Type Code(s): TEXT
Person & email address to contact for further information: Mary
Barnes <mary.ietf.barnes@gmail.com>
Intended usage: LIMITED USE
Author/Change controller: The IETF
Other information: This media type is a specialization of
application/xml [<a href="./rfc3023" title=""XML Media Types"">RFC3023</a>], and many of the considerations
described there also apply to application/ccmp+xml.
<span class="h3"><a class="selflink" id="section-12.4" href="#section-12.4">12.4</a>. DNS Registrations</span>
<a href="#section-12.4.1">Section 12.4.1</a> defines an Application Service tag of "XCON", which is
used to identify the centralized conferencing (XCON) server for a
particular domain. The Application Protocol tag "CCMP", defined in
<a href="#section-12.4.2">Section 12.4.2</a>, is used to identify an XCON server that understands
CCMP.
<span class="grey">Barnes, et al. Standards Track [Page 107]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-108" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h4"><a class="selflink" id="section-12.4.1" href="#section-12.4.1">12.4.1</a>. Registration of a Conference Server Application Service Tag</span>
This section registers a new S-NAPTR/U-NAPTR Application Service tag
for XCON, as mandated by [<a href="./rfc3958" title=""Domain-Based Application Service Location Using SRV RRs and the Dynamic Delegation Discovery Service (DDDS)"">RFC3958</a>].
Application Service Tag: XCON
Intended usage: Identifies a server that supports centralized
conferencing.
Defining publication: <a href="./rfc6503">RFC 6503</a>
Contact information: The authors of this document
Author/Change controller: The IESG
<span class="h4"><a class="selflink" id="section-12.4.2" href="#section-12.4.2">12.4.2</a>. Registration of a Conference Server Application Protocol Tag</span>
<span class="h4"> for CCMP</span>
This section registers a new S-NAPTR/U-NAPTR Application Protocol tag
for CCMP, as mandated by [<a href="./rfc3958" title=""Domain-Based Application Service Location Using SRV RRs and the Dynamic Delegation Discovery Service (DDDS)"">RFC3958</a>].
Application Service Tag: CCMP
Intended Usage: Identifies the Centralized Conferencing (XCON)
Manipulation Protocol.
Applicable Service Tag(s): XCON
Terminal NAPTR Record Type(s): U
Defining Publication: <a href="./rfc6503">RFC 6503</a>
Contact Information: The authors of this document
Author/Change Controller: The IESG
<span class="h3"><a class="selflink" id="section-12.5" href="#section-12.5">12.5</a>. CCMP Protocol Registry</span>
The IANA has created a new registry for CCMP:
<a href="http://www.iana.org/assignments/ccmp-parameters">http://www.iana.org/assignments/ccmp-parameters</a>. The document
creates initial sub-registries for CCMP operation types and response
codes.
<span class="grey">Barnes, et al. Standards Track [Page 108]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-109" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h4"><a class="selflink" id="section-12.5.1" href="#section-12.5.1">12.5.1</a>. CCMP Message Types</span>
The following summarizes the registry for CCMP messages:
Related Registry: CCMP Message Types Registry
Defining RFC: <a href="./rfc6503">RFC 6503</a>.
Registration/Assignment Procedures: Following the policies outlined
in [<a href="./rfc5226" title="">RFC5226</a>], the IANA policy for assigning new values for the
CCMP message types for CCMP is Specification Required.
Registrant Contact: IETF XCON working group (xcon@ietf.org), Mary
Barnes (mary.ietf.barnes@gmail.com).
This specification establishes the Message sub-registry under
<a href="http://www.iana.org/assignments/ccmp-messages">http://www.iana.org/assignments/ccmp-messages</a>. The initial Message
table is populated using the CCMP messages described in <a href="#section-4.1">Section 4.1</a>
and defined in the XML schema in <a href="#section-11">Section 11</a>.
Message Description Reference
------- ----------- ---------
optionsRequest Used by a conferencing client [<a href="./rfc6503">RFC6503</a>]
to query a conference server for
its capabilities, in terms of
supported messages.
optionsResponse Returns a list of CCMP messages [<a href="./rfc6503">RFC6503</a>]
supported by the specific
conference server.
blueprintsRequest Used by a conferencing client [<a href="./rfc6503">RFC6503</a>]
to query a conference server for
its capabilities, in terms of
available conference blueprints.
blueprintsResponse Returns a list of blueprints supported [<a href="./rfc6503">RFC6503</a>]
by the specific conference server.
blueprintRequest Sent to retrieve the conference object [<a href="./rfc6503">RFC6503</a>]
associated with a specific blueprint.
blueprintResponse Returns the conference object [<a href="./rfc6503">RFC6503</a>]
associated with a specific blueprint.
confsRequest Used by a conferencing client [<a href="./rfc6503">RFC6503</a>]
to query a conference server for
its scheduled/active conferences.
<span class="grey">Barnes, et al. Standards Track [Page 109]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-110" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
confsResponse Returns the list of the currently [<a href="./rfc6503">RFC6503</a>]
activated/scheduled conferences
at the server.
confRequest Used to create a conference object [<a href="./rfc6503">RFC6503</a>]
and/or to request an operation on
the conference object as a whole.
confResponse Indicates the result of the operation [<a href="./rfc6503">RFC6503</a>]
on the conference object as a whole.
userRequest Used to request an operation on the [<a href="./rfc6503">RFC6503</a>]
<user> element in the conference object.
userResponse Indicates the result of the requested [<a href="./rfc6503">RFC6503</a>]
operation on the <user> element in
the conference object.
usersRequest Used to manipulate the <users> element [<a href="./rfc6503">RFC6503</a>]
in the conference object, including
parameters such as the <allowed-users-list>,
<join-handling>, etc.
usersResponse Indicates the result of the request [<a href="./rfc6503">RFC6503</a>]
to manipulate the <users> element in
the conference object.
sidebarsByValRequest Used to retrieve the <sidebars-by-val> [<a href="./rfc6503">RFC6503</a>]
element of the target conference object.
sidebarsByValResponse Returns the list of the sidebar-by-val [<a href="./rfc6503">RFC6503</a>]
conferences within the target
conference object.
sidebarsByRefRequest Used to retrieve the <sidebars-by-ref> [<a href="./rfc6503">RFC6503</a>]
element of the target conference
object.
sidebarsByRefResponse Returns the list of the sidebar-by-ref [<a href="./rfc6503">RFC6503</a>]
conferences associated with the target
conference object.
sidebarByValRequest Used to request an operation on a [<a href="./rfc6503">RFC6503</a>]
sidebar-by-val conference.
sidebarByValResponse Indicates the result of the request to [<a href="./rfc6503">RFC6503</a>]
manipulate a sidebar-by-val conference.
<span class="grey">Barnes, et al. Standards Track [Page 110]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-111" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
sidebarByRefRequest Used to request an operation on a [<a href="./rfc6503">RFC6503</a>]
sideber-by-ref conference.
sidebarByRefResponse Indicates the result of the request to [<a href="./rfc6503">RFC6503</a>]
manipulate a sidebar-by-ref conference.
<span class="h4"><a class="selflink" id="section-12.5.2" href="#section-12.5.2">12.5.2</a>. CCMP Response Codes</span>
The following summarizes the requested registry for CCMP response
codes:
Related Registry: CCMP Response Code Registry
Defining RFC: <a href="./rfc6503">RFC 6503</a>.
Registration/Assignment Procedures: Following the policies outlined
in [<a href="./rfc5226" title="">RFC5226</a>], the IANA policy for assigning new values for the
Response codes for CCMP shall be Specification Required.
Registrant Contact: IETF XCON working group (xcon@ietf.org), Mary
Barnes (mary.ietf.barnes@gmail.com).
This specification establishes the Response-code sub-registry under
<a href="http://www.iana.org/assignments/ccmp-parameters">http://www.iana.org/assignments/ccmp-parameters</a>. The initial
Response-code table is populated using the Response codes defined in
<a href="#section-5.4">Section 5.4</a> as follows:
Default
Response
Number String Description Reference
------ ------------- ------------ ---------
200 Success The request was successfully [<a href="./rfc6503">RFC6503</a>]
processed.
400 Bad Request The request was badly formed in [<a href="./rfc6503">RFC6503</a>]
some fashion.
401 Unauthorized The user was not authorized for [<a href="./rfc6503">RFC6503</a>]
the specific operation on the
conference object.
403 Forbidden The specific operation is not [<a href="./rfc6503">RFC6503</a>]
valid for the target conference
object.
404 Object Not Found The specific conference object [<a href="./rfc6503">RFC6503</a>]
was not found.
<span class="grey">Barnes, et al. Standards Track [Page 111]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-112" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
409 Conflict A requested operation cannot be [<a href="./rfc6503">RFC6503</a>]
successfully completed by the
server. For example, the
modification of an object
cannot be applied because
the client version of the object
is obsolete and the requested
modifications collide with the
up-to-date state of the object
stored at the server.
420 User Not Found The user who is the target of the [<a href="./rfc6503">RFC6503</a>]
requested operation is unknown.
421 Invalid confUserID The <confUserID> parameter of the [<a href="./rfc6503">RFC6503</a>]
sender in the request is invalid.
422 Invalid Conference A request to access/manipulate [<a href="./rfc6503">RFC6503</a>]
Password a password-protected conference
object contained an invalid
<conference-password> parameter.
423 Conference Password A request to access/manipulate [<a href="./rfc6503">RFC6503</a>]
Required a password-protected conference
object did not contain a
<conference-password> parameter.
424 Authentication The server wants to authenticate [<a href="./rfc6503">RFC6503</a>]
Required the request through the <subject>
parameter but the parameter is
not provided in the request.
425 Forbidden Delete The conferencing system cannot [<a href="./rfc6503">RFC6503</a>]
Parent delete the specific conference
object because it is a
parent for another conference object.
426 Forbidden Change The target conference object [<a href="./rfc6503">RFC6503</a>]
Protected cannot be changed (e.g., due to
policies, roles or privileges).
427 Invalid Domain Name The domain name in an [<a href="./rfc6503">RFC6503</a>]
AUTO_GENERATE_X
instance in the conference object
is not within the conference
server's domain of responsibility.
<span class="grey">Barnes, et al. Standards Track [Page 112]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-113" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
500 Server Internal The conference server experienced [<a href="./rfc6503">RFC6503</a>]
Error some sort of internal error.
501 Not Implemented The specific operation is not [<a href="./rfc6503">RFC6503</a>]
implemented on the conferencing
system.
510 Request Timeout The request could not be [<a href="./rfc6503">RFC6503</a>]
processed within a reasonable
time (as specified by the
conferencing system).
511 Resources Not The conference server cannot [<a href="./rfc6503">RFC6503</a>]
Available execute a command because of
resource issues, e.g., it cannot
create a conference because
the system has reached its limits
on the number of conferences.
<span class="h2"><a class="selflink" id="section-13" href="#section-13">13</a>. Acknowledgments</span>
The authors appreciate the feedback provided by Dave Morgan, Pierre
Tane, Lorenzo Miniero, Tobia Castaldi, Theo Zourzouvillys, Sean
Duddy, Oscar Novo, Richard Barnes, Simo Veikkolainen, Keith Drage,
Peter Reissner, Tony Lindstrom, Stephen Kent (secdir review), Brian
Carpenter (genart review), and Mykyta Yevstifeyev (IANA
considerations). Special thanks go to Roberta Presta for her
invaluable contribution to this document. Roberta has worked on the
specification of CCMP at the University of Napoli for the preparation
of her Master thesis. She has also implemented the CCMP prototype
used for the trials and from which the dumps provided in <a href="#section-6">Section 6</a>
have been extracted.
<span class="h2"><a class="selflink" id="section-14" href="#section-14">14</a>. References</span>
<span class="h3"><a class="selflink" id="section-14.1" href="#section-14.1">14.1</a>. Normative References</span>
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
[<a id="ref-RFC2616">RFC2616</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.
[<a id="ref-RFC2617">RFC2617</a>] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
Leach, P., Luotonen, A., and L. Stewart, "HTTP
Authentication: Basic and Digest Access Authentication",
<a href="./rfc2617">RFC 2617</a>, June 1999.
<span class="grey">Barnes, et al. Standards Track [Page 113]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-114" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
[<a id="ref-RFC2818">RFC2818</a>] Rescorla, E., "HTTP Over TLS", <a href="./rfc2818">RFC 2818</a>, May 2000.
[<a id="ref-RFC3688">RFC3688</a>] Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
January 2004.
[<a id="ref-RFC5239">RFC5239</a>] Barnes, M., Boulton, C., and O. Levin, "A Framework for
Centralized Conferencing", <a href="./rfc5239">RFC 5239</a>, June 2008.
[<a id="ref-RFC5246">RFC5246</a>] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", <a href="./rfc5246">RFC 5246</a>, August 2008.
[<a id="ref-RFC6265">RFC6265</a>] Barth, A., "HTTP State Management Mechanism", <a href="./rfc6265">RFC 6265</a>,
April 2011.
[<a id="ref-RFC6501">RFC6501</a>] Novo, O., Camarillo, G., Morgan, D., and J. Urpalainen,
"Conference Information Data Model for Centralized
Conferencing (XCON)", <a href="./rfc6501">RFC 6501</a>, March 2012.
[<a id="ref-W3C.REC-xmlschema-1-20041028">W3C.REC-xmlschema-1-20041028</a>]
Beech, D., Thompson, H., Mendelsohn, N., and M. Maloney,
"XML Schema Part 1: Structures Second Edition", World Wide
Web Consortium Recommendation REC-xmlschema-1-20041028,
October 2004,
<<a href="http://www.w3.org/TR/2004/REC-xmlschema-1-20041028">http://www.w3.org/TR/2004/REC-xmlschema-1-20041028</a>>.
[<a id="ref-W3C.REC-xmlschema-2-20041028">W3C.REC-xmlschema-2-20041028</a>]
Biron, P. and A. Malhotra, "XML Schema Part 2: Datatypes
Second Edition", World Wide Web Consortium
Recommendation REC-xmlschema-2-20041028, October 2004,
<<a href="http://www.w3.org/TR/2004/REC-xmlschema-2-20041028">http://www.w3.org/TR/2004/REC-xmlschema-2-20041028</a>>.
<span class="h3"><a class="selflink" id="section-14.2" href="#section-14.2">14.2</a>. Informative References</span>
[<a id="ref-REST">REST</a>] Fielding, "Architectural Styles and the Design of Network-
based Software Architectures", 2000.
[<a id="ref-RFC3023">RFC3023</a>] Murata, M., St. Laurent, S., and D. Kohn, "XML Media
Types", <a href="./rfc3023">RFC 3023</a>, January 2001.
[<a id="ref-RFC3261">RFC3261</a>] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston,
A., Peterson, J., Sparks, R., Handley, M., and E.
Schooler, "SIP: Session Initiation Protocol", <a href="./rfc3261">RFC 3261</a>,
June 2002.
[<a id="ref-RFC3958">RFC3958</a>] Daigle, L. and A. Newton, "Domain-Based Application
Service Location Using SRV RRs and the Dynamic Delegation
Discovery Service (DDDS)", <a href="./rfc3958">RFC 3958</a>, January 2005.
<span class="grey">Barnes, et al. Standards Track [Page 114]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-115" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
[<a id="ref-RFC4582">RFC4582</a>] Camarillo, G., Ott, J., and K. Drage, "The Binary Floor
Control Protocol (BFCP)", <a href="./rfc4582">RFC 4582</a>, November 2006.
[<a id="ref-RFC4732">RFC4732</a>] Handley, M., Rescorla, E., and IAB, "Internet Denial-of-
Service Considerations", <a href="./rfc4732">RFC 4732</a>, December 2006.
[<a id="ref-RFC5226">RFC5226</a>] Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section in RFCs", <a href="https://www.rfc-editor.org/bcp/bcp26">BCP 26</a>, <a href="./rfc5226">RFC 5226</a>,
May 2008.
[<a id="ref-RFC6502">RFC6502</a>] Camarillo, G., Srinivasan, S., Even, R., and J.
Urpalainen, "Conference Event Package Data Format
Extension for Centralized Conferencing (XCON)", <a href="./rfc6502">RFC 6502</a>,
March 2012.
[<a id="ref-W3C.REC-soap12-part1-20070427">W3C.REC-soap12-part1-20070427</a>]
Nielsen, H., Mendelsohn, N., Moreau, J., Gudgin, M.,
Hadley, M., Lafon, Y., and A. Karmarkar, "SOAP Version 1.2
Part 1: Messaging Framework (Second Edition)", World Wide
Web Consortium Recommendation REC-soap12-part1-20070427,
April 2007,
<<a href="http://www.w3.org/TR/2007/REC-soap12-part1-20070427">http://www.w3.org/TR/2007/REC-soap12-part1-20070427</a>>.
[<a id="ref-W3C.REC-soap12-part2-20070427">W3C.REC-soap12-part2-20070427</a>]
Moreau, J., Gudgin, M., Karmarkar, A., Mendelsohn, N.,
Hadley, M., Lafon, Y., and H. Nielsen, "SOAP Version 1.2
Part 2: Adjuncts (Second Edition)", World Wide Web
Consortium Recommendation REC-soap12-part2-20070427,
April 2007,
<<a href="http://www.w3.org/TR/2007/REC-soap12-part2-20070427">http://www.w3.org/TR/2007/REC-soap12-part2-20070427</a>>.
<span class="grey">Barnes, et al. Standards Track [Page 115]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-116" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Evaluation of Other Protocol Models and Transports</span>
Considered for CCMP
This section provides some background as to the selection of HTTP as
the transport for the CCMP requests/responses. In addition to HTTP,
the operations on the objects can be implemented in at least two
different ways, namely as remote procedure calls -- using SOAP as
described in <a href="#appendix-A.1">Appendix A.1</a> and by defining resources following a
RESTful architecture <a href="#appendix-A.2">Appendix A.2</a>.
In both the SOAP and RESTFUL approaches, servers will have to
recreate their internal state representation of the object with each
update request, checking parameters and triggering function
invocations. In the SOAP approach, it would be possible to describe
a separate operation for each atomic element, but that would greatly
increase the complexity of the protocol. A coarser-grained approach
to CCMP does require that the server process XML elements in updates
that have not changed and that there can be multiple changes in one
update. For CCMP, the resource (REST) model might appear more
attractive, since the conference operations fit the CRUD approach.
However, neither of these approaches were considered ideal. SOAP was
considered to bring additional overhead. It is quite awkward to
apply a RESTful approach since CCMP requires a more complex request/
response protocol in order to maintain the data both in the server
and at the client. This doesn't map very elegantly to the basic
request/response model, whereby a response typically indicates
whether the request was successful or not, rather than providing
additional data to maintain the synchronization between the client
and server data. In addition, the CCMP clients may also receive the
data in notifications. While the notification method or protocol
used by some conferencing clients can be independent of CCMP, the
same data in the server is used for both CCMP and notifications -
this requires a server application above the transport layer (e.g.,
HTTP) for maintaining the data, which in the CCMP model is
transparent to the transport protocol.
Thus, the solution for CCMP defined in this document is viewed as a
good compromise amongst the most notable past candidates and is
referred to as "HTTP single-verb transport plus CCMP body". With
this approach, CCMP is able to take advantage of existing HTTP
functionality. As with SOAP, CCMP uses a "single HTTP verb" for
transport (i.e., a single transaction type for each request/response
pair); this allows decoupling CCMP messages from HTTP messages.
Similarly, as with any RESTful approach, CCMP messages are inserted
directly in the body of HTTP messages, thus avoiding any unnecessary
processing and communication burden associated with further
intermediaries. With this approach, no modification to the CCMP
<span class="grey">Barnes, et al. Standards Track [Page 116]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-117" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
messages/operations is required to use a different transport
protocol.
<span class="h3"><a class="selflink" id="appendix-A.1" href="#appendix-A.1">A.1</a>. Using SOAP for CCMP</span>
A remote procedure call (RPC) mechanism for CCMP could use SOAP
(Simple Object Access Protocol [<a href="#ref-W3C.REC-soap12-part1-20070427">W3C.REC-soap12-part1-20070427</a>]
[<a href="#ref-W3C.REC-soap12-part2-20070427">W3C.REC-soap12-part2-20070427</a>]), where conferences and the other
objects are modeled as services with associated operations.
Conferences and other objects are selected by their own local
identifiers, such as email-like names for users. This approach has
the advantage that it can easily define atomic operations that have
well-defined error conditions.
All SOAP operations would use a single HTTP verb. While the RESTful
approach requires the use of a URI for each object, SOAP can use any
token.
<span class="h3"><a class="selflink" id="appendix-A.2" href="#appendix-A.2">A.2</a>. A RESTful Approach for CCMP</span>
Conference objects can also be modeled as resources identified by
URIs, with the basic CRUD operations mapped to the HTTP methods POST/
PUT for creating objects, GET for reading objects, PATCH/POST/PUT for
changing objects, and DELETE for deleting them. Many of the objects,
such as conferences, already have natural URIs.
CCMP can be mapped into the CRUD (Create, Read, Update, Delete)
design pattern. The basic CRUD operations are used to manipulate
conference objects, which are XML documents containing the
information characterizing a specified conference instance, be it an
active conference or a conference blueprint used by the conference
server to create new conference instances through a simple clone
operation.
Following the CRUD approach, CCMP could use a general-purpose
protocol such as HTTP [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>] to transfer domain-specific XML-
encoded data objects defined in the "Conference Information Data
Model for Centralized Conferencing" [<a href="./rfc6501" title=""Conference Information Data Model for Centralized Conferencing (XCON)"">RFC6501</a>].
Following on the CRUD approach, CCMP could follow the well-known REST
(REpresentational State Transfer) architectural style [<a href="#ref-REST" title=""Architectural Styles and the Design of Network- based Software Architectures"">REST</a>]. CCMP
could map onto the REST philosophy, by specifying resource URIs,
resource formats, methods supported at each URI and status codes that
have to be returned when a certain method is invoked on a specific
URI. A REST-style approach must ensure sure that all operations can
be mapped to HTTP operations.
<span class="grey">Barnes, et al. Standards Track [Page 117]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-118" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
The following summarizes the specific HTTP method that could be used
for each of the CCMP Requests:
Retrieve: HTTP GET could be used on XCON-URIs, so that clients can
obtain data about conference objects in the form of XML data model
documents.
Create: HTTP PUT could be used to create a new object as identified
by the XCON-URI or XCON-USERID.
Change: Either HTTP PATCH or HTTP POST could be used to change the
conference object identified by the XCON-URI.
Delete: HTTP DELETE could be used to delete conference objects and
parameters within conference objects identified by the XCON-URI.
<span class="grey">Barnes, et al. Standards Track [Page 118]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-119" ></span>
<span class="grey"><a href="./rfc6503">RFC 6503</a> CCMP March 2012</span>
Authors' Addresses
Mary Barnes
Polycom
TX
USA
EMail: mary.ietf.barnes@gmail.com
Chris Boulton
NS-Technologies
EMail: chris@ns-technologies.com
Simon Pietro Romano
University of Napoli
Via Claudio 21
Napoli 80125
Italy
EMail: spromano@unina.it
Henning Schulzrinne
Columbia University
Department of Computer Science
450 Computer Science Building
New York, NY 10027
EMail: hgs+xcon@cs.columbia.edu
Barnes, et al. Standards Track [Page 119]
</pre>
|