/usr/share/doc/libosgi-compendium-java/api/info/dmtree/DmtSession.html is in libosgi-compendium-java-doc 4.3.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Mon Nov 21 22:05:27 UTC 2011 -->
<TITLE>
DmtSession
</TITLE>
<META NAME="date" CONTENT="2011-11-21">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DmtSession";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree"><B>PREV CLASS</B></A>
<A HREF="../../info/dmtree/MetaNode.html" title="interface in info.dmtree"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?info/dmtree/DmtSession.html" target="_top"><B>FRAMES</B></A>
<A HREF="DmtSession.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
info.dmtree</FONT>
<BR>
Interface DmtSession</H2>
<HR>
<DL>
<DT><PRE>public interface <B>DmtSession</B></DL>
</PRE>
<P>
DmtSession provides concurrent access to the DMT. All DMT manipulation
commands for management applications are available on the
<code>DmtSession</code> interface. The session is associated with a root node
which limits the subtree in which the operations can be executed within this
session.
<p>
Most of the operations take a node URI as parameter, which can be either an
absolute URI (starting with "./") or a URI relative to the root
node of the session. The empty string as relative URI means the root URI the
session was opened with. All segments of a URI must be within the segment
length limit of the implementation, and the special characters '/' and '\'
must be escaped (preceded by a '\'). Any string can be converted to a valid
URI segment using the <A HREF="../../info/dmtree/Uri.html#mangle(java.lang.String)"><CODE>Uri.mangle(String)</CODE></A> method.
<p>
If the URI specified does not correspond to a legitimate node in the tree an
exception is thrown. The only exception is the <A HREF="../../info/dmtree/DmtSession.html#isNodeUri(java.lang.String)"><CODE>isNodeUri(String)</CODE></A>
method which returns <code>false</code> in case of an invalid URI.
<p>
Each method of <code>DmtSession</code> that accesses the tree in any way can
throw <code>DmtIllegalStateException</code> if the session has been closed or
invalidated (due to timeout, fatal exceptions, or unexpectedly unregistered
plugins).
<P>
<P>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#LOCK_TYPE_ATOMIC">LOCK_TYPE_ATOMIC</A></B></CODE>
<BR>
<code>LOCK_TYPE_ATOMIC</code> is an exclusive lock with transactional
functionality.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#LOCK_TYPE_EXCLUSIVE">LOCK_TYPE_EXCLUSIVE</A></B></CODE>
<BR>
<code>LOCK_TYPE_EXCLUSIVE</code> lock guarantees full access to the
tree, but can not be shared with any other locks.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#LOCK_TYPE_SHARED">LOCK_TYPE_SHARED</A></B></CODE>
<BR>
Sessions created with <code>LOCK_TYPE_SHARED</code> lock allows
read-only access to the tree, but can be shared between multiple readers.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#STATE_CLOSED">STATE_CLOSED</A></B></CODE>
<BR>
The session is closed, DMT manipulation operations are not available,
they throw <code>DmtIllegalStateException</code> if tried.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#STATE_INVALID">STATE_INVALID</A></B></CODE>
<BR>
The session is invalid because a fatal error happened.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#STATE_OPEN">STATE_OPEN</A></B></CODE>
<BR>
The session is open, all session operations are available.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#close()">close</A></B>()</CODE>
<BR>
Closes a session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#commit()">commit</A></B>()</CODE>
<BR>
Commits a series of DMT operations issued in the current atomic session
since the last transaction boundary.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#copy(java.lang.String, java.lang.String, boolean)">copy</A></B>(java.lang.String nodeUri,
java.lang.String newNodeUri,
boolean recursive)</CODE>
<BR>
Create a copy of a node or a whole subtree.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String)">createInteriorNode</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Create an interior node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String, java.lang.String)">createInteriorNode</A></B>(java.lang.String nodeUri,
java.lang.String type)</CODE>
<BR>
Create an interior node with a given type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String)">createLeafNode</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Create a leaf node with default value and MIME type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String, info.dmtree.DmtData)">createLeafNode</A></B>(java.lang.String nodeUri,
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> value)</CODE>
<BR>
Create a leaf node with a given value and the default MIME type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String, info.dmtree.DmtData, java.lang.String)">createLeafNode</A></B>(java.lang.String nodeUri,
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> value,
java.lang.String mimeType)</CODE>
<BR>
Create a leaf node with a given value and MIME type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#deleteNode(java.lang.String)">deleteNode</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Delete the given node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#execute(java.lang.String, java.lang.String)">execute</A></B>(java.lang.String nodeUri,
java.lang.String data)</CODE>
<BR>
Executes a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#execute(java.lang.String, java.lang.String, java.lang.String)">execute</A></B>(java.lang.String nodeUri,
java.lang.String correlator,
java.lang.String data)</CODE>
<BR>
Executes a node, also specifying a correlation ID for use in response
notifications.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getChildNodeNames(java.lang.String)">getChildNodeNames</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the list of children names of a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../info/dmtree/Acl.html" title="class in info.dmtree">Acl</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getEffectiveNodeAcl(java.lang.String)">getEffectiveNodeAcl</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Gives the Access Control List in effect for a given node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getLockType()">getLockType</A></B>()</CODE>
<BR>
Gives the type of lock the session has.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../info/dmtree/MetaNode.html" title="interface in info.dmtree">MetaNode</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getMetaNode(java.lang.String)">getMetaNode</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the meta data which describes a given node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../info/dmtree/Acl.html" title="class in info.dmtree">Acl</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getNodeAcl(java.lang.String)">getNodeAcl</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the Access Control List associated with a given node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getNodeSize(java.lang.String)">getNodeSize</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the size of the data in a leaf node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.Date</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getNodeTimestamp(java.lang.String)">getNodeTimestamp</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the timestamp when the node was created or last modified.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getNodeTitle(java.lang.String)">getNodeTitle</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the title of a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getNodeType(java.lang.String)">getNodeType</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the type of a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getNodeValue(java.lang.String)">getNodeValue</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the data contained in a leaf or interior node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getNodeVersion(java.lang.String)">getNodeVersion</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Get the version of a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getPrincipal()">getPrincipal</A></B>()</CODE>
<BR>
Gives the name of the principal on whose behalf the session was created.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getRootUri()">getRootUri</A></B>()</CODE>
<BR>
Get the root URI associated with this session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getSessionId()">getSessionId</A></B>()</CODE>
<BR>
The unique identifier of the session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#getState()">getState</A></B>()</CODE>
<BR>
Get the current state of this session.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#isLeafNode(java.lang.String)">isLeafNode</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Tells whether a node is a leaf or an interior node of the DMT.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#isNodeUri(java.lang.String)">isNodeUri</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Check whether the specified URI corresponds to a valid node in the DMT.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#renameNode(java.lang.String, java.lang.String)">renameNode</A></B>(java.lang.String nodeUri,
java.lang.String newName)</CODE>
<BR>
Rename a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#rollback()">rollback</A></B>()</CODE>
<BR>
Rolls back a series of DMT operations issued in the current atomic
session since the last transaction boundary.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#setDefaultNodeValue(java.lang.String)">setDefaultNodeValue</A></B>(java.lang.String nodeUri)</CODE>
<BR>
Set the value of a leaf or interior node to its default.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#setNodeAcl(java.lang.String, info.dmtree.Acl)">setNodeAcl</A></B>(java.lang.String nodeUri,
<A HREF="../../info/dmtree/Acl.html" title="class in info.dmtree">Acl</A> acl)</CODE>
<BR>
Set the Access Control List associated with a given node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#setNodeTitle(java.lang.String, java.lang.String)">setNodeTitle</A></B>(java.lang.String nodeUri,
java.lang.String title)</CODE>
<BR>
Set the title property of a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#setNodeType(java.lang.String, java.lang.String)">setNodeType</A></B>(java.lang.String nodeUri,
java.lang.String type)</CODE>
<BR>
Set the type of a node.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../info/dmtree/DmtSession.html#setNodeValue(java.lang.String, info.dmtree.DmtData)">setNodeValue</A></B>(java.lang.String nodeUri,
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> data)</CODE>
<BR>
Set the value of a leaf or interior node.</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="LOCK_TYPE_SHARED"><!-- --></A><H3>
LOCK_TYPE_SHARED</H3>
<PRE>
static final int <B>LOCK_TYPE_SHARED</B></PRE>
<DL>
<DD>Sessions created with <code>LOCK_TYPE_SHARED</code> lock allows
read-only access to the tree, but can be shared between multiple readers.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#info.dmtree.DmtSession.LOCK_TYPE_SHARED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOCK_TYPE_EXCLUSIVE"><!-- --></A><H3>
LOCK_TYPE_EXCLUSIVE</H3>
<PRE>
static final int <B>LOCK_TYPE_EXCLUSIVE</B></PRE>
<DL>
<DD><code>LOCK_TYPE_EXCLUSIVE</code> lock guarantees full access to the
tree, but can not be shared with any other locks.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#info.dmtree.DmtSession.LOCK_TYPE_EXCLUSIVE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOCK_TYPE_ATOMIC"><!-- --></A><H3>
LOCK_TYPE_ATOMIC</H3>
<PRE>
static final int <B>LOCK_TYPE_ATOMIC</B></PRE>
<DL>
<DD><code>LOCK_TYPE_ATOMIC</code> is an exclusive lock with transactional
functionality. Commands of an atomic session will either fail or succeed
together, if a single command fails then the whole session will be rolled
back.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#info.dmtree.DmtSession.LOCK_TYPE_ATOMIC">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_OPEN"><!-- --></A><H3>
STATE_OPEN</H3>
<PRE>
static final int <B>STATE_OPEN</B></PRE>
<DL>
<DD>The session is open, all session operations are available.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#info.dmtree.DmtSession.STATE_OPEN">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_CLOSED"><!-- --></A><H3>
STATE_CLOSED</H3>
<PRE>
static final int <B>STATE_CLOSED</B></PRE>
<DL>
<DD>The session is closed, DMT manipulation operations are not available,
they throw <code>DmtIllegalStateException</code> if tried.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#info.dmtree.DmtSession.STATE_CLOSED">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="STATE_INVALID"><!-- --></A><H3>
STATE_INVALID</H3>
<PRE>
static final int <B>STATE_INVALID</B></PRE>
<DL>
<DD>The session is invalid because a fatal error happened. Fatal errors
include the timeout of the session, any DmtException with the 'fatal'
flag set, or the case when a plugin service is unregistered while in use
by the session. DMT manipulation operations are not available, they throw
<code>DmtIllegalStateException</code> if tried.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../constant-values.html#info.dmtree.DmtSession.STATE_INVALID">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getState()"><!-- --></A><H3>
getState</H3>
<PRE>
int <B>getState</B>()</PRE>
<DL>
<DD>Get the current state of this session.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the state of the session, one of <A HREF="../../info/dmtree/DmtSession.html#STATE_OPEN"><CODE>STATE_OPEN</CODE></A>,
<A HREF="../../info/dmtree/DmtSession.html#STATE_CLOSED"><CODE>STATE_CLOSED</CODE></A> and <A HREF="../../info/dmtree/DmtSession.html#STATE_INVALID"><CODE>STATE_INVALID</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getLockType()"><!-- --></A><H3>
getLockType</H3>
<PRE>
int <B>getLockType</B>()</PRE>
<DL>
<DD>Gives the type of lock the session has.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the lock type of the session, one of <A HREF="../../info/dmtree/DmtSession.html#LOCK_TYPE_SHARED"><CODE>LOCK_TYPE_SHARED</CODE></A>,
<A HREF="../../info/dmtree/DmtSession.html#LOCK_TYPE_EXCLUSIVE"><CODE>LOCK_TYPE_EXCLUSIVE</CODE></A> and <A HREF="../../info/dmtree/DmtSession.html#LOCK_TYPE_ATOMIC"><CODE>LOCK_TYPE_ATOMIC</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getPrincipal()"><!-- --></A><H3>
getPrincipal</H3>
<PRE>
java.lang.String <B>getPrincipal</B>()</PRE>
<DL>
<DD>Gives the name of the principal on whose behalf the session was created.
Local sessions do not have an associated principal, in this case
<code>null</code> is returned.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the identifier of the remote server that initiated the session,
or <code>null</code> for local sessions</DL>
</DD>
</DL>
<HR>
<A NAME="getSessionId()"><!-- --></A><H3>
getSessionId</H3>
<PRE>
int <B>getSessionId</B>()</PRE>
<DL>
<DD>The unique identifier of the session. The ID is generated automatically,
and it is guaranteed to be unique on a machine.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the session identification number</DL>
</DD>
</DL>
<HR>
<A NAME="getRootUri()"><!-- --></A><H3>
getRootUri</H3>
<PRE>
java.lang.String <B>getRootUri</B>()</PRE>
<DL>
<DD>Get the root URI associated with this session. Gives "<code>.</code>"
if the session was created without specifying a root, which means that
the target of this session is the whole DMT.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the root URI</DL>
</DD>
</DL>
<HR>
<A NAME="commit()"><!-- --></A><H3>
commit</H3>
<PRE>
void <B>commit</B>()
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Commits a series of DMT operations issued in the current atomic session
since the last transaction boundary. Transaction boundaries are the
creation of this object that starts the session, and all subsequent
<A HREF="../../info/dmtree/DmtSession.html#commit()"><CODE>commit()</CODE></A> and <A HREF="../../info/dmtree/DmtSession.html#rollback()"><CODE>rollback()</CODE></A> calls.
<p>
This method can fail even if all operations were successful. This can
happen due to some multi-node semantic constraints defined by a specific
implementation. For example, node A can be required to always have
children A/B, A/C and A/D. If this condition is broken when
<code>commit()</code> is executed, the method will fail, and throw a
<code>METADATA_MISMATCH</code> exception.
<p>
An error situation can arise due to the lack of a two phase commit
mechanism in the underlying plugins. As an example, if plugin A has
committed successfully but plugin B failed, the whole session must fail,
but there is no way to undo the commit performed by A. To provide
predictable behaviour, the commit operation should continue with the
remaining plugins even after detecting a failure. All exceptions received
from failed commits are aggregated into one
<code>TRANSACTION_ERROR</code> exception thrown by this method.
<p>
In many cases the tree is not the only way to manage a given part of the
system. It may happen that while modifying some nodes in an atomic
session, the underlying settings are modified in parallel outside the
scope of the DMT. If this is detected during commit, an exception with
the code <code>CONCURRENT_ACCESS</code> is thrown.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>METADATA_MISMATCH</code> if the operation failed
because of meta-data restrictions
<li><code>CONCURRENT_ACCESS</code> if it is detected that some
modification has been made outside the scope of the DMT to the
nodes affected in the session's operations
<li><code>TRANSACTION_ERROR</code> if an error occurred during
the commit of any of the underlying plugins
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was not opened using the
<code>LOCK_TYPE_ATOMIC</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation</DL>
</DD>
</DL>
<HR>
<A NAME="rollback()"><!-- --></A><H3>
rollback</H3>
<PRE>
void <B>rollback</B>()
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Rolls back a series of DMT operations issued in the current atomic
session since the last transaction boundary. Transaction boundaries are
the creation of this object that starts the session, and all subsequent
<A HREF="../../info/dmtree/DmtSession.html#commit()"><CODE>commit()</CODE></A> and <A HREF="../../info/dmtree/DmtSession.html#rollback()"><CODE>rollback()</CODE></A> calls.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the error code <code>ROLLBACK_FAILED</code>
in case the rollback did not succeed
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was not opened using the
<code>LOCK_TYPE_ATOMIC</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation</DL>
</DD>
</DL>
<HR>
<A NAME="close()"><!-- --></A><H3>
close</H3>
<PRE>
void <B>close</B>()
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Closes a session. If the session was opened with atomic lock mode, the
<code>DmtSession</code> must first persist the changes made to the DMT
by calling <code>commit()</code> on all (transactional) plugins
participating in the session. See the documentation of the
<A HREF="../../info/dmtree/DmtSession.html#commit()"><CODE>commit()</CODE></A> method for details and possible errors during this
operation.
<p>
The state of the session changes to <code>DmtSession.STATE_CLOSED</code>
if the close operation completed successfully, otherwise it becomes
<code>DmtSession.STATE_INVALID</code>.
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>METADATA_MISMATCH</code> in case of atomic sessions,
if the commit operation failed because of meta-data restrictions
<li><code>CONCURRENT_ACCESS</code> in case of atomic sessions,
if the commit operation failed because of some modification
outside the scope of the DMT to the nodes affected in the session
<li><code>TRANSACTION_ERROR</code> in case of atomic sessions,
if an underlying plugin failed to commit
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if an underlying plugin failed
to close, or if some unspecified error is encountered while
attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation</DL>
</DD>
</DL>
<HR>
<A NAME="execute(java.lang.String, java.lang.String)"><!-- --></A><H3>
execute</H3>
<PRE>
void <B>execute</B>(java.lang.String nodeUri,
java.lang.String data)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Executes a node. This corresponds to the EXEC operation in OMA DM. This
method cannot be called in a read-only session.
<p>
The semantics of an execute operation and the data parameter it takes
depends on the definition of the managed object on which the command is
issued.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the node on which the execute operation is issued<DD><CODE>data</CODE> - the parameter of the execute operation, can be
<code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if the node does not exist and
the plugin does not allow executing unexisting nodes
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Execute</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if the node cannot be
executed according to the meta-data (does not have
<code>MetaNode.CMD_EXECUTE</code> access type)
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, if no DmtExecPlugin is associated with
the node and the DmtAdmin can not execute the node, or if some
unspecified error is encountered while attempting to complete the
command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Exec action
present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtSession.html#execute(java.lang.String, java.lang.String, java.lang.String)"><CODE>execute(String, String, String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="execute(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
execute</H3>
<PRE>
void <B>execute</B>(java.lang.String nodeUri,
java.lang.String correlator,
java.lang.String data)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Executes a node, also specifying a correlation ID for use in response
notifications. This operation corresponds to the EXEC command in OMA DM.
This method cannot be called in a read-only session.
<p>
The semantics of an execute operation and the data parameter it takes
depends on the definition of the managed object on which the command is
issued. If a correlation ID is specified, it should be used as the
<code>correlator</code> parameter for notifications sent in response to this
execute operation.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the node on which the execute operation is issued<DD><CODE>correlator</CODE> - an identifier to associate this operation with any
notifications sent in response to it, can be <code>null</code> if not
needed<DD><CODE>data</CODE> - the parameter of the execute operation, can be
<code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if the node does not exist and
the plugin does not allow executing unexisting nodes
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Execute</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if the node cannot be
executed according to the meta-data (does not have
<code>MetaNode.CMD_EXECUTE</code> access type)
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, if no DmtExecPlugin is associated with
the node, or if some unspecified error is encountered while
attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Exec action
present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtSession.html#execute(java.lang.String, java.lang.String)"><CODE>execute(String, String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getNodeAcl(java.lang.String)"><!-- --></A><H3>
getNodeAcl</H3>
<PRE>
<A HREF="../../info/dmtree/Acl.html" title="class in info.dmtree">Acl</A> <B>getNodeAcl</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the Access Control List associated with a given node. The returned
<code>Acl</code> object does not take inheritance into account, it
gives the ACL specifically given to the node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>the Access Control List belonging to the node or
<code>null</code> if none defined
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (the node does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - in case of local sessions, if the caller does
not have <code>DmtPermission</code> for the node with the Get
action present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtSession.html#getEffectiveNodeAcl(java.lang.String)"><CODE>getEffectiveNodeAcl(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getEffectiveNodeAcl(java.lang.String)"><!-- --></A><H3>
getEffectiveNodeAcl</H3>
<PRE>
<A HREF="../../info/dmtree/Acl.html" title="class in info.dmtree">Acl</A> <B>getEffectiveNodeAcl</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Gives the Access Control List in effect for a given node. The returned
<code>Acl</code> takes inheritance into account, that is if there is no
ACL defined for the node, it will be derived from the closest ancestor
having an ACL defined.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>the Access Control List belonging to the node
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (the node does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - in case of local sessions, if the caller does
not have <code>DmtPermission</code> for the node with the Get
action present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtSession.html#getNodeAcl(java.lang.String)"><CODE>getNodeAcl(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setNodeAcl(java.lang.String, info.dmtree.Acl)"><!-- --></A><H3>
setNodeAcl</H3>
<PRE>
void <B>setNodeAcl</B>(java.lang.String nodeUri,
<A HREF="../../info/dmtree/Acl.html" title="class in info.dmtree">Acl</A> acl)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Set the Access Control List associated with a given node. To perform this
operation, the caller needs to have replace rights (<code>Acl.REPLACE</code>
or the corresponding Java permission depending on the session type) as
described below:
<ul>
<li>if <code>nodeUri</code> specifies a leaf node, replace rights are
needed on the parent of the node
<li>if <code>nodeUri</code> specifies an interior node, replace rights
on either the node or its parent are sufficient
</ul>
<p>
If the given <code>acl</code> is <code>null</code> or an empty ACL
(not specifying any permissions for any principals), then the ACL of the
node is deleted, and the node will inherit the ACL from its parent node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node<DD><CODE>acl</CODE> - the Access Control List to be set on the node, can be
<code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node or its parent
(see above) does not allow the <code>Replace</code> operation
for the associated principal
<li><code>COMMAND_NOT_ALLOWED</code> if the command attempts
to set the ACL of the root node not to include Add rights for all
principals
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - in case of local sessions, if the caller does
not have <code>DmtPermission</code> for the node or its parent
(see above) with the Replace action present</DL>
</DD>
</DL>
<HR>
<A NAME="copy(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
copy</H3>
<PRE>
void <B>copy</B>(java.lang.String nodeUri,
java.lang.String newNodeUri,
boolean recursive)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Create a copy of a node or a whole subtree. Beside the structure and
values of the nodes, most properties are also copied, with the exception
of the ACL (Access Control List), Timestamp and Version properties.
<p>
The copy method is essentially a convenience method that could be
substituted with a sequence of retrieval and update operations. This
determines the permissions required for copying. However, some
optimization can be possible if the source and target nodes are all
handled by DmtAdmin or by the same plugin. In this case, the handler
might be able to perform the underlying management operation more
efficiently: for example, a configuration table can be copied at once
instead of reading each node for each entry and creating it in the new
tree.
<p>
This method may result in any of the errors possible for the contributing
operations. Most of these are collected in the exception descriptions
below, but for the full list also consult the documentation of
<A HREF="../../info/dmtree/DmtSession.html#getChildNodeNames(java.lang.String)"><CODE>getChildNodeNames(String)</CODE></A>, <A HREF="../../info/dmtree/DmtSession.html#isLeafNode(java.lang.String)"><CODE>isLeafNode(String)</CODE></A>,
<A HREF="../../info/dmtree/DmtSession.html#getNodeValue(java.lang.String)"><CODE>getNodeValue(String)</CODE></A>, <A HREF="../../info/dmtree/DmtSession.html#getNodeType(java.lang.String)"><CODE>getNodeType(String)</CODE></A>,
<A HREF="../../info/dmtree/DmtSession.html#getNodeTitle(java.lang.String)"><CODE>getNodeTitle(String)</CODE></A>, <A HREF="../../info/dmtree/DmtSession.html#setNodeTitle(java.lang.String, java.lang.String)"><CODE>setNodeTitle(String, String)</CODE></A>,
<A HREF="../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String, info.dmtree.DmtData, java.lang.String)"><CODE>createLeafNode(String, DmtData, String)</CODE></A> and
<A HREF="../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String, java.lang.String)"><CODE>createInteriorNode(String, String)</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the node or root of a subtree to be copied<DD><CODE>newNodeUri</CODE> - the URI of the new node or root of a subtree<DD><CODE>recursive</CODE> - <code>false</code> if only a single node is copied,
<code>true</code> if the whole subtree is copied
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or
<code>newNodeUri</code> or any segment of them is too long, or
if they have too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> or
<code>newNodeUri</code> is <code>null</code> or syntactically
invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node, or if <code>newNodeUri</code>
points to a node that cannot exist in the tree according to the
meta-data (see <A HREF="../../info/dmtree/DmtSession.html#getMetaNode(java.lang.String)"><CODE>getMetaNode(String)</CODE></A>)
<li><code>NODE_ALREADY_EXISTS</code> if
<code>newNodeUri</code> points to a node that already exists
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the copied node(s)
does not allow the <code>Get</code> operation, or the ACL of
the parent of the target node does not allow the <code>Add</code>
operation for the associated principal
<li><code>COMMAND_NOT_ALLOWED</code> if <code>nodeUri</code>
is an ancestor of <code>newNodeUri</code>, or if any of the
implied retrieval or update operations are not allowed
<li><code>METADATA_MISMATCH</code> if any of the meta-data
constraints of the implied retrieval or update operations are
violated
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if either URI is not within
the current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the copied node(s) with the Get
action present, or for the parent of the target node with the Add
action</DL>
</DD>
</DL>
<HR>
<A NAME="createInteriorNode(java.lang.String)"><!-- --></A><H3>
createInteriorNode</H3>
<PRE>
void <B>createInteriorNode</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Create an interior node. If the parent node does not exist, it is created
automatically, as if this method were called for the parent URI. This way
all missing ancestor nodes leading to the specified node are created. Any
exceptions encountered while creating the ancestors are propagated to the
caller of this method, these are not explicitly listed in the error
descriptions below.
<p>
If meta-data is available for the node, several checks are made before
creating it. The node must have <code>MetaNode.CMD_ADD</code> access
type, it must be defined as a non-permanent interior node, the node name
must conform to the valid names, and the creation of the new node must
not cause the maximum occurrence number to be exceeded.
<p>
If the meta-data cannot be retrieved because the given node cannot
possibly exist in the tree (it is not defined in the specification), the
<code>NODE_NOT_FOUND</code> error code is returned (see
<A HREF="../../info/dmtree/DmtSession.html#getMetaNode(java.lang.String)"><CODE>getMetaNode(String)</CODE></A>).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node to create
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a node that cannot exist in the tree (see above)
<li><code>NODE_ALREADY_EXISTS</code> if <code>nodeUri</code>
points to a node that already exists
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the parent node does
not allow the <code>Add</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the parent node is not
an interior node, or in non-atomic sessions if the underlying
plugin is read-only or does not support non-atomic writing
<li><code>METADATA_MISMATCH</code> if the node could not be
created because of meta-data restrictions (see above)
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the parent node with the Add
action present</DL>
</DD>
</DL>
<HR>
<A NAME="createInteriorNode(java.lang.String, java.lang.String)"><!-- --></A><H3>
createInteriorNode</H3>
<PRE>
void <B>createInteriorNode</B>(java.lang.String nodeUri,
java.lang.String type)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Create an interior node with a given type. The type of interior node, if
specified, is a URI identifying a DDF document. If the parent node does
not exist, it is created automatically, as if
<A HREF="../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String)"><CODE>createInteriorNode(String)</CODE></A> were called for the parent URI. This
way all missing ancestor nodes leading to the specified node are created.
Any exceptions encountered while creating the ancestors are propagated to
the caller of this method, these are not explicitly listed in the error
descriptions below.
<p>
If meta-data is available for the node, several checks are made before
creating it. The node must have <code>MetaNode.CMD_ADD</code> access
type, it must be defined as a non-permanent interior node, the node name
must conform to the valid names, and the creation of the new node must
not cause the maximum occurrence number to be exceeded.
<p>
If the meta-data cannot be retrieved because the given node cannot
possibly exist in the tree (it is not defined in the specification), the
<code>NODE_NOT_FOUND</code> error code is returned (see
<A HREF="../../info/dmtree/DmtSession.html#getMetaNode(java.lang.String)"><CODE>getMetaNode(String)</CODE></A>).
<p>
Interior node type identifiers must follow the format defined in section
7.7.7.2 of the OMA Device Management Tree and Description document.
Checking the validity of the type string does not have to be done by the
DmtAdmin, this can be left to the plugin handling the node (if any), to
avoid unnecessary double-checks.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node to create<DD><CODE>type</CODE> - the type URI of the interior node, can be <code>null</code>
if no node type is defined
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a node that cannot exist in the tree (see above)
<li><code>NODE_ALREADY_EXISTS</code> if <code>nodeUri</code>
points to a node that already exists
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the parent node does
not allow the <code>Add</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the parent node is not
an interior node, or in non-atomic sessions if the underlying
plugin is read-only or does not support non-atomic writing
<li><code>METADATA_MISMATCH</code> if the node could not be
created because of meta-data restrictions (see above)
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, if the type string is invalid (see
above), or if some unspecified error is encountered while
attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the parent node with the Add
action present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String)"><CODE>createInteriorNode(String)</CODE></A>,
<a
href="http://member.openmobilealliance.org/ftp/public_documents/dm/Permanent_documents/OMA-TS-DM-TND-V1_2-20050615-C.zip">
OMA Device Management Tree and Description v1.2 draft</a></DL>
</DD>
</DL>
<HR>
<A NAME="createLeafNode(java.lang.String)"><!-- --></A><H3>
createLeafNode</H3>
<PRE>
void <B>createLeafNode</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Create a leaf node with default value and MIME type. If a node does not
have a default value or MIME type, this method will throw a
<code>DmtException</code> with error code
<code>METADATA_MISMATCH</code>. Note that a node might have a default
value or MIME type even if there is no meta-data for the node or its
meta-data does not specify the default.
<p>
If the parent node does not exist, it is created automatically, as if
<A HREF="../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String)"><CODE>createInteriorNode(String)</CODE></A> were called for the parent URI. This
way all missing ancestor nodes leading to the specified node are created.
Any exceptions encountered while creating the ancestors are propagated to
the caller of this method, these are not explicitly listed in the error
descriptions below.
<p>
If meta-data is available for a node, several checks are made before
creating it. The node must have <code>MetaNode.CMD_ADD</code> access
type, it must be defined as a non-permanent leaf node, the node name must
conform to the valid names, and the creation of the new node must not
cause the maximum occurrence number to be exceeded.
<p>
If the meta-data cannot be retrieved because the given node cannot
possibly exist in the tree (it is not defined in the specification), the
<code>NODE_NOT_FOUND</code> error code is returned (see
<A HREF="../../info/dmtree/DmtSession.html#getMetaNode(java.lang.String)"><CODE>getMetaNode(String)</CODE></A>).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node to create
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a node that cannot exist in the tree (see above)
<li><code>NODE_ALREADY_EXISTS</code> if <code>nodeUri</code>
points to a node that already exists
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the parent node does
not allow the <code>Add</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the parent node is not
an interior node, or in non-atomic sessions if the underlying
plugin is read-only or does not support non-atomic writing
<li><code>METADATA_MISMATCH</code> if the node could not be
created because of meta-data restrictions (see above)
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the parent node with the Add
action present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String, info.dmtree.DmtData)"><CODE>createLeafNode(String, DmtData)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="createLeafNode(java.lang.String, info.dmtree.DmtData)"><!-- --></A><H3>
createLeafNode</H3>
<PRE>
void <B>createLeafNode</B>(java.lang.String nodeUri,
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> value)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Create a leaf node with a given value and the default MIME type. If the
specified value is <code>null</code>, the default value is taken. If
the node does not have a default MIME type or value (if needed), this
method will throw a <code>DmtException</code> with error code
<code>METADATA_MISMATCH</code>. Note that a node might have a default
value or MIME type even if there is no meta-data for the node or its
meta-data does not specify the default.
<p>
If the parent node does not exist, it is created automatically, as if
<A HREF="../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String)"><CODE>createInteriorNode(String)</CODE></A> were called for the parent URI. This
way all missing ancestor nodes leading to the specified node are created.
Any exceptions encountered while creating the ancestors are propagated to
the caller of this method, these are not explicitly listed in the error
descriptions below.
<p>
If meta-data is available for a node, several checks are made before
creating it. The node must have <code>MetaNode.CMD_ADD</code> access
type, it must be defined as a non-permanent leaf node, the node name must
conform to the valid names, the node value must conform to the value
constraints, and the creation of the new node must not cause the maximum
occurrence number to be exceeded.
<p>
If the meta-data cannot be retrieved because the given node cannot
possibly exist in the tree (it is not defined in the specification), the
<code>NODE_NOT_FOUND</code> error code is returned (see
<A HREF="../../info/dmtree/DmtSession.html#getMetaNode(java.lang.String)"><CODE>getMetaNode(String)</CODE></A>).
<p>
Nodes of <code>null</code> format can be created by using
<A HREF="../../info/dmtree/DmtData.html#NULL_VALUE"><CODE>DmtData.NULL_VALUE</CODE></A> as second argument.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node to create<DD><CODE>value</CODE> - the value to be given to the new node, can be
<code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a node that cannot exist in the tree (see above)
<li><code>NODE_ALREADY_EXISTS</code> if <code>nodeUri</code>
points to a node that already exists
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the parent node does
not allow the <code>Add</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the parent node is not
an interior node, or in non-atomic sessions if the underlying
plugin is read-only or does not support non-atomic writing
<li><code>METADATA_MISMATCH</code> if the node could not be
created because of meta-data restrictions (see above)
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the parent node with the Add
action present</DL>
</DD>
</DL>
<HR>
<A NAME="createLeafNode(java.lang.String, info.dmtree.DmtData, java.lang.String)"><!-- --></A><H3>
createLeafNode</H3>
<PRE>
void <B>createLeafNode</B>(java.lang.String nodeUri,
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> value,
java.lang.String mimeType)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Create a leaf node with a given value and MIME type. If the specified
value or MIME type is <code>null</code>, their default values are
taken. If the node does not have the necessary defaults, this method will
throw a <code>DmtException</code> with error code
<code>METADATA_MISMATCH</code>. Note that a node might have a default
value or MIME type even if there is no meta-data for the node or its
meta-data does not specify the default.
<p>
If the parent node does not exist, it is created automatically, as if
<A HREF="../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String)"><CODE>createInteriorNode(String)</CODE></A> were called for the parent URI. This
way all missing ancestor nodes leading to the specified node are created.
Any exceptions encountered while creating the ancestors are propagated to
the caller of this method, these are not explicitly listed in the error
descriptions below.
<p>
If meta-data is available for a node, several checks are made before
creating it. The node must have <code>MetaNode.CMD_ADD</code> access
type, it must be defined as a non-permanent leaf node, the node name must
conform to the valid names, the node value must conform to the value
constraints, the MIME type must be among the listed types, and the
creation of the new node must not cause the maximum occurrence number to
be exceeded.
<p>
If the meta-data cannot be retrieved because the given node cannot
possibly exist in the tree (it is not defined in the specification), the
<code>NODE_NOT_FOUND</code> error code is returned (see
<A HREF="../../info/dmtree/DmtSession.html#getMetaNode(java.lang.String)"><CODE>getMetaNode(String)</CODE></A>).
<p>
Nodes of <code>null</code> format can be created by using
<A HREF="../../info/dmtree/DmtData.html#NULL_VALUE"><CODE>DmtData.NULL_VALUE</CODE></A> as second argument.
<p>
The MIME type string must conform to the definition in RFC 2045. Checking
its validity does not have to be done by the DmtAdmin, this can be left
to the plugin handling the node (if any), to avoid unnecessary
double-checks.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node to create<DD><CODE>value</CODE> - the value to be given to the new node, can be
<code>null</code><DD><CODE>mimeType</CODE> - the MIME type to be given to the new node, can be
<code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a node that cannot exist in the tree (see above)
<li><code>NODE_ALREADY_EXISTS</code> if <code>nodeUri</code>
points to a node that already exists
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the parent node does
not allow the <code>Add</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the parent node is not
an interior node, or in non-atomic sessions if the underlying
plugin is read-only or does not support non-atomic writing
<li><code>METADATA_MISMATCH</code> if the node could not be
created because of meta-data restrictions (see above)
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, if <code>mimeType</code> is not a
proper MIME type string (see above), or if some unspecified error
is encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the parent node with the Add
action present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String, info.dmtree.DmtData)"><CODE>createLeafNode(String, DmtData)</CODE></A>,
<a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a></DL>
</DD>
</DL>
<HR>
<A NAME="deleteNode(java.lang.String)"><!-- --></A><H3>
deleteNode</H3>
<PRE>
void <B>deleteNode</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Delete the given node. Deleting interior nodes is recursive, the whole
subtree under the given node is deleted. It is not allowed to delete
the root node of the session.
<p>
If meta-data is available for a node, several checks are made before
deleting it. The node must be non-permanent, it must have the
<code>MetaNode.CMD_DELETE</code> access type, and if zero occurrences
of the node are not allowed, it must not be the last one.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Delete</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the target node is the
root of the session, or in non-atomic sessions if the underlying
plugin is read-only or does not support non-atomic writing
<li><code>METADATA_MISMATCH</code> if the node could not be
deleted because of meta-data restrictions (see above)
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Delete action
present</DL>
</DD>
</DL>
<HR>
<A NAME="renameNode(java.lang.String, java.lang.String)"><!-- --></A><H3>
renameNode</H3>
<PRE>
void <B>renameNode</B>(java.lang.String nodeUri,
java.lang.String newName)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Rename a node. This operation only changes the name of the node (updating
the timestamp and version properties if they are supported), the value
and the other properties are not changed. The new name of the node must
be provided, the new URI is constructed from the base of the old URI and
the given name. It is not allowed to rename the root node of the session.
<p>
If available, the meta-data of the original and the new nodes are checked
before performing the rename operation. Neither node can be permanent,
their leaf/interior property must match, and the name change must not
violate any of the cardinality constraints. The original node must have
the <code>MetaNode.CMD_REPLACE</code> access type, and the name of the
new node must conform to the valid names.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node to rename<DD><CODE>newName</CODE> - the new name property of the node
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, if <code>nodeUri</code> has too many
segments, or if <code>newName</code> is too long
<li><code>INVALID_URI</code> if <code>nodeUri</code> or
<code>newName</code> is <code>null</code> or syntactically
invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node, or if the new node is not defined
in the tree according to the meta-data (see
<A HREF="../../info/dmtree/DmtSession.html#getMetaNode(java.lang.String)"><CODE>getMetaNode(String)</CODE></A>)
<li><code>NODE_ALREADY_EXISTS</code> if there already exists a
sibling of <code>nodeUri</code> with the name
<code>newName</code>
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Replace</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the target node is the
root of the session, or in non-atomic sessions if the underlying
plugin is read-only or does not support non-atomic writing
<li><code>METADATA_MISMATCH</code> if the node could not be
renamed because of meta-data restrictions (see above)
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Replace action
present</DL>
</DD>
</DL>
<HR>
<A NAME="setDefaultNodeValue(java.lang.String)"><!-- --></A><H3>
setDefaultNodeValue</H3>
<PRE>
void <B>setDefaultNodeValue</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Set the value of a leaf or interior node to its default. The default
can be defined by the node's <code>MetaNode</code>. The method throws a
<code>METADATA_MISMATCH</code> exception if the node does not have a
default value.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Replace</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> in non-atomic sessions if
the underlying plugin is read-only or does not support non-atomic
writing
<li><code>METADATA_MISMATCH</code> if the node is permanent or
cannot be modified according to the meta-data (does not have the
<code>MetaNode.CMD_REPLACE</code> access type), or if there is
no default value defined for this node
<li><code>FEATURE_NOT_SUPPORTED</code> if the specified node is
an interior node and does not support Java object values
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Replace action
present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtSession.html#setNodeValue(java.lang.String, info.dmtree.DmtData)"><CODE>setNodeValue(java.lang.String, info.dmtree.DmtData)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setNodeValue(java.lang.String, info.dmtree.DmtData)"><!-- --></A><H3>
setNodeValue</H3>
<PRE>
void <B>setNodeValue</B>(java.lang.String nodeUri,
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> data)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Set the value of a leaf or interior node. The format of the node is
contained in the <code>DmtData</code> object. For interior nodes, the
format must be <code>FORMAT_NODE</code>, while for leaf nodes this
format must not be used.
<p>
If the specified value is <code>null</code>, the default value is taken.
In this case, if the node does not have a default value, this method will
throw a <code>DmtException</code> with error code
<code>METADATA_MISMATCH</code>. Nodes of <code>null</code> format can be
set by using <A HREF="../../info/dmtree/DmtData.html#NULL_VALUE"><CODE>DmtData.NULL_VALUE</CODE></A> as second argument.
<p>
An Event of type REPLACE is sent out for a leaf node. A replaced interior
node sends out events for each of its children in depth first order
and node names sorted with Arrays.sort(String[]). When setting a value
on an interior node, the values of the leaf nodes under it can change,
but the structure of the subtree is not modified by the operation.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node<DD><CODE>data</CODE> - the data to be set, can be <code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Replace</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the given data has
<code>FORMAT_NODE</code> format but the node is a leaf node (or
vice versa), or in non-atomic sessions if the underlying plugin
is read-only or does not support non-atomic writing
<li><code>METADATA_MISMATCH</code> if the node is permanent or
cannot be modified according to the meta-data (does not have the
<code>MetaNode.CMD_REPLACE</code> access type), or if the given
value does not conform to the meta-data value constraints
<li><code>FEATURE_NOT_SUPPORTED</code> if the specified node is
an interior node and does not support Java object values
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Replace action
present</DL>
</DD>
</DL>
<HR>
<A NAME="setNodeTitle(java.lang.String, java.lang.String)"><!-- --></A><H3>
setNodeTitle</H3>
<PRE>
void <B>setNodeTitle</B>(java.lang.String nodeUri,
java.lang.String title)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Set the title property of a node. The length of the title string in UTF-8
encoding must not exceed 255 bytes.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node<DD><CODE>title</CODE> - the title text of the node, can be <code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Replace</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> in non-atomic sessions if
the underlying plugin is read-only or does not support non-atomic
writing
<li><code>METADATA_MISMATCH</code> if the node cannot be
modified according to the meta-data (does not have the
<code>MetaNode.CMD_REPLACE</code> access type)
<li><code>FEATURE_NOT_SUPPORTED</code> if the Title property
is not supported by the DmtAdmin implementation or the
underlying plugin
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the title string is too
long, if the URI is not within the current session's subtree, or
if some unspecified error is encountered while attempting to
complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Replace action
present</DL>
</DD>
</DL>
<HR>
<A NAME="setNodeType(java.lang.String, java.lang.String)"><!-- --></A><H3>
setNodeType</H3>
<PRE>
void <B>setNodeType</B>(java.lang.String nodeUri,
java.lang.String type)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Set the type of a node. The type of leaf node is the MIME type of the
data it contains. The type of an interior node is a URI identifying a DDF
document.
<p>
For interior nodes, a <code>null</code> type string means that there is
no DDF document overriding the tree structure defined by the ancestors.
For leaf nodes, it requests that the default MIME type is used for the
given node. If the node does not have a default MIME type this method
will throw a <code>DmtException</code> with error code
<code>METADATA_MISMATCH</code>. Note that a node might have a default
MIME type even if there is no meta-data for the node or its meta-data
does not specify the default.
<p>
MIME types must conform to the definition in RFC 2045. Interior node type
identifiers must follow the format defined in section 7.7.7.2 of the OMA
Device Management Tree and Description document. Checking the validity of
the type string does not have to be done by the DmtAdmin, this can be
left to the plugin handling the node (if any), to avoid unnecessary
double-checks.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node<DD><CODE>type</CODE> - the type of the node, can be <code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Replace</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> in non-atomic sessions if
the underlying plugin is read-only or does not support non-atomic
writing
<li><code>METADATA_MISMATCH</code> if the node is permanent or
cannot be modified according to the meta-data (does not have the
<code>MetaNode.CMD_REPLACE</code> access type), and in case of
leaf nodes, if <code>null</code> is given and there is no
default MIME type, or the given MIME type is not allowed
<li><code>TRANSACTION_ERROR</code> in an atomic session if the
underlying plugin is read-only or does not support atomic writing
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, if the type string is invalid (see
above), or if some unspecified error is encountered while
attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session was opened using the
<code>LOCK_TYPE_SHARED</code> lock type, or if the session is
already closed or invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Replace action
present<DT><B>See Also:</B><DD><a href="http://www.ietf.org/rfc/rfc2045.txt">RFC 2045</a>,
<a
href="http://member.openmobilealliance.org/ftp/public_documents/dm/Permanent_documents/OMA-TS-DM-TND-V1_2-20050615-C.zip">
OMA Device Management Tree and Description v1.2 draft</a></DL>
</DD>
</DL>
<HR>
<A NAME="getChildNodeNames(java.lang.String)"><!-- --></A><H3>
getChildNodeNames</H3>
<PRE>
java.lang.String[] <B>getChildNodeNames</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the list of children names of a node. The returned array contains the
names - not the URIs - of the immediate children nodes of the given node.
The returned child names are mangled (<A HREF="../../info/dmtree/Uri.html#mangle(java.lang.String)"><CODE>Uri.mangle(String)</CODE></A>). The elements
are in no particular order. The returned array must not contain
<code>null</code> entries.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>the list of child node names as a string array or an empty string
array if the node has no children
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the specified node is
not an interior node
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (it does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present</DL>
</DD>
</DL>
<HR>
<A NAME="getMetaNode(java.lang.String)"><!-- --></A><H3>
getMetaNode</H3>
<PRE>
<A HREF="../../info/dmtree/MetaNode.html" title="interface in info.dmtree">MetaNode</A> <B>getMetaNode</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the meta data which describes a given node. Meta data can only be
inspected, it can not be changed.
<p>
The <code>MetaNode</code> object returned to the client is the
combination of the meta data returned by the data plugin (if any) plus
the meta data returned by the DmtAdmin. If there are differences in the
meta data elements known by the plugin and the DmtAdmin then the plugin
specific elements take precedence.
<p>
Note, that a node does not have to exist for having meta-data associated
with it. This method may provide meta-data for any node that can possibly
exist in the tree (any node defined in the specification). For nodes that
are not defined, it may throw <code>DmtException</code> with the error
code <code>NODE_NOT_FOUND</code>. To allow easier implementation of
plugins that do not provide meta-data, it is allowed to return
<code>null</code> for any node, regardless of whether it is defined or
not.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>a MetaNode which describes meta data information, can be
<code>null</code> if there is no meta data available for the
given node
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a node that is not defined in the tree (see above)
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present</DL>
</DD>
</DL>
<HR>
<A NAME="getNodeSize(java.lang.String)"><!-- --></A><H3>
getNodeSize</H3>
<PRE>
int <B>getNodeSize</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the size of the data in a leaf node. The returned value depends on
the format of the data in the node, see the description of the
<A HREF="../../info/dmtree/DmtData.html#getSize()"><CODE>DmtData.getSize()</CODE></A> method for the definition of node size for each
format.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the leaf node
<DT><B>Returns:</B><DD>the size of the data in the node
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>COMMAND_NOT_ALLOWED</code> if the specified node is
not a leaf node
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (it does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>FEATURE_NOT_SUPPORTED</code> if the Size property is
not supported by the DmtAdmin implementation or the underlying
plugin
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present<DT><B>See Also:</B><DD><A HREF="../../info/dmtree/DmtData.html#getSize()"><CODE>DmtData.getSize()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getNodeTimestamp(java.lang.String)"><!-- --></A><H3>
getNodeTimestamp</H3>
<PRE>
java.util.Date <B>getNodeTimestamp</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the timestamp when the node was created or last modified.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>the timestamp of the last modification
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (it does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>FEATURE_NOT_SUPPORTED</code> if the Timestamp
property is not supported by the DmtAdmin implementation or the
underlying plugin
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present</DL>
</DD>
</DL>
<HR>
<A NAME="getNodeTitle(java.lang.String)"><!-- --></A><H3>
getNodeTitle</H3>
<PRE>
java.lang.String <B>getNodeTitle</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the title of a node. There might be no title property set for a node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>the title of the node, or <code>null</code> if the node has no
title
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (it does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>FEATURE_NOT_SUPPORTED</code> if the Title property
is not supported by the DmtAdmin implementation or the
underlying plugin
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present</DL>
</DD>
</DL>
<HR>
<A NAME="getNodeType(java.lang.String)"><!-- --></A><H3>
getNodeType</H3>
<PRE>
java.lang.String <B>getNodeType</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the type of a node. The type of leaf node is the MIME type of the
data it contains. The type of an interior node is a URI identifying a DDF
document; a <code>null</code> type means that there is no DDF document
overriding the tree structure defined by the ancestors.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>the type of the node, can be <code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (it does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present</DL>
</DD>
</DL>
<HR>
<A NAME="getNodeValue(java.lang.String)"><!-- --></A><H3>
getNodeValue</H3>
<PRE>
<A HREF="../../info/dmtree/DmtData.html" title="class in info.dmtree">DmtData</A> <B>getNodeValue</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the data contained in a leaf or interior node. When retrieving the
value associated with an interior node, the caller must have rights to
read all nodes in the subtree under the given node.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node to retrieve
<DT><B>Returns:</B><DD>the data of the node, can not be <code>null</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node (and the ACLs
of all its descendants in case of interior nodes) do not allow
the <code>Get</code> operation for the associated principal
<li><code>METADATA_MISMATCH</code> if the node value cannot be
retrieved according to the meta-data (it does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>FEATURE_NOT_SUPPORTED</code> if the specified node is
an interior node and does not support Java object values
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node (and all its descendants
in case of interior nodes) with the Get action present</DL>
</DD>
</DL>
<HR>
<A NAME="getNodeVersion(java.lang.String)"><!-- --></A><H3>
getNodeVersion</H3>
<PRE>
int <B>getNodeVersion</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Get the version of a node. The version can not be set, it is calculated
automatically by the device. It is incremented modulo 0x10000 at every
modification of the value or any other property of the node, for both
leaf and interior nodes. When a node is created the initial value is 0.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>the version of the node
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (it does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>FEATURE_NOT_SUPPORTED</code> if the Version property
is not supported by the DmtAdmin implementation or the
underlying plugin
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present</DL>
</DD>
</DL>
<HR>
<A NAME="isLeafNode(java.lang.String)"><!-- --></A><H3>
isLeafNode</H3>
<PRE>
boolean <B>isLeafNode</B>(java.lang.String nodeUri)
throws <A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>Tells whether a node is a leaf or an interior node of the DMT.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI of the node
<DT><B>Returns:</B><DD>true if the given node is a leaf node
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></CODE> - with the following possible error codes:
<ul>
<li><code>URI_TOO_LONG</code> if <code>nodeUri</code> or a
segment of it is too long, or if it has too many segments
<li><code>INVALID_URI</code> if <code>nodeUri</code> is
<code>null</code> or syntactically invalid
<li><code>NODE_NOT_FOUND</code> if <code>nodeUri</code>
points to a non-existing node
<li><code>PERMISSION_DENIED</code> if the session is
associated with a principal and the ACL of the node does not
allow the <code>Get</code> operation for the associated
principal
<li><code>METADATA_MISMATCH</code> if node information cannot
be retrieved according to the meta-data (it does not have
<code>MetaNode.CMD_GET</code> access type)
<li><code>DATA_STORE_FAILURE</code> if an error occurred while
accessing the data store
<li><code>COMMAND_FAILED</code> if the URI is not within the
current session's subtree, or if some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present</DL>
</DD>
</DL>
<HR>
<A NAME="isNodeUri(java.lang.String)"><!-- --></A><H3>
isNodeUri</H3>
<PRE>
boolean <B>isNodeUri</B>(java.lang.String nodeUri)</PRE>
<DL>
<DD>Check whether the specified URI corresponds to a valid node in the DMT.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodeUri</CODE> - the URI to check
<DT><B>Returns:</B><DD>true if the given node exists in the DMT
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree">DmtIllegalStateException</A></CODE> - if the session is already closed or
invalidated
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation, or,
in case of local sessions, if the caller does not have
<code>DmtPermission</code> for the node with the Get action
present</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../info/dmtree/DmtIllegalStateException.html" title="class in info.dmtree"><B>PREV CLASS</B></A>
<A HREF="../../info/dmtree/MetaNode.html" title="interface in info.dmtree"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?info/dmtree/DmtSession.html" target="_top"><B>FRAMES</B></A>
<A HREF="DmtSession.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|