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
|
<pre>Network Working Group J. Rosenberg
Request for Comments: 4575 Cisco Systems
Category: Standards Track H. Schulzrinne
Columbia University
O. Levin, Ed.
Microsoft Corporation
August 2006
<span class="h1">A Session Initiation Protocol (SIP)</span>
<span class="h1">Event Package for Conference State</span>
Status of This Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2006).
Abstract
This document defines a conference event package for tightly coupled
conferences using the Session Initiation Protocol (SIP) events
framework, along with a data format used in notifications for this
package. The conference package allows users to subscribe to a
conference Uniform Resource Identifier (URI). Notifications are sent
about changes in the membership of this conference and optionally
about changes in the state of additional conference components.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-4">4</a>
<a href="#section-2">2</a>. Terminology .....................................................<a href="#page-4">4</a>
<a href="#section-3">3</a>. Conference Event Package ........................................<a href="#page-4">4</a>
<a href="#section-3.1">3.1</a>. Event Package Name .........................................<a href="#page-5">5</a>
<a href="#section-3.2">3.2</a>. Filtering ..................................................<a href="#page-5">5</a>
<a href="#section-3.3">3.3</a>. Subscription Duration ......................................<a href="#page-5">5</a>
<a href="#section-3.4">3.4</a>. NOTIFY Bodies ..............................................<a href="#page-5">5</a>
<a href="#section-3.5">3.5</a>. Notifier Processing of SUBSCRIBE Requests ..................<a href="#page-6">6</a>
<a href="#section-3.6">3.6</a>. Notifier Generation of NOTIFY Requests .....................<a href="#page-6">6</a>
<a href="#section-3.7">3.7</a>. Subscriber Processing of NOTIFY Requests ...................<a href="#page-6">6</a>
<a href="#section-3.8">3.8</a>. Handling of Forked Requests ................................<a href="#page-7">7</a>
<a href="#section-3.9">3.9</a>. Rate of Notifications ......................................<a href="#page-7">7</a>
<a href="#section-3.10">3.10</a>. State Agents ..............................................<a href="#page-7">7</a>
<a href="#section-4">4</a>. Conference Document .............................................<a href="#page-7">7</a>
<a href="#section-4.1">4.1</a>. Format .....................................................<a href="#page-7">7</a>
<a href="#section-4.2">4.2</a>. Namespace ..................................................<a href="#page-7">7</a>
<a href="#section-4.3">4.3</a>. Versioning .................................................<a href="#page-8">8</a>
<a href="#section-4.4">4.4</a>. Partial Notifications Mechanism ............................<a href="#page-8">8</a>
<a href="#section-4.5">4.5</a>. Element Keys ...............................................<a href="#page-9">9</a>
<a href="#section-4.6">4.6</a>. Constructing Coherent State Procedure ......................<a href="#page-9">9</a>
<a href="#section-5">5</a>. Conference Data ................................................<a href="#page-11">11</a>
<a href="#section-5.1">5.1</a>. Overview ..................................................<a href="#page-11">11</a>
<a href="#section-5.2">5.2</a>. <conference-info> .........................................<a href="#page-13">13</a>
<a href="#section-5.3">5.3</a>. <conference-description> ..................................<a href="#page-14">14</a>
<a href="#section-5.3.1">5.3.1</a>. <conf-uris> ........................................<a href="#page-14">14</a>
<a href="#section-5.3.2">5.3.2</a>. <service-uris> .....................................<a href="#page-15">15</a>
<a href="#section-5.3.3">5.3.3</a>. <maximum-user-count> ...............................<a href="#page-16">16</a>
<a href="#section-5.3.4">5.3.4</a>. <available-media> ..................................<a href="#page-16">16</a>
<a href="#section-5.4">5.4</a>. <host-info> ...............................................<a href="#page-17">17</a>
<a href="#section-5.4.1">5.4.1</a>. <display-text> .....................................<a href="#page-17">17</a>
<a href="#section-5.4.2">5.4.2</a>. <web-page> .........................................<a href="#page-17">17</a>
<a href="#section-5.4.3">5.4.3</a>. <uris> .............................................<a href="#page-17">17</a>
<a href="#section-5.5">5.5</a>. <conference-state> ........................................<a href="#page-17">17</a>
<a href="#section-5.5.1">5.5.1</a>. <user-count> .......................................<a href="#page-17">17</a>
<a href="#section-5.5.2">5.5.2</a>. <active> ...........................................<a href="#page-18">18</a>
<a href="#section-5.5.3">5.5.3</a>. <locked> ...........................................<a href="#page-18">18</a>
<a href="#section-5.6">5.6</a>. <users> and Its <user> Sub-elements .......................<a href="#page-18">18</a>
<a href="#section-5.6.1">5.6.1</a>. <display-text> .....................................<a href="#page-19">19</a>
<a href="#section-5.6.2">5.6.2</a>. <associated-aors> ..................................<a href="#page-19">19</a>
<a href="#section-5.6.3">5.6.3</a>. <roles> ............................................<a href="#page-19">19</a>
<a href="#section-5.6.4">5.6.4</a>. <languages> ........................................<a href="#page-19">19</a>
<a href="#section-5.6.5">5.6.5</a>. <cascaded-focus> ...................................<a href="#page-19">19</a>
<a href="#section-5.6.6">5.6.6</a>. <endpoint> .........................................<a href="#page-20">20</a>
<a href="#section-5.7">5.7</a>. <endpoint> ................................................<a href="#page-20">20</a>
<a href="#section-5.7.1">5.7.1</a>. <display-text> .....................................<a href="#page-20">20</a>
<a href="#section-5.7.2">5.7.2</a>. <referred> .........................................<a href="#page-21">21</a>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<a href="#section-5.7.3">5.7.3</a>. <status> ...........................................<a href="#page-21">21</a>
<a href="#section-5.7.4">5.7.4</a>. <joining-method> ...................................<a href="#page-22">22</a>
<a href="#section-5.7.5">5.7.5</a>. <joining-info> .....................................<a href="#page-23">23</a>
<a href="#section-5.7.6">5.7.6</a>. <disconnection-method> .............................<a href="#page-23">23</a>
<a href="#section-5.7.7">5.7.7</a>. <disconnection-info> ...............................<a href="#page-23">23</a>
<a href="#section-5.7.8">5.7.8</a>. <media> ............................................<a href="#page-24">24</a>
<a href="#section-5.7.9">5.7.9</a>. <call-info> ........................................<a href="#page-24">24</a>
<a href="#section-5.8">5.8</a>. <media> ...................................................<a href="#page-24">24</a>
<a href="#section-5.8.1">5.8.1</a>. <display-text> .....................................<a href="#page-25">25</a>
<a href="#section-5.8.2">5.8.2</a>. <type> .............................................<a href="#page-25">25</a>
<a href="#section-5.8.3">5.8.3</a>. <label> ............................................<a href="#page-25">25</a>
<a href="#section-5.8.4">5.8.4</a>. <src-id> ...........................................<a href="#page-25">25</a>
<a href="#section-5.8.5">5.8.5</a>. <status> ...........................................<a href="#page-26">26</a>
<a href="#section-5.9">5.9</a>. Sidebars ..................................................<a href="#page-26">26</a>
<a href="#section-5.9.1">5.9.1</a>. <sidebars-by-ref> ..................................<a href="#page-26">26</a>
<a href="#section-5.9.2">5.9.2</a>. <sidebar-by-val> ...................................<a href="#page-26">26</a>
<a href="#section-6">6</a>. XML Schema .....................................................<a href="#page-26">26</a>
<a href="#section-7">7</a>. Examples .......................................................<a href="#page-35">35</a>
<a href="#section-7.1">7.1</a>. Basic Example .............................................<a href="#page-35">35</a>
<a href="#section-7.2">7.2</a>. Rich Example ..............................................<a href="#page-36">36</a>
<a href="#section-8">8</a>. Security Considerations ........................................<a href="#page-40">40</a>
<a href="#section-8.1">8.1</a>. Connection Security .......................................<a href="#page-40">40</a>
<a href="#section-8.2">8.2</a>. Authorization Considerations ..............................<a href="#page-41">41</a>
<a href="#section-9">9</a>. IANA Considerations ............................................<a href="#page-41">41</a>
<a href="#section-9.1">9.1</a>. conference Event Package Registration .....................<a href="#page-41">41</a>
<a href="#section-9.2">9.2</a>. application/conference-info+xml MIME Registration .........<a href="#page-42">42</a>
<a href="#section-9.3">9.3</a>. URN Sub-Namespace Registration for ........................<a href="#page-43">43</a>
<a href="#section-9.4">9.4</a>. XML Schema Registration ...................................<a href="#page-43">43</a>
<a href="#section-9.5">9.5</a>. URI Purposes Sub-registry Establishment ...................<a href="#page-44">44</a>
<a href="#section-10">10</a>. Acknowledgements ..............................................<a href="#page-45">45</a>
<a href="#section-11">11</a>. References ....................................................<a href="#page-45">45</a>
<a href="#section-11.1">11.1</a>. Normative References .....................................<a href="#page-45">45</a>
<a href="#section-11.2">11.2</a>. Informative References ...................................<a href="#page-46">46</a>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
The Session Initiation Protocol (SIP) events framework [<a href="#ref-10" title=""Session Initiation Protocol (SIP)-Specific Event Notification"">10</a>] defines
general mechanisms for subscribing to, and receiving notifications
of, events within SIP networks. It introduces the notion of a
package, which is a specific "instantiation" of the events framework
for a well-defined set of events. Here, we define a SIP event
package for tightly coupled conferences. This package can be used by
the conference notification service as outlined in the SIP
conferencing framework [<a href="#ref-16" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">16</a>]. As described there, subscriptions to a
conference URI are routed to the focus that is handling the
conference. It acts as the notifier and provides clients with
updates on conference state.
The information provided by this package is comprised of conference
identifier(s), conference participants (optionally with their
statuses and media description), conference sidebars, conference
service URIs, etc.
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Terminology</span>
In this document, the key words "MUST", "MUST NOT", "REQUIRED",
"SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
and "OPTIONAL" are to be interpreted as described in <a href="./rfc2119">RFC 2119</a> [<a href="#ref-1" title=""Key words for use in RFCs to Indicate Requirement Levels"">1</a>] and
indicate requirement levels for compliant implementations.
This document uses the conferencing terminology defined in
Conferencing Framework [<a href="#ref-16" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">16</a>]. In addition, the "roster" term is used
to collectively refer to participants in a conference or a sub-
conference.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Conference Event Package</span>
The conference event package allows a user to subscribe to the
information relating to a conference. In SIP, conferences are
represented by URIs. These URIs identify a SIP user agent (UA),
called a focus, that is responsible for ensuring that all users in
the conference can communicate with each other, as described in
Conferencing Framework [<a href="#ref-16" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">16</a>]. The focus has sufficient information
about the state of the conference to inform subscribers about it.
It is possible that a participant in the conference may in fact be
another focus. In order to provide a more complete participant list,
the focus MAY subscribe to the conference package of the other focus
to discover the participant list in the cascaded conference. This
information can then be included in notifications by use of the
<cascaded-focus> element as specified by this package.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
This section provides the details for defining a SIP-specific event
notification package, as specified by <a href="./rfc3265">RFC 3265</a> [<a href="#ref-10" title=""Session Initiation Protocol (SIP)-Specific Event Notification"">10</a>].
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Event Package Name</span>
The name of this event package is "conference". This package name is
carried in the Event and Allow-Events header, as defined in <a href="./rfc3265">RFC 3265</a>
[<a href="#ref-10" title=""Session Initiation Protocol (SIP)-Specific Event Notification"">10</a>].
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Filtering</span>
Filters, which can be applied to conference subscriptions, are a
desirable feature and can be considered as a subject of future
standardization activities. This document does not define the
filters for the conference package to be included in the SUBSCRIBE
body.
A SUBSCRIBE for a conference package, being sent without a body,
implies the default subscription filtering policy. The default
policy is as follows:
o Notifications are generated every time there is any change in the
state of the conference.
o Notifications do not normally contain full state; rather, they
only indicate the state that has changed. The exception is a
NOTIFY sent in response to a SUBSCRIBE. These NOTIFYs contain the
full state of the information requested by the subscriber.
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Subscription Duration</span>
The default expiration time for a subscription to a conference is one
hour. Once the conference ends, all subscriptions to that particular
conference are terminated, with a reason of "noresource" as defined
in <a href="./rfc3265">RFC 3265</a> [<a href="#ref-10" title=""Session Initiation Protocol (SIP)-Specific Event Notification"">10</a>].
<span class="h3"><a class="selflink" id="section-3.4" href="#section-3.4">3.4</a>. NOTIFY Bodies</span>
According to <a href="./rfc3265">RFC 3265</a> [<a href="#ref-10" title=""Session Initiation Protocol (SIP)-Specific Event Notification"">10</a>], the NOTIFY message will contain bodies
that describe the state of the subscribed resource. This body is in
a format listed in the Accept header field of the SUBSCRIBE, or a
package-specific default if the Accept header field was omitted from
the SUBSCRIBE.
In this event package, the body of the notification contains a
conference information document that describes the state of a
conference. All subscribers and notifiers MUST support the
"application/conference-info+xml" data format described in Sections <a href="#section-9">9</a>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
and 5. By default, i.e., if no Accept header is specified to a
SUBSCRIBE request, the NOTIFY will contain a body in the
"application/conference-info+xml" data format. If the Accept header
field is present, it MUST include "application/conference-info+xml"
and MAY include any other types.
<span class="h3"><a class="selflink" id="section-3.5" href="#section-3.5">3.5</a>. Notifier Processing of SUBSCRIBE Requests</span>
The conference information contains very sensitive information.
Therefore, all subscriptions SHOULD be authenticated and then
authorized before approval. Authorization policy is at the
discretion of the administrator, as always.
However, it is RECOMMENDED that all users in the conference be
allowed to subscribe to the conference event package.
<span class="h3"><a class="selflink" id="section-3.6" href="#section-3.6">3.6</a>. Notifier Generation of NOTIFY Requests</span>
Notifications SHOULD be generated for the conference state when a new
participant joins (i.e., gets "connected" to) or a participant leaves
(i.e., gets "disconnected" from) the conference.
Subject to a local focus policy, additional changes in participants'
status, changes in their media types, and other optional information
MAY be reported by the focus.
Changes in sidebar rosters SHOULD be reported by the focus to their
participants and MAY be reported to others, subject to local policy.
Changes in conference identifiers and service URIs SHOULD be reported
by the focus to the conference package subscribers.
Changes in other conference state information MAY be reported by the
focus to the conference package subscribers.
<span class="h3"><a class="selflink" id="section-3.7" href="#section-3.7">3.7</a>. Subscriber Processing of NOTIFY Requests</span>
The SIP events framework expects packages to specify how a subscriber
processes NOTIFY requests in any package-specific ways, and in
particular, how it uses the NOTIFY requests to construct a coherent
view of the state of the subscribed resource.
Typically, the NOTIFY for the conference package will only contain
information about those users whose state in the conference has
changed. To construct a coherent view of the total state of all
users, a subscriber to the conference package will need to combine
NOTIFYs received over time.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
Notifications within this package can convey partial information;
that is, they can indicate information about a subset of the state
associated with the subscription. This means that an explicit
algorithm needs to be defined in order to construct coherent and
consistent state. The details of this mechanism are specific to the
particular document type. See <a href="#section-4.6">Section 4.6</a> for information on
constructing coherent information from an application/
conference-info+xml document.
<span class="h3"><a class="selflink" id="section-3.8" href="#section-3.8">3.8</a>. Handling of Forked Requests</span>
By their nature, the conferences supported by this package are
centralized. Therefore, SUBSCRIBE requests for a conference should
not generally fork. If forking happens in the network, subscribers
to this package MUST NOT establish more than a single SIP dialog as a
result of a single SUBSCRIBE request. In the foci cascading case,
detailed conference information can be retrieved by establishing an
individual SUBSCRIBE dialog with each participating focus.
<span class="h3"><a class="selflink" id="section-3.9" href="#section-3.9">3.9</a>. Rate of Notifications</span>
For reasons of congestion control, it is important that the rate of
notifications not become excessive. As a result, it is RECOMMENDED
that the server does not generate notifications for a single
subscriber at a rate faster than once every 5 seconds.
<span class="h3"><a class="selflink" id="section-3.10" href="#section-3.10">3.10</a>. State Agents</span>
Conference state is ideally maintained in the element in which the
conference resides. Therefore, a conference focus is the best-suited
element to handle subscriptions to it. Cascaded foci MAY implement
state agents (as defined in <a href="./rfc3265">RFC 3265</a> [<a href="#ref-10" title=""Session Initiation Protocol (SIP)-Specific Event Notification"">10</a>]) for this package.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Conference Document</span>
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Format</span>
Conference information is an XML document that MUST be well-formed
and valid. It MUST be based on Extensible Markup Language (XML) 1.0
and MUST be encoded using UTF-8 [<a href="#ref-14" title=""UTF-8, a transformation format of ISO 10646"">14</a>].
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Namespace</span>
This specification makes use of XML namespaces for identifying
conference information documents and document fragments. The
namespace URI for elements defined by this specification is a Uniform
Resource Namespace (URN) [<a href="#ref-2" title=""URN Syntax"">2</a>], using the namespace identifier 'ietf'
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
defined by [<a href="#ref-6" title=""A URN Namespace for IETF Documents"">6</a>] and extended by <a href="./rfc3688">RFC 3688</a> [<a href="#ref-21" title=""The IETF XML Registry"">21</a>]. This URN is as
follows:
urn:ietf:params:xml:ns:conference-info
<span class="h3"><a class="selflink" id="section-4.3" href="#section-4.3">4.3</a>. Versioning</span>
The conference information is described by a hierarchical XML
structure with the root element <conference-info>. The root element
is the only element in the schema that carries a meaningful version
number for all the elements in the document. The whole conference
information is associated with this version number.
The 'version' attribute MUST be included in the root
<conference-info> element.
<span class="h3"><a class="selflink" id="section-4.4" href="#section-4.4">4.4</a>. Partial Notifications Mechanism</span>
This specification defines a basic partial notifications mechanism by
using a 'state' attribute as described below. This mechanism MUST be
supported by all subscribing clients. Additional general partial
notifications mechanisms can be defined and applied to this package
in the future.
All sub-elements in the <conference-info> hierarchical XML structure
can be classified in two groups: permissible for partial
notifications or not. Elements that carry a substantial amount of
data that is subject to frequent changes are permissible for partial
notifications and have a 'state' attribute attached to them. All
future extensions to this schema MUST define which extension elements
can also use this mechanism. All other elements can be updated as
atomic pieces of data only.
Below is the complete list of elements permissible to use the partial
notifications mechanism defined in this specification. (Note that
future partial notifications mechanisms can potentially be applicable
to additional elements.)
o Element <conference-info>
o Element <users>
o Element <user>
o Element <endpoint>
o Element <sidebars-by-val>
o Element <sidebars-by-ref>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
The 'state' attribute value indicates whether the reported
information about the element is "full" or "partial", or whether the
element has been "deleted" from the conference state document. The
default value of any 'state' attribute is "full".
A 'state' attribute of a child element in the document MUST be
consistent with its parent 'state'. This means that if the parent's
'state' is "full", the state of its children MUST be "full". If the
parent's 'state' is "partial", the state of its children MAY be
either "partial", "full", or "deleted". A parent element with
"deleted" 'state' SHOULD NOT contain child elements. Any information
provided for child elements of a "deleted" parent MUST be ignored by
the package subscriber.
<span class="h3"><a class="selflink" id="section-4.5" href="#section-4.5">4.5</a>. Element Keys</span>
The defined XML schema has a property of unique identification among
sub-elements of a common parent, which makes it possible to use the
partial notifications mechanism defined in this document. This
property is achieved by defining a key to each sub-element that can
appear multiple times under the common parent.
In the context of this specification, the element key is the set of
mandatory attributes or sub-elements of an element. The key value
MUST be unique for the element among its siblings of the same type.
In the context of this specification, two keys of type xs:anyURI are
considered to be equal if the UTF-8 representations of the keys
(including all URI parameters that can be included with the URI) are
identical. Consequently, using relative URIs and lexical white space
in these keys is NOT RECOMMENDED.
Below is the list of elements (subject to partial notifications of
their parent elements) with their keys as defined by this
specification:
o Element <user> uses as the key 'entity'
o Element <endpoint> uses as the key 'entity'
o Element <media> uses as the key 'id'
o Element <entry> (child to <sidebars-by-val>) uses as the key
'entity'
o Element <sidebars-by-ref> uses as the key <uri>
<span class="h3"><a class="selflink" id="section-4.6" href="#section-4.6">4.6</a>. Constructing Coherent State Procedure</span>
This section describes the algorithm for constructing a coherent
conference state by a subscriber to the conference package. Using
software programming abstraction, the subscriber maintains a single
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
local version number for the whole conference document and a local
element instance for each element in the schema. Also, for each
element with keys (as defined above), the subscriber maintains a
virtual table with a row for each existing key value.
The first time a NOTIFY with a "full" document is received (as
indicated by the value of the 'state' attribute in the
<conference-info> element), the conference package subscriber MUST
set the local 'version' number to the value of the 'version'
attribute from the received <conference-info> and populate local data
with the received information.
Each time a new NOTIFY is received, the value of the local version
number and the value of the 'version' attribute in the new received
document are compared. If the value in the document is equal to or
less than the local version, the document is discarded without
processing.
Otherwise, if the received NOTIFY contains a "full" or "deleted"
state, the conference package subscriber MUST set the local 'version'
number to the value of the 'version' attribute from the received
<conference-info> and replace the local information with the received
document. Receiving "deleted" state for the <conference-info>
element means that the conference has ceased to exist and the
subscriber SHOULD terminate the subscription by sending the SUBSCRIBE
with Expires = 0.
Otherwise (i.e., if the received NOTIFY contains "partial" state), if
the 'version' number in the received document is more than one number
higher than the previous local version number, the subscriber MUST
generate a subscription refresh request to trigger a full state
notification. If the 'version' number in the document is one higher
than the local version number, the local version number is updated
accordingly and the document is used to update the local content as
described below.
For each sub-element of the <conference-info> element in the received
document,
1. If the element contains "full" state, the whole local element
content is flushed and repopulated from the document.
2. Otherwise, if the element contains "deleted" state, the whole
element MUST be removed from the local content.
3. Otherwise, if the element contains "partial" state:
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
3.1. For elements with keys, the subscriber compares the keys
received in the update with the keys in the local tables.
3.1.1. If a key does not exist in the local table, a row is
added, and its content is set to the element
information from the update.
3.1.2. Otherwise, if a key of the same value does exist, for
each sub-element in the row, the algorithm is applied
from step 3.2.
3.2. For each atomic element received in the schema, the element
is replaced with the new information as a whole. For each
non-atomic element received in the schema with either no
'state' attribute included or the state attribute is set to
"full", the element is replaced with the new information as a
whole. Also, for each element with the state attribute set
to "deleted", the whole element is removed from the local
content.
3.3. For each non-atomic element with the state attribute set to
"partial", the algorithm is applied recursively starting from
step 3.1.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Conference Data</span>
<span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Overview</span>
The <conference-info> document format is designed to convey
information about the conference and about participation in the
conference. The following non-normative diagram gives an example of
the overall hierarchy used in this format. Conferences contain users
who can be represented by multiple endpoints, each of which can have
multiple media streams. Conferences can also include or reference
"sidebar conferences". When sidebar information is incorporated into
a conference information document in a <sidebars-by-val> element,
each <entry> element represents a sidebar and can include any
sub-elements permitted in the <conference-info> top-level element.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
conference-info
|
|-- conference-description
|
|-- host-info
|
|-- conference-state
|
|-- users
| |-- user
| | |-- endpoint
| | | |-- media
| | | |-- media
| | | |-- call-info
| | |
| | |-- endpoint
| | |-- media
| |-- user
| |-- endpoint
| |-- media
|
|-- sidebars-by-ref
| |-- entry
| |-- entry
|
|-- sidebars-by-val
|-- entry
| |-- users
| |-- user
| |-- user
|-- entry
|-- users
|-- user
|-- user
|-- user
In most cases, this document does not mandate how the information,
presented through the conference document to the subscribers, is
obtained by the focus. In many cases, the information can be
dynamically learned from the call signaling and can also be manually
populated by an administrator - all subject to local policies. This
document specifies what the XML elements mean in order to allow the
subscribers to appropriately interpret it. Some portions of the
information are intended for processing by automata; others are for
human consumption only. For example, the <display-text> sub-elements
of elements <conf-uris>, <service-uris>, <available-media>,
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<host-info>, <endpoint>, and <media> are intended for display to
human subscribers only.
Although in multiple places this document states that specific
information "SHOULD" be communicated to the subscribers, note that
particular conference package subscribers (e.g., representing a
moderator, an administrator, or a cascaded focus) rely on accuracy of
this information for their proper operation. Therefore, a
conferencing server MUST ensure that all critical changes (stated
as "SHOULD") are communicated to these specific subscribers;
otherwise, these changes MUST be communicated to all subscribers to
the conference information.
Following sections describe the XML schema in more detail.
<span class="h3"><a class="selflink" id="section-5.2" href="#section-5.2">5.2</a>. <conference-info></span>
A conference information document begins with the root element tag
<conference-info> of conference-type.
The following attributes are defined for <conference-info>:
entity: This attribute contains the conference URI that identifies
the conference being described in the document. This is the SIP
URI that an interested entity needs to SUBSCRIBE to in order to
get the conference package information. Note that this URI can be
listed as one of the URIs to be used in order to access the
conference by SIP means and in accordance with <a href="#section-5.3.1">Section 5.3.1</a>
below.
state: This attribute indicates whether the document contains the
whole conference information ("full") or only the information that
has changed since the previous document ("partial"), or whether
the conference ceased to exist ("deleted"). For more detail, see
<a href="#section-4">Section 4</a>.
version: This attribute allows the recipient of conference
information documents to properly order the received
notifications, and it MUST be used with the root <conference-info>
element. Version number is a 32-bit monotonically increasing
integer scoped within a subscription. A server MUST increment the
version number for each notification (full, partial, and deleted)
being sent to a subscriber and reporting a change in the
conference document state. For each partial notification, the
version number MUST be increased by one. Note that a partial
notification and a subsequent full notification over the same
dialog MAY contain the same version number if no change in the
conference state occurred in between.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
The <conference-info> element is comprised of <conference-
description>, <host-info>, <conference-state>, <users>,
<sidebars-by-ref> and <sidebars-by-val> child elements. A "full"
conference document MUST at least include the
<conference-description> and <users> child elements.
Following sections describe these elements in detail. The full XML
schema is provided in <a href="#section-6">Section 6</a>.
<span class="h3"><a class="selflink" id="section-5.3" href="#section-5.3">5.3</a>. <conference-description></span>
The <conference-description> element describes the conference as a
whole.
The child elements <display-text>, <subject>, <free-text>, and
<keywords> are used to describe the conference content:
<display-text>: Contains descriptive text suitable for human
consumption, for example, listing in a directory
<subject>: Contains the subject of the conference
<free-text>: Contains an additional longer description of the
conference
<keywords>: Contains a list of space-separated string tokens that
can be used by search engines to better classify the conference
Additional child elements <conf-uris> and <service-uris> are used to
describe the conference-related URIs; <maximum-user-count> and
<available-media> are used to describe the overall characteristics.
This information is typically derived from the system conference
policies, is set before the conference activation, and is rarely
changed during the conference lifetime.
The following sections describe the remaining elements in more
detail. Other sub-elements can extend <conference-description> in
the future.
<span class="h4"><a class="selflink" id="section-5.3.1" href="#section-5.3.1">5.3.1</a>. <conf-uris></span>
This element contains a sequence of <entry> child elements - each
containing the URI to be used in order to access the conference by
different signaling means. The value of the URI MUST be unique in
the conference context and is included in the <uri> sub-element.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
Each <entry> MAY contain additional information useful to the
participant when accessing the conference.
An <entry> element MAY contain the <display-text> sub-element that
provides a textual description meant for human consumption.
Each <entry> element SHOULD contain a <purpose> sub-element that
describes what happens when accessing the URI. The currently defined
<purpose> values to be used with the <conf-uris> are the following:
participation: Accessing a URI with this <purpose> will bring the
party into the conference.
streaming: Accessing a URI with this <purpose> will commence
streaming the conference, but not allow active participation.
Examples of suitable URI schemes include sip: and sips: [<a href="#ref-8" title=""SIP: Session Initiation Protocol"">8</a>], xmpp:
[<a href="#ref-22" title=""A Uniform Resource Identifier (URI) Scheme for the Extensible Messaging and Presence Protocol (XMPP)"">22</a>], h323: [<a href="#ref-20" title=""H.323 Uniform Resource Locator (URL) Scheme Registration"">20</a>], and tel: [<a href="#ref-19" title=""The tel URI for Telephone Numbers"">19</a>] URIs. The rtsp [<a href="#ref-18" title=""Real Time Streaming Protocol (RTSP)"">18</a>] URI is suitable
for streaming.
Future extensions to this schema may define new values and register
them with IANA under the registry established by this specification.
<span class="h4"><a class="selflink" id="section-5.3.2" href="#section-5.3.2">5.3.2</a>. <service-uris></span>
This element describes auxiliary services available for the
conference. Like <conference-uris>, this element contains a set of
<entry> child elements - each containing the URI to be used in order
to access different services available for the particular conference.
The value of the URI MUST be unique in the conference context and is
included in the <uri> sub-element.
An <entry> element MAY contain the <display-text> sub-element that
provides a textual description meant for user consumption.
Each <entry> element SHOULD contain a <purpose> sub-element. The
currently defined <purpose> values to be used with the <service-uris>
are the following:
web-page: Indicates the web page containing the additional
information about the conference.
recording: Indicates the link at which the recorded conference
context can be retrieved.
event: Indicates the URI at which a subscription to the conference
event package may be requested. This would typically be the
conference URI of the main conference.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
Future extensions to this schema may define new values and register
them with IANA under the registry established by this specification.
<span class="h4"><a class="selflink" id="section-5.3.3" href="#section-5.3.3">5.3.3</a>. <maximum-user-count></span>
The value of this element provides a hint to the recipient of the
conference document about the number of users that can be invited to
the conference. Typically, this value represents the overall number
of users allowed to join the conference by different means as
published through the conference document in <conf-uris>. Note that
this value is set by an administrator and can reflect any local
policies combination such as network consumption, CPU processing
power, and licensing rules.
<span class="h4"><a class="selflink" id="section-5.3.4" href="#section-5.3.4">5.3.4</a>. <available-media></span>
This element contains a sequence of <entry> child elements of
conference-medium-type, each being indexed by the attribute 'label'.
The 'label' attribute is the media stream identifier assigned by the
conferencing server: its value will be unique in the
<conference-info> context. The value of this attribute will
typically correspond to the Session Description Protocol (SDP)
"label" media attribute defined in [<a href="#ref-17" title=""The Session Description Protocol (SDP) Label Attribute"">17</a>].
Each <entry> describes a single media stream available to the
participants in the conference and contains the following
information:
<display-text>: This element contains the display text for the media
stream.
<type>: This element contains the media type of the media stream.
The value of this element MUST be one of the values registered for
"media" of SDP [<a href="#ref-3" title=""SDP: Session Description Protocol"">3</a>] and its later revision(s), for example,
"audio", "video", "text", and "message".
<status>: This element indicates the available status of the media
stream available to the conference participants. For example,
this would be the status of the media stream, which would be
offered by the focus, in a 'dial-out' scenario. Using normal SIP
offer/answer mechanisms (being defined in <a href="./rfc3264">RFC 3264</a> [<a href="#ref-9" title=""An Offer/Answer Model with Session Description Protocol (SDP)"">9</a>]) in both
dial-in and dial-out scenarios, a participant can of course
establish only a subset of the available stream (i.e., request or
accept the stream in one direction only, if both directions are
available). The valid values are "sendrecv", "sendonly",
"recvonly", or "inactive" as defined in SDP [<a href="#ref-3" title=""SDP: Session Description Protocol"">3</a>] and its later
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
revision(s). (Note that the value specifies the direction from
the participants' point of view.)
<span class="h3"><a class="selflink" id="section-5.4" href="#section-5.4">5.4</a>. <host-info></span>
This element contains information about the entity hosting the
conference. This information is set before the conference
activation, and it is rarely changed during the conference lifetime,
unless the whole conference is moved to be hosted by another entity.
The host information is comprised of the following elements:
<span class="h4"><a class="selflink" id="section-5.4.1" href="#section-5.4.1">5.4.1</a>. <display-text></span>
This element contains display text describing the entity hosting the
conference.
<span class="h4"><a class="selflink" id="section-5.4.2" href="#section-5.4.2">5.4.2</a>. <web-page></span>
This element contains HTTP: or HTTPS: URI of a web page describing
either the conference service or the user hosting the conference.
<span class="h4"><a class="selflink" id="section-5.4.3" href="#section-5.4.3">5.4.3</a>. <uris></span>
This element contains a set of <entry> child elements, each
containing the URI value and optionally its description.
<span class="h3"><a class="selflink" id="section-5.5" href="#section-5.5">5.5</a>. <conference-state></span>
By including this element in the conference document, the server can
inform the subscribers about the changes in the overall conference
information. The <conference-state> child elements are described
below.
<span class="h4"><a class="selflink" id="section-5.5.1" href="#section-5.5.1">5.5.1</a>. <user-count></span>
The value of this element tells the recipient of the conference
document the overall number of users participating in the conference
at a certain moment. Typically, this value represents the overall
number of users who joined the conference by different means as
published through the conference document in <conf-uris>. Note that
this number does not necessarily need to match and MAY exceed the
number of the entries in the <users> container. For example, in a
lecturing scenario, large conference notifications may not include
every participant in the <users> element, but instead report only the
panelists or the speakers.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<span class="h4"><a class="selflink" id="section-5.5.2" href="#section-5.5.2">5.5.2</a>. <active></span>
This Boolean element indicates whether the conference is currently
active. A conference is active if calling one of the <conf-uris> by
an authorized client results in successful establishment of a
signaling session between the client and the focus and a successful
joining of the conference.
<span class="h4"><a class="selflink" id="section-5.5.3" href="#section-5.5.3">5.5.3</a>. <locked></span>
This Boolean element says whether the conference is currently locked.
In this context, "locked" means that the conference roster cannot be
added to (although participants may leave or be removed from the
conference).
<span class="h3"><a class="selflink" id="section-5.6" href="#section-5.6">5.6</a>. <users> and Its <user> Sub-elements</span>
The <users> element is a container of <user> child elements, each
describing a single participant in the conference.
The following attributes are defined for <user> element:
entity: This attribute contains the URI for the user in the
conference. This is a logical identifier, which corresponds to
the call signaling authenticated identity of the participant. The
'entity' value MUST be unique among all participants in the
conference. If, for some participants, the focus decides not to
reveal this information (e.g., due to local policies or security
reasons), the host portion of the user URI MUST use the .invalid
top level domain (TLD) according to definitions of <a href="./rfc2606">RFC 2606</a> [<a href="#ref-5" title=""Reserved Top Level DNS Names"">5</a>].
The focus also MUST construct the user portion of the URI so that
the URI is unique among all participants of the same domain. For
example, the convention
"AnonymousX" <sip:anonymousX@anonymous.invalid>
SHOULD be used for a participant requesting privacy in accordance
with the guidelines for generating anonymous URIs of <a href="./rfc3323">RFC 3323</a> [<a href="#ref-11" title=""A Privacy Mechanism for the Session Initiation Protocol (SIP)"">11</a>].
Note that in a different case, such as when used in conjunction with
Enhancements for Authenticated Identity Management in SIP [<a href="#ref-25" title=""Enhancements for Authenticated Identity Management in the Session Initiation Protocol (SIP)"">25</a>], the
following convention can be used:
"AnonymousX" <sip:anonymousX@example.com>
state: This attribute indicates whether the document contains the
whole user information ("full") or only the information that has
changed since the previous document ("partial"), or whether the
user was removed from the conference ("deleted").
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
The following child elements are defined for <user> element:
<span class="h4"><a class="selflink" id="section-5.6.1" href="#section-5.6.1">5.6.1</a>. <display-text></span>
This element is used to display the user-friendly name in the
conference.
<span class="h4"><a class="selflink" id="section-5.6.2" href="#section-5.6.2">5.6.2</a>. <associated-aors></span>
This element contains additional (to the 'entity') URIs being
associated with the <user>. Typically, this information will be
manually provided by an administrator showing the logical association
between signaling entities otherwise independent. For example, if
the 'entity' of a <user> contains a Globally Routable User URI (GRUU)
[<a href="#ref-24" title=""Obtaining and Using Globally Routable User Agent (UA) URIs (GRUU) in the Session Initiation Protocol (SIP)"">24</a>] or tel: URI <a href="./rfc3966">RFC 3966</a> [<a href="#ref-19" title=""The tel URI for Telephone Numbers"">19</a>], it would be useful to populate this
field with the Address of Record (AOR) of the person who uses these
devices, each represented as an independent <user>.
<span class="h4"><a class="selflink" id="section-5.6.3" href="#section-5.6.3">5.6.3</a>. <roles></span>
This element MAY contain a set of human-readable strings describing
the roles of the user in the conference. Note that this information
is applicable for human consumption only. This specification does
not define the set of possible conferencing roles or the semantics
associated with each. It is expected that future conferencing
specifications will define these and the corresponding schema
extensions, as appropriate.
<span class="h4"><a class="selflink" id="section-5.6.4" href="#section-5.6.4">5.6.4</a>. <languages></span>
This element contains a list of tokens, separated by spaces, each
containing a language understood by the user. This information can
be automatically learned via call signaling or be manually set per
participant.
<span class="h4"><a class="selflink" id="section-5.6.5" href="#section-5.6.5">5.6.5</a>. <cascaded-focus></span>
This element contains a conference URI (different from the main
conference URI) for users that are connected to the main conference
as a result of focus cascading. In accordance with the SIP
Conferencing Framework [<a href="#ref-16" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">16</a>], this package allows for representation
of peer-to-peer (i.e., "flat") focus cascading only. The actual
cascading graph cannot be deduced from the information provided in
the package alone. Advanced applications can construct the graph by
subscribing to both this package and the Dialog Package [<a href="#ref-23" title=""An INVITE- Initiated Dialog Event Package for the Session Initiation Protocol (SIP)"">23</a>] of each
cascaded focus and correlating the relevant information.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<span class="h4"><a class="selflink" id="section-5.6.6" href="#section-5.6.6">5.6.6</a>. <endpoint></span>
By including one or more <endpoint> elements under a parent <user>
element, the server can provide the desired level of detail
(including the state, media streams, and access information) about
the user's devices and signaling sessions taking part in the
conference.
In a conferencing system where authentication is performed per
endpoint (rather than per user), the focus can be unaware of the
logical association of multiple endpoints under a common user. In
this case, each endpoint will appear as a separate <user> with its
own <endpoint> sub-element(s) in the conference document.
In a different case, the focus may choose to shield the information
about the participant's multiple endpoints and signaling sessions
from other subscribers altogether (e.g., due to privacy policies).
To do so, the focus MAY aggregate the multiple signaling sessions'
information under a single <endpoint> element. Note that in this
case, the detailed call signaling information (represented by
<call-info> sub-element) will not be included.
<span class="h3"><a class="selflink" id="section-5.7" href="#section-5.7">5.7</a>. <endpoint></span>
This section describes the <endpoint> element in more detail.
The following attributes are defined for the <endpoint> element:
entity: The server MUST generate the 'entity' key for each
<endpoint> element included under the parent <user>, such that its
value is unique in the user context. In SIP terms, this can be
the Contact URI, GRUU, etc.
state: This attribute indicates whether the element contains the
whole endpoint information ("full") or only the information that
has changed since the previous document ("partial"), or whether
the endpoint has been removed from the conference ("deleted").
The following child elements are defined for the <endpoint> element:
<span class="h4"><a class="selflink" id="section-5.7.1" href="#section-5.7.1">5.7.1</a>. <display-text></span>
This element contains the display text for the endpoint.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<span class="h4"><a class="selflink" id="section-5.7.2" href="#section-5.7.2">5.7.2</a>. <referred></span>
This element contains information about the user whose action
resulted in this endpoint being brought into the conference (e.g.,
the SIP user identified by this URI sent a REFER to the focus). It
MAY contain the following sub-elements:
when: This element of the XML dateTime type contains the date and
time that the endpoint was referred to the conference and SHOULD
be expressed in Coordinated Universal Time (UTC) format. For
example,
<when>2005-03-04T20:00:00Z</when>
reason: This element contains the reason the endpoint was referred
to the conference. Including the information in the format
defined by <a href="./rfc3326">RFC 3326</a> [<a href="#ref-12" title=""The Reason Header Field for the Session Initiation Protocol (SIP)"">12</a>] is RECOMMENDED. For example,
<reason>Reason: SIP;text="Ad-hoc Invitation"</reason>
by: This element contains the URI of the entity that caused the
endpoint to be referred to the conference. In the case of SIP, it
will be populated from the Referred-By header defined in <a href="./rfc3892">RFC 3892</a>
[<a href="#ref-15" title=""The Session Initiation Protocol (SIP) Referred-By Mechanism"">15</a>].
<span class="h4"><a class="selflink" id="section-5.7.3" href="#section-5.7.3">5.7.3</a>. <status></span>
This element contains the status of the endpoint and can assume the
following values:
connected: The endpoint is a participant in the conference.
Depending on the media policies, he/she can send and receive media
to and from other participants.
disconnected: The endpoint is not a participant in the conference,
and no active dialog exists between the endpoint and the focus.
on-hold: Active signaling dialog exists between an endpoint and a
focus, but endpoint is "on-hold" for this conference, i.e., he/she
is neither "hearing" the conference mix nor is his/her media being
mixed in the conference. As an example, the endpoint has asked to
join the conference using SIP, but his/her participation is
pending based on moderator approval. In the meantime, he/she is
hearing music-on-hold or some other kind of related content.
muted-via-focus: Active signaling dialog exists between an endpoint
and a focus and the endpoint can "listen" to the conference, but
the endpoint's media is not being mixed into the conference. Note
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
that sometimes a subset of endpoint media streams can be muted by
focus (such as poor-quality video) while others (such as voice or
IM) can still be active. In this case, it is RECOMMENDED that the
"aggregated" endpoint connectivity <status> reflects the status of
the most active media.
pending: Endpoint is not yet in the session, but it is anticipated
that he/she will join in the near future.
alerting: A Public Switched Telephone Network (PSTN) ALERTING or SIP
180 Ringing was returned for the outbound call; endpoint is being
alerted.
dialing-in: Endpoint is dialing into the conference, not yet in the
roster (probably being authenticated).
dialing-out: Focus has dialed out to connect the endpoint to the
conference, but the endpoint is not yet in the roster (probably
being authenticated).
disconnecting: Focus is in the process of disconnecting the endpoint
(e.g., in SIP a DISCONNECT or BYE was sent to the endpoint).
Note that the defined transient statuses (e.g., disconnecting,
alerting, etc.) could generate a lot of traffic. Therefore,
implementations MAY choose to generate notifications on these
statuses to certain participants only or not generate them at all,
subject to local policy.
<span class="h4"><a class="selflink" id="section-5.7.4" href="#section-5.7.4">5.7.4</a>. <joining-method></span>
This element contains the method by which the endpoint joined the
conference and can assume the following values:
dialed-in: The endpoint dialed into the conference (e.g., in a SIP
sent INVITE to the focus), which resulted in successful dialog
establishment.
dialed-out: The focus has brought the endpoint into the conference
(e.g., in SIP, the focus sent a successful INVITE to the
endpoint).
focus-owner: The endpoint is the focus for this conference. This
status is used only when a participant's UA acts as a conference
focus.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<span class="h4"><a class="selflink" id="section-5.7.5" href="#section-5.7.5">5.7.5</a>. <joining-info></span>
This element contains information about how the endpoint joined and
MAY contain the following sub-elements:
when: This element of the XML dateTime type contains the date and
time that the endpoint joined the conference and SHOULD be
expressed in Coordinated Universal Time (UTC).
reason: This element contains the reason the endpoint joined the
conference. Including the information in the format defined by
<a href="./rfc3326">RFC 3326</a> [<a href="#ref-12" title=""The Reason Header Field for the Session Initiation Protocol (SIP)"">12</a>] is RECOMMENDED. For example,
<reason>Reason: SIP;text="Ad-hoc Invitation"</reason>
by: This element contains the URI of the entity that caused the
endpoint to join the conference.
<span class="h4"><a class="selflink" id="section-5.7.6" href="#section-5.7.6">5.7.6</a>. <disconnection-method></span>
This element contains the method by which the endpoint departed the
conference and can assume the following values:
departed: In SIP, the endpoint sent a BYE, thus leaving the
conference.
booted: In SIP, the endpoint was sent a BYE by the focus, ejecting
him/her out of the conference. Alternatively, the endpoint tried
to dial into the conference but was rejected by the focus due to
local policy.
failed: In SIP, the server tried to bring the endpoint into the
conference, but its attempt to contact the specific endpoint
resulted in a non-200 class final response. Alternatively, the
endpoint tried to dial into the conference without success due to
technical reasons.
busy: In SIP, the server tried to bring the endpoint into the
conference, but its attempt to contact the specific endpoint
resulted in a 486 "Busy Here" final response. Alternatively, the
endpoint tried to dial into the conference but the focus responded
with 486 response.
<span class="h4"><a class="selflink" id="section-5.7.7" href="#section-5.7.7">5.7.7</a>. <disconnection-info></span>
This element contains information about the endpoint's departure from
the conference and MAY contain the following sub-elements:
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
when: This element of the XML dateTime type contains the date and
time that the endpoint departed the conference and SHOULD be
expressed in Coordinated Universal Time (UTC).
reason: This element contains the reason the endpoint departed the
conference. When known and meaningful, including the information
as conveyed/reported by the call signaling in the format defined
by <a href="./rfc3326">RFC 3326</a> [<a href="#ref-12" title=""The Reason Header Field for the Session Initiation Protocol (SIP)"">12</a>] is RECOMMENDED. For example,
<reason>Reason: SIP;cause=415;text="Unsupported Media Type"</reason>
by: This element contains the URI of the entity that caused the
endpoint to depart the conference.
<span class="h4"><a class="selflink" id="section-5.7.8" href="#section-5.7.8">5.7.8</a>. <media></span>
This element contains information about a single media stream and is
included for each media stream being established between the focus
and the <endpoint>. The media stream definition can be found in SDP
[<a href="#ref-3" title=""SDP: Session Description Protocol"">3</a>].
Note that if the <call-info> sub-element of the endpoint is not
included in the document by the server, it is possible that the media
streams listed under the common <endpoint> were established by
separate signaling sessions.
<span class="h4"><a class="selflink" id="section-5.7.9" href="#section-5.7.9">5.7.9</a>. <call-info></span>
The <call-info> element provides detailed call signaling information
for a call being maintained between the participant and the focus.
Privacy policies MUST be consulted before revealing this information
to other participants.
The <sip> sub-element contains the SIP dialog identifier of the
endpoint's dialog with the focus. The element includes sub-elements
<display-text>, <call-id>, <to-tag>, <from-tag>.
In future, the <call-info> element can be expanded to include call
signaling protocol information for other protocols besides SIP.
<span class="h3"><a class="selflink" id="section-5.8" href="#section-5.8">5.8</a>. <media></span>
This section describes the <media> element in more detail.
A single 'id' attribute is defined for this element. This is the
media stream identifier being generated by the server such that its
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
value is unique in the endpoint context. This attribute is the key
to refer to a particular media stream in the conference document.
The following child elements are defined for <media>:
<span class="h4"><a class="selflink" id="section-5.8.1" href="#section-5.8.1">5.8.1</a>. <display-text></span>
This element contains the display text for the media stream. The
value of this element corresponds to the SDP description media
attribute ("i") defined in SDP [<a href="#ref-3" title=""SDP: Session Description Protocol"">3</a>].
<span class="h4"><a class="selflink" id="section-5.8.2" href="#section-5.8.2">5.8.2</a>. <type></span>
This element contains the media type for the media stream. The value
of this element MUST be one of the values registered for "media" of
SDP [<a href="#ref-3" title=""SDP: Session Description Protocol"">3</a>] and its later revision(s).
<span class="h4"><a class="selflink" id="section-5.8.3" href="#section-5.8.3">5.8.3</a>. <label></span>
The <label> element carries a unique identifier for this stream among
all streams in the conference and is assigned by the focus. The
value of this element will typically correspond to the SDP "label"
media attribute defined in [<a href="#ref-17" title=""The Session Description Protocol (SDP) Label Attribute"">17</a>] and is exchanged between a
participant and a focus over the signaling connection between them.
If the <available-media> information (described in <a href="#section-5.3.4">Section 5.3.4</a>) is
included in the conference document, the value of this element MUST
be equal to the 'label' value of the corresponding media stream
<entry> in the <available-media> container.
<span class="h4"><a class="selflink" id="section-5.8.4" href="#section-5.8.4">5.8.4</a>. <src-id></span>
The <src-id> element, if applicable, carries the information about
the actual source of the media. For example, for Real-time Transport
Protocol (RTP) / RTP Control Protocol (RTCP) [<a href="#ref-13" title=""RTP: A Transport Protocol for Real-Time Applications"">13</a>] media streams, the
value MUST contain the synchronization source (SSRC) identifier value
generated by the endpoint for the stream it sends.
When an RTP mixer generates a contributing source (CSRC) identifiers'
list according to RTP/RTCP [<a href="#ref-13" title=""RTP: A Transport Protocol for Real-Time Applications"">13</a>], it inserts a list of the SSRC
identifiers of the sources that contributed to the generation of a
particular packet into the RTP header of that packet. A quote from
<a href="./rfc3550">RFC 3550</a> [<a href="#ref-13" title=""RTP: A Transport Protocol for Real-Time Applications"">13</a>] explains as follows: "An example application is audio
conferencing where a mixer indicates all the talkers whose speech was
combined to produce the outgoing packet, allowing the receiver to
indicate the current talker, even though all the audio packets
contain the same SSRC identifier (that of the mixer)."
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
If an RTP mixer compliant to the above is used, participants can
perform an SSRC to user mapping and identify "a current speaker".
<span class="h4"><a class="selflink" id="section-5.8.5" href="#section-5.8.5">5.8.5</a>. <status></span>
The element <status> indicates the status in both directions of the
media stream and has the values "sendrecv", "sendonly", "recvonly",
or "inactive" as defined in SDP [<a href="#ref-3" title=""SDP: Session Description Protocol"">3</a>] and its later revision(s). Note
that value specifies the direction from the participant's point of
view. For example, a muted participant's stream will have the value
of "recvonly".
<span class="h3"><a class="selflink" id="section-5.9" href="#section-5.9">5.9</a>. Sidebars</span>
If a participant in the main conference joins a sidebar, a new <user>
element representing the user is created either as a part of a
separate sub-conference referenced from the <sidebars-by-ref> element
or under one of the <sidebars-by-val> elements as described below.
Note that the <user> in the main roster is not being deleted, but its
media statuses can be updated to reflect the effect being caused by
his/her participation in the sidebar. The display of this
information can vary among subscribers to the same conference
information, subject to local policies and to the subscriber role
both in the sidebar and in the main conference.
<span class="h4"><a class="selflink" id="section-5.9.1" href="#section-5.9.1">5.9.1</a>. <sidebars-by-ref></span>
This element contains a set of <entry> child elements, each
containing a sidebar conference URI. The recipient of the
information can then subscribe to sidebar information independently
from the main conference package subscription.
<span class="h4"><a class="selflink" id="section-5.9.2" href="#section-5.9.2">5.9.2</a>. <sidebars-by-val></span>
This element contains a set of <entry> child elements, each
containing information about a single sidebar. By using this element
of conference-type, the server can include a full or partial
description of each sidebar (as a sub-conference) in the body of the
main conference document.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. XML Schema</span>
<?xml version="1.0" encoding="UTF-8" ?>
<xs:schema
targetNamespace="urn:ietf:params:xml:ns:conference-info"
xmlns:tns="urn:ietf:params:xml:ns:conference-info"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
xmlns="urn:ietf:params:xml:ns:conference-info"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<!--
This imports the xml:language definition
-->
<xs:import namespace="http://www.w3.org/XML/1998/namespace"
schemaLocation="http://www.w3.org/2001/03/xml.xsd"/>
<!--
CONFERENCE ELEMENT
-->
<xs:element name="conference-info" type="conference-type"/>
<!--
CONFERENCE TYPE
-->
<xs:complexType name="conference-type">
<xs:sequence>
<xs:element name="conference-description"
type="conference-description-type" minOccurs="0"/>
<xs:element name="host-info"
type="host-type" minOccurs="0"/>
<xs:element name="conference-state"
type="conference-state-type" minOccurs="0"/>
<xs:element name="users"
type="users-type" minOccurs="0"/>
<xs:element name="sidebars-by-ref"
type="uris-type" minOccurs="0"/>
<xs:element name="sidebars-by-val"
type="sidebars-by-val-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="entity"
type="xs:anyURI" use="required"/>
<xs:attribute name="state"
type="state-type" use="optional" default="full"/>
<xs:attribute name="version"
type="xs:unsignedInt" use="optional"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
STATE TYPE
-->
<xs:simpleType name="state-type">
<xs:restriction base="xs:string">
<xs:enumeration value="full"/>
<xs:enumeration value="partial"/>
<xs:enumeration value="deleted"/>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
</xs:restriction>
</xs:simpleType>
<!--
CONFERENCE DESCRIPTION TYPE
-->
<xs:complexType name="conference-description-type">
<xs:sequence>
<xs:element name="display-text"
type="xs:string" minOccurs="0"/>
<xs:element name="subject"
type="xs:string" minOccurs="0"/>
<xs:element name="free-text"
type="xs:string" minOccurs="0"/>
<xs:element name="keywords"
type="keywords-type" minOccurs="0"/>
<xs:element name="conf-uris"
type="uris-type" minOccurs="0"/>
<xs:element name="service-uris"
type="uris-type" minOccurs="0"/>
<xs:element name="maximum-user-count"
type="xs:unsignedInt" minOccurs="0"/>
<xs:element name="available-media"
type="conference-media-type" minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
HOST TYPE
-->
<xs:complexType name="host-type">
<xs:sequence>
<xs:element name="display-text" type="xs:string"
minOccurs="0"/>
<xs:element name="web-page" type="xs:anyURI"
minOccurs="0"/>
<xs:element name="uris" type="uris-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
CONFERENCE STATE TYPE
-->
<xs:complexType name="conference-state-type">
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<xs:sequence>
<xs:element name="user-count" type="xs:unsignedInt"
minOccurs="0"/>
<xs:element name="active" type="xs:boolean"
minOccurs="0"/>
<xs:element name="locked" type="xs:boolean"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
CONFERENCE MEDIA TYPE
-->
<xs:complexType name="conference-media-type">
<xs:sequence>
<xs:element name="entry" type="conference-medium-type"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
CONFERENCE MEDIUM TYPE
-->
<xs:complexType name="conference-medium-type">
<xs:sequence>
<xs:element name="display-text" type="xs:string"
minOccurs="0"/>
<xs:element name="type" type="xs:string"/>
<xs:element name="status" type="media-status-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="label" type="xs:string"
use="required"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
URIs TYPE
-->
<xs:complexType name="uris-type">
<xs:sequence>
<xs:element name="entry" type="uri-type"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="state" type="state-type"
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
use="optional" default="full"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
URI TYPE
-->
<xs:complexType name="uri-type">
<xs:sequence>
<xs:element name="uri" type="xs:anyURI"/>
<xs:element name="display-text" type="xs:string"
minOccurs="0"/>
<xs:element name="purpose" type="xs:string"
minOccurs="0"/>
<xs:element name="modified" type="execution-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
KEYWORDS TYPE
-->
<xs:simpleType name="keywords-type">
<xs:list itemType="xs:string"/>
</xs:simpleType>
<!--
USERS TYPE
-->
<xs:complexType name="users-type">
<xs:sequence>
<xs:element name="user" type="user-type"
minOccurs="0" maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="state" type="state-type"
use="optional" default="full"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
USER TYPE
-->
<xs:complexType name="user-type">
<xs:sequence>
<xs:element name="display-text" type="xs:string"
minOccurs="0"/>
<xs:element name="associated-aors" type="uris-type"
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
minOccurs="0"/>
<xs:element name="roles" type="user-roles-type"
minOccurs="0"/>
<xs:element name="languages" type="user-languages-type"
minOccurs="0"/>
<xs:element name="cascaded-focus" type="xs:anyURI"
minOccurs="0"/>
<xs:element name="endpoint" type="endpoint-type"
minOccurs="0" maxOccurs="unbounded"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="entity" type="xs:anyURI"/>
<xs:attribute name="state" type="state-type"
use="optional" default="full"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
USER ROLES TYPE
-->
<xs:complexType name="user-roles-type">
<xs:sequence>
<xs:element name="entry" type="xs:string"
maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
USER LANGUAGES TYPE
-->
<xs:simpleType name="user-languages-type">
<xs:list itemType="xs:language"/>
</xs:simpleType>
<!--
ENDPOINT TYPE
-->
<xs:complexType name="endpoint-type">
<xs:sequence>
<xs:element name="display-text" type="xs:string"
minOccurs="0"/>
<xs:element name="referred" type="execution-type"
minOccurs="0"/>
<xs:element name="status" type="endpoint-status-type"
minOccurs="0"/>
<xs:element name="joining-method" type="joining-type"
minOccurs="0"/>
<xs:element name="joining-info"
type="execution-type"
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
minOccurs="0"/>
<xs:element name="disconnection-method"
type="disconnection-type"
minOccurs="0"/>
<xs:element name="disconnection-info"
type="execution-type"
minOccurs="0"/>
<xs:element name="media" type="media-type"
minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="call-info" type="call-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="entity" type="xs:string"/>
<xs:attribute name="state" type="state-type"
use="optional" default="full"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
ENDPOINT STATUS TYPE
-->
<xs:simpleType name="endpoint-status-type">
<xs:restriction base="xs:string">
<xs:enumeration value="pending"/>
<xs:enumeration value="dialing-out"/>
<xs:enumeration value="dialing-in"/>
<xs:enumeration value="alerting"/>
<xs:enumeration value="on-hold"/>
<xs:enumeration value="connected"/>
<xs:enumeration value="muted-via-focus"/>
<xs:enumeration value="disconnecting"/>
<xs:enumeration value="disconnected"/>
</xs:restriction>
</xs:simpleType>
<!--
JOINING TYPE
-->
<xs:simpleType name="joining-type">
<xs:restriction base="xs:string">
<xs:enumeration value="dialed-in"/>
<xs:enumeration value="dialed-out"/>
<xs:enumeration value="focus-owner"/>
</xs:restriction>
</xs:simpleType>
<!--
DISCONNECTION TYPE
-->
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<xs:simpleType name="disconnection-type">
<xs:restriction base="xs:string">
<xs:enumeration value="departed"/>
<xs:enumeration value="booted"/>
<xs:enumeration value="failed"/>
<xs:enumeration value="busy"/>
</xs:restriction>
</xs:simpleType>
<!--
EXECUTION TYPE
-->
<xs:complexType name="execution-type">
<xs:sequence>
<xs:element name="when" type="xs:dateTime"
minOccurs="0"/>
<xs:element name="reason" type="xs:string"
minOccurs="0"/>
<xs:element name="by" type="xs:anyURI"
minOccurs="0"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
CALL TYPE
-->
<xs:complexType name="call-type">
<xs:choice>
<xs:element name="sip" type="sip-dialog-id-type"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:choice>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
SIP DIALOG ID TYPE
-->
<xs:complexType name="sip-dialog-id-type">
<xs:sequence>
<xs:element name="display-text" type="xs:string"
minOccurs="0"/>
<xs:element name="call-id" type="xs:string"/>
<xs:element name="from-tag" type="xs:string"/>
<xs:element name="to-tag" type="xs:string"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<!--
MEDIA TYPE
-->
<xs:complexType name="media-type">
<xs:sequence>
<xs:element name="display-text" type="xs:string"
minOccurs="0"/>
<xs:element name="type" type="xs:string"
minOccurs="0"/>
<xs:element name="label" type="xs:string"
minOccurs="0"/>
<xs:element name="src-id" type="xs:string"
minOccurs="0"/>
<xs:element name="status" type="media-status-type"
minOccurs="0"/>
<xs:any namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="id" type="xs:string"
use="required"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
<!--
MEDIA STATUS TYPE
-->
<xs:simpleType name="media-status-type">
<xs:restriction base="xs:string">
<xs:enumeration value="recvonly"/>
<xs:enumeration value="sendonly"/>
<xs:enumeration value="sendrecv"/>
<xs:enumeration value="inactive"/>
</xs:restriction>
</xs:simpleType>
<!--
SIDEBARS BY VAL TYPE
-->
<xs:complexType name="sidebars-by-val-type">
<xs:sequence>
<xs:element name="entry" type="conference-type"
minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="state" type="state-type"
use="optional" default="full"/>
<xs:anyAttribute namespace="##other" processContents="lax"/>
</xs:complexType>
</xs:schema>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Examples</span>
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Basic Example</span>
The following is an example of a full conference information
document:
<?xml version="1.0" encoding="UTF-8"?>
<conference-info
xmlns="urn:ietf:params:xml:ns:conference-info"
entity="sips:conf233@example.com"
state="full" version="1">
<!--
CONFERENCE INFO
-->
<conference-description>
<subject>Agenda: This month's goals</subject>
<service-uris>
<entry>
<uri>http://sharepoint/salesgroup/</uri>
<purpose>web-page</purpose>
</entry>
</service-uris>
</conference-description>
<!--
CONFERENCE STATE
-->
<conference-state>
<user-count>33</user-count>
</conference-state>
<!--
USERS
-->
<users>
<user entity="sip:bob@example.com" state="full">
<display-text>Bob Hoskins</display-text>
<!--
ENDPOINTS
-->
<endpoint entity="sip:bob@pc33.example.com">
<display-text>Bob's Laptop</display-text>
<status>disconnected</status>
<disconnection-method>departed</disconnection-method>
<disconnection-info>
<when>2005-03-04T20:00:00Z</when>
<reason>bad voice quality</reason>
<by>sip:mike@example.com</by>
</disconnection-info>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<!--
MEDIA
-->
<media id="1">
<display-text>main audio</display-text>
<type>audio</type>
<label>34567</label>
<src-id>432424</src-id>
<status>sendrecv</status>
</media>
</endpoint>
</user>
<!--
USER
-->
<user entity="sip:alice@example.com" state="full">
<display-text>Alice</display-text>
<!--
ENDPOINTS
-->
<endpoint entity="sip:4kfk4j392jsu@example.com;grid=433kj4j3u">
<status>connected</status>
<joining-method>dialed-out</joining-method>
<joining-info>
<when>2005-03-04T20:00:00Z</when>
<by>sip:mike@example.com</by>
</joining-info>
<!--
MEDIA
-->
<media id="1">
<display-text>main audio</display-text>
<type>audio</type>
<label>34567</label>
<src-id>534232</src-id>
<status>sendrecv</status>
</media>
</endpoint>
</user>
</users>
</conference-info>
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Rich Example</span>
The following is an example of a partial conference information
document. In this example, there are 32 participants in a voice
conference. The user Bob has been ejected from the conference by
Mike due to bad voice quality. Note that there are three sidebars in
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
the conference; two are referenced just by their sidebar URIs, and
information about the third sidebar is included in this notification.
Also note that while this conference offers both audio and video
capabilities, only audio is currently in use.
<?xml version="1.0" encoding="UTF-8"?>
<conference-info
xmlns="urn:ietf:params:xml:ns:conference-info"
entity="sips:conf233@example.com"
state="partial" version="5">
<!--
CONFERENCE INFO
-->
<conference-description>
<display-text>Weekly Sales Meeting</display-text>
<subject>Agenda: This month's goals</subject>
<free-text>We will start strict on time</free-text>
<keywords>sales meeting weekly</keywords>
<conf-uris>
<entry>
<uri>tel:+18005671234</uri>
<display-text>TTI Bridge</display-text>
<purpose>participation</purpose>
</entry>
<entry>
<uri>h323:conf545@h323.example.com</uri>
<purpose>participation</purpose>
</entry>
<entry>
<uri>http://real.streaming.com/54634/live.ram</uri>
<purpose>streaming</purpose>
</entry>
</conf-uris>
<service-uris>
<entry>
<uri>http://sharepoint/salesgroup/</uri>
<purpose>web-page</purpose>
</entry>
<entry>
<uri>http://quicktime.com/54634/recording.mov</uri>
<display-text>Quicktime</display-text>
<purpose>recording</purpose>
</entry>
</service-uris>
<maximum-user-count>100</maximum-user-count>
<available-media>
<entry label="34567">
<display-text>main audio</display-text>
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<type>audio</type>
<status>sendrecv</status>
</entry>
<entry label="34569">
<display-text>main video</display-text>
<type>video</type>
<status>inactive</status>
</entry>
</available-media>
</conference-description>
<!--
HOST INFO
-->
<host-info>
<display-text>Sales Host</display-text>
<web-page>http://sharepoint/salesgroup/hosts/</web-page>
<uris>
<entry>
<uri>sip:sales@example.com</uri>
</entry>
</uris>
</host-info>
<!--
CONFERENCE STATE
-->
<conference-state>
<user-count>32</user-count>
<active>true</active>
<locked>false</locked>
</conference-state>
<!--
USERS
-->
<users>
<user entity="sip:bob@example.com">
<display-text>Bob Hoskins</display-text>
<associated-aors>
<entry>
<uri>mailto:bob@example.com</uri>
<display-text>email</display-text>
</entry>
</associated-aors>
<roles>
<entry>participant</entry>
</roles>
<languages>en</languages>
<!--
ENDPOINTS
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
-->
<endpoint entity="sip:bob@pc33.example.com">
<display-text>Bob's Laptop</display-text>
<referred>
<when>2005-03-04T20:00:00Z</when>
<reason>expert required</reason>
<by>sip:mike@example.com</by>
</referred>
<status>disconnecting</status>
<joining-method>dialed-out</joining-method>
<joining-info>
<when>2005-03-04T20:00:00Z</when>
<reason>invitation</reason>
<by>sip:mike@example.com</by>
</joining-info>
<disconnection-method>booted</disconnection-method>
<disconnection-info>
<when>2005-03-04T20:00:00Z</when>
<reason>bad voice quality</reason>
<by>sip:mike@example.com</by>
</disconnection-info>
<!--
MEDIA
-->
<media id="1">
<display-text>main audio</display-text>
<type>audio</type>
<label>34567</label>
<src-id>432424</src-id>
<status>sendrecv</status>
</media>
<!--
CALL INFO
-->
<call-info>
<sip>
<display-text>full info</display-text>
<call-id>hsjh8980vhsb78</call-id>
<from-tag>vav738dvbs</from-tag>
<to-tag>8954jgjg8432</to-tag>
</sip>
</call-info>
</endpoint>
</user>
</users>
<!--
SIDEBARS BY REFERENCE
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
-->
<sidebars-by-ref state="partial">
<entry>
<uri>sips:conf233@example.com;grid=45</uri>
<display-text>sidebar with Carol</display-text>
</entry>
<entry>
<uri>sips:conf233@example.com;grid=21</uri>
<display-text>private with Peter</display-text>
</entry>
</sidebars-by-ref>
<!--
SIDEBARS BY VALUE
-->
<sidebars-by-val state="partial">
<entry entity="sips:conf233@example.com;grid=77"
state="partial">
<users>
<user entity="sip:bob@example.com"/>
<user entity="sip:mark@example.com"/>
<user entity="sip:dan@example.com"/>
</users>
</entry>
</sidebars-by-val>
</conference-info>
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Security Considerations</span>
Subscriptions to conference state information can reveal very
sensitive information. For this reason, it is RECOMMENDED that a
focus use a strong means for authentication and conference
information protection and that it apply comprehensive authorization
rules when using the conference notification mechanism defined in
this document. The following sections will discuss each of these
aspects in more detail.
<span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Connection Security</span>
It is RECOMMENDED that a focus authenticate a conference package
subscriber using the normal SIP authentication mechanisms, such as
Digest as defined in <a href="./rfc3261#section-22">Section 22 of RFC 3261</a> [<a href="#ref-8" title=""SIP: Session Initiation Protocol"">8</a>].
The mechanism used for conveying the conference information MUST
ensure integrity and SHOULD ensure confidentially of the information.
In order to achieve these, an end-to-end SIP encryption mechanism,
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
such as S/MIME described in <a href="./rfc3261#section-26.2.4">Section 26.2.4 of RFC 3261</a> [<a href="#ref-8" title=""SIP: Session Initiation Protocol"">8</a>], SHOULD be
used.
If a strong end-to-end security means (such as above) is not
available, it is RECOMMENDED that a focus use mutual hop-by-hop
Transport Layer Security (TLS) authentication and encryption
mechanisms described in <a href="#section-26.2.2">Section 26.2.2</a> "SIPS URI Scheme" and <a href="#section-26.3.2.2">Section</a>
<a href="#section-26.3.2.2">26.3.2.2</a> "Interdomain Requests" of <a href="./rfc3261">RFC 3261</a> [<a href="#ref-8" title=""SIP: Session Initiation Protocol"">8</a>].
<span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Authorization Considerations</span>
Generally speaking, conference applications are very concerned about
authorization decisions. Mechanisms for establishing and enforcing
such authorization rules are a central concept throughout the SIP
Conferencing Framework [<a href="#ref-16" title=""A Framework for Conferencing with the Session Initiation Protocol (SIP)"">16</a>]. Because most of the information about a
conference can be presented using the conference package, many of the
authorization rules directly apply to this specification. As a
result, a notification server MUST be capable of generating distinct
conference information views to different subscribers, subject to a
subscriber's role in a conference, personal access rights, etc. - all
subject to local authorization policies and rules.
Since a focus provides participant identity information using this
event package, participant privacy needs to be taken into account. A
focus MUST support requests by participants for privacy. Privacy can
be indicated by the conference policy - for every participant or
select participants. It can also be indicated in the session
signaling. In SIP, this can be done using the Privacy header field
described in <a href="./rfc3323">RFC 3323</a> [<a href="#ref-11" title=""A Privacy Mechanism for the Session Initiation Protocol (SIP)"">11</a>]. For a participant requesting privacy, no
identity information SHOULD be revealed by the focus in any included
URI (e.g., the Address of Record, Contact, or GRUU). For these
cases, the anonymous URI generation method outlined in <a href="#section-5.6">Section 5.6</a> of
this document MUST be followed.
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. IANA Considerations</span>
This document registers a SIP event package, a new MIME type,
application/conference-info+xml, a new XML namespace, and a new XML
schema, and creates a sub-registry "URI purposes" under the existing
registry: <a href="http://www.iana.org/assignments/sip-parameters">http://www.iana.org/assignments/sip-parameters</a>.
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. conference Event Package Registration</span>
This specification registers an event package, based on the
registration procedures defined in <a href="./rfc3265">RFC 3265</a> [<a href="#ref-10" title=""Session Initiation Protocol (SIP)-Specific Event Notification"">10</a>]. The following is
the information required for such a registration:
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
Package Name: conference
Package or Template-Package: This is a package.
Published Document: <a href="./rfc4575">RFC 4575</a>
Person to Contact: IETF SIPPING Working Group <sipping@ietf.org>, as
designated by the IESG <iesg@ietf.org>
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. application/conference-info+xml MIME Registration</span>
MIME media type name: application
MIME subtype name: conference-info+xml
Mandatory parameters: none
Optional parameters: Same as charset parameter application/xml as
specified in <a href="./rfc3023">RFC 3023</a> [<a href="#ref-7" title=""XML Media Types"">7</a>]
Encoding considerations: Same as encoding considerations of
application/xml as specified in <a href="./rfc3023">RFC 3023</a> [<a href="#ref-7" title=""XML Media Types"">7</a>]
Security considerations: See <a href="./rfc3023#section-10">Section 10 of RFC 3023</a> [<a href="#ref-7" title=""XML Media Types"">7</a>] and
<a href="#section-8">Section 8</a> of this specification
Interoperability considerations: none
Published specification: This document
Applications which use this media type: This document type has been
used to support SIP conferencing applications
Additional Information:
Magic Number: None
File Extension: .xml
Macintosh file type code: "TEXT"
Personal and email address for further information: IETF SIPPING
Working Group <sipping@ietf.org>, as designated by the IESG
<iesg@ietf.org>
Intended usage: COMMON
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
Author/Change controller: IETF SIPPING Working Group
<sipping@ietf.org>, as designated by the IESG <iesg@ietf.org>
<span class="h3"><a class="selflink" id="section-9.3" href="#section-9.3">9.3</a>. URN Sub-Namespace Registration for</span>
<span class="h3"> urn:ietf:params:xml:ns:conference-info</span>
This section registers a new XML namespace, as per the guidelines in
<a href="./rfc3688">RFC 3688</a> [<a href="#ref-21" title=""The IETF XML Registry"">21</a>].
URI: The URI for this namespace is
urn:ietf:params:xml:ns:conference-info
Registrant Contact: IETF SIPPING Working Group <sipping@ietf.org>,
as designated by the IESG <iesg@ietf.org>
XML:
BEGIN
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN"
"<a href="http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd</a>">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type"
content="text/html;charset=iso-8859-1"/>
<title>Conference Information Namespace</title>
</head
<body>
<h1>Namespace for Conference Information</h1>
<h2>urn:ietf:params:xml:ns:conference-info</h2>
<p>See <a href="http://www.rfc-editor.org/rfc/rfc4575.txt">
<a href="./rfc4575">RFC4575</a></a>.</p>
</body>
</html>
END
<span class="h3"><a class="selflink" id="section-9.4" href="#section-9.4">9.4</a>. XML Schema Registration</span>
This specification registers a schema, as per the guidelines in <a href="./rfc3688">RFC</a>
<a href="./rfc3688">3688</a> [<a href="#ref-21" title=""The IETF XML Registry"">21</a>].
URI: please assign
Registrant Contact: IETF SIPPING Working Group <sipping@ietf.org>,
as designated by the IESG <iesg@ietf.org>
XML: The XML can be found as the sole content of <a href="#section-6">Section 6</a>.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
<span class="h3"><a class="selflink" id="section-9.5" href="#section-9.5">9.5</a>. URI Purposes Sub-registry Establishment</span>
The IANA has created a new sub-registry, "URI purposes", under the
already existing registry:
<a href="http://www.iana.org/assignments/sip-parameters">http://www.iana.org/assignments/sip-parameters</a>.
The purpose of a URI is an XML element, encoded in the conference
event package <a href="./rfc4575">RFC 4575</a>. The value of the <purpose> element indicates
the intended usage of the URI in the context of the conference event
package and is defined in Sections <a href="#section-5.3.1">5.3.1</a> and <a href="#section-5.3.2">5.3.2</a> of this
specification.
This sub-registry is defined as a table that contains the following
three columns:
Value: The token under registration
Description: A descriptive text defining the intended usage of the
URI
Document: A reference to the document defining the registration
The IANA has created the table with the initial content as defined
below:
Value Description Document
------- ---------------------------------- ----------
participation The URI can be used to join the [<a href="./rfc4575">RFC 4575</a>]
conference
streaming The URI can be used to access the [<a href="./rfc4575">RFC 4575</a>]
streamed conference data
event The URI can be used to subscribe [<a href="./rfc4575">RFC 4575</a>]
to the conference event package
recording The URI can be used to access the [<a href="./rfc4575">RFC 4575</a>]
recorded conference data
web-page The URI can be used to access a [<a href="./rfc4575">RFC 4575</a>]
web page that contains additional
information of the conference
New values of the "URI purposes" are registered by the IANA and are
specification required according to the definition of <a href="./rfc2434">RFC 2434</a> [<a href="#ref-4" title="">4</a>].
The IANA Considerations section of the specification MUST include the
following information:
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
Value: The value of the <purpose> element to be registered
Description: A short description of the intended usage of the URI
<span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Acknowledgements</span>
The authors would like to thank Dan Petrie, Sean Olson, Alan
Johnston, Rohan Mahy, Cullen Jennings, Brian Rosen, Roni Even, and
Miguel Garcia for their comments and inputs.
<span class="h2"><a class="selflink" id="section-11" href="#section-11">11</a>. References</span>
<span class="h3"><a class="selflink" id="section-11.1" href="#section-11.1">11.1</a>. Normative References</span>
[<a id="ref-1">1</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-2">2</a>] Moats, R., "URN Syntax", <a href="./rfc2141">RFC 2141</a>, May 1997.
[<a id="ref-3">3</a>] Handley, M., Jacobson, V. and C. Perkins, "SDP: Session
Description Protocol", <a href="./rfc4566">RFC 4566</a>, July 2006.
[<a id="ref-4">4</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="./rfc2434">RFC 2434</a>, October
1998.
[<a id="ref-5">5</a>] Eastlake 3rd, D. and A. Panitz, "Reserved Top Level DNS Names",
<a href="https://www.rfc-editor.org/bcp/bcp32">BCP 32</a>, <a href="./rfc2606">RFC 2606</a>, June 1999.
[<a id="ref-6">6</a>] Moats, R., "A URN Namespace for IETF Documents", <a href="./rfc2648">RFC 2648</a>,
August 1999.
[<a id="ref-7">7</a>] Murata, M., St. Laurent, S., and D. Kohn, "XML Media Types",
<a href="./rfc3023">RFC 3023</a>, January 2001.
[<a id="ref-8">8</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-9">9</a>] Rosenberg, J. and H. Schulzrinne, "An Offer/Answer Model with
Session Description Protocol (SDP)", <a href="./rfc3264">RFC 3264</a>, June 2002.
[<a id="ref-10">10</a>] Roach, A.B., "Session Initiation Protocol (SIP)-Specific Event
Notification", <a href="./rfc3265">RFC 3265</a>, June 2002.
[<a id="ref-11">11</a>] Peterson, J., "A Privacy Mechanism for the Session Initiation
Protocol (SIP)", <a href="./rfc3323">RFC 3323</a>, November 2002.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
[<a id="ref-12">12</a>] Schulzrinne, H., Oran, D., and G. Camarillo, "The Reason Header
Field for the Session Initiation Protocol (SIP)", <a href="./rfc3326">RFC 3326</a>,
December 2002.
[<a id="ref-13">13</a>] Schulzrinne, H., Casner, S., Frederick, R., and V. Jacobson,
"RTP: A Transport Protocol for Real-Time Applications", STD 64,
<a href="./rfc3550">RFC 3550</a>, July 2003.
[<a id="ref-14">14</a>] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD
63, <a href="./rfc3629">RFC 3629</a>, November 2003.
[<a id="ref-15">15</a>] Sparks, R., "The Session Initiation Protocol (SIP) Referred-By
Mechanism", <a href="./rfc3892">RFC 3892</a>, September 2004.
[<a id="ref-16">16</a>] Rosenberg, J., "A Framework for Conferencing with the Session
Initiation Protocol (SIP)", <a href="./rfc4353">RFC 4353</a>, February 2006.
[<a id="ref-17">17</a>] Levin, O. and G. Camarillo, "The Session Description Protocol
(SDP) Label Attribute", <a href="./rfc4574">RFC 4574</a>, August 2006.
<span class="h3"><a class="selflink" id="section-11.2" href="#section-11.2">11.2</a>. Informative References</span>
[<a id="ref-18">18</a>] Schulzrinne, H., Rao, A., and R. Lanphier, "Real Time Streaming
Protocol (RTSP)", <a href="./rfc2326">RFC 2326</a>, April 1998.
[<a id="ref-19">19</a>] Schulzrinne, H., "The tel URI for Telephone Numbers", <a href="./rfc3966">RFC 3966</a>,
December 2004.
[<a id="ref-20">20</a>] Levin, O., "H.323 Uniform Resource Locator (URL) Scheme
Registration", <a href="./rfc3508">RFC 3508</a>, April 2003.
[<a id="ref-21">21</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-22">22</a>] Saint-Andre, P., "A Uniform Resource Identifier (URI) Scheme
for the Extensible Messaging and Presence Protocol (XMPP)",
Work in Progress, December 2004.
[<a id="ref-23">23</a>] Rosenberg, J., Schulzrinne, H., and R. Mahy, "An INVITE-
Initiated Dialog Event Package for the Session Initiation
Protocol (SIP)", <a href="./rfc4235">RFC 4235</a>, November 2005.
[<a id="ref-24">24</a>] Rosenberg, J., "Obtaining and Using Globally Routable User
Agent (UA) URIs (GRUU) in the Session Initiation Protocol
(SIP)", Work in Progress, May 2006.
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
[<a id="ref-25">25</a>] Peterson, J. and C. Jennings, "Enhancements for Authenticated
Identity Management in the Session Initiation Protocol (SIP)",
<a href="./rfc4474">RFC 4474</a>, August 2006.
Authors' Addresses
Jonathan Rosenberg
Cisco Systems
600 Lanidex Plaza
Parsippany, NJ 07054
US
Phone: +1 973 952-5000
EMail: jdrosen@cisco.com
URI: <a href="http://www.jdrosen.net">http://www.jdrosen.net</a>
Henning Schulzrinne
Columbia University
M/S 0401
1214 Amsterdam Ave.
New York, NY 10027
US
EMail: schulzrinne@cs.columbia.edu
URI: <a href="http://www.cs.columbia.edu/~hgs">http://www.cs.columbia.edu/~hgs</a>
Orit Levin (editor)
Microsoft Corporation
One Microsoft Way
Redmond, WA 98052
US
EMail: oritl@microsoft.com
<span class="grey">Rosenberg, 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="./rfc4575">RFC 4575</a> Conference Package August 2006</span>
Full Copyright Statement
Copyright (C) The Internet Society (2006).
This document is subject to the rights, licenses and restrictions
contained in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>, and except as set forth therein, the authors
retain all their rights.
This document and the information contained herein are provided on an
"AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Intellectual Property
The IETF takes no position regarding the validity or scope of any
Intellectual Property Rights or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; nor does it represent that it has
made any independent effort to identify any such rights. Information
on the procedures with respect to rights in RFC documents can be
found in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>.
Copies of IPR disclosures made to the IETF Secretariat and any
assurances of licenses to be made available, or the result of an
attempt made to obtain a general license or permission for the use of
such proprietary rights by implementers or users of this
specification can be obtained from the IETF on-line IPR repository at
<a href="http://www.ietf.org/ipr">http://www.ietf.org/ipr</a>.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights that may cover technology that may be required to implement
this standard. Please address the information to the IETF at
ietf-ipr@ietf.org.
Acknowledgement
Funding for the RFC Editor function is provided by the IETF
Administrative Support Activity (IASA).
Rosenberg, et al. Standards Track [Page 48]
</pre>
|