/usr/share/doc/libosgi-compendium-java/api/info/dmtree/spi/ReadWriteDataSession.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 | <!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:28 UTC 2011 -->
<TITLE>
ReadWriteDataSession
</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="ReadWriteDataSession";
}
}
</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/spi/ReadableDataSession.html" title="interface in info.dmtree.spi"><B>PREV CLASS</B></A>
<A HREF="../../../info/dmtree/spi/TransactionalDataSession.html" title="interface in info.dmtree.spi"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?info/dmtree/spi/ReadWriteDataSession.html" target="_top"><B>FRAMES</B></A>
<A HREF="ReadWriteDataSession.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | 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.spi</FONT>
<BR>
Interface ReadWriteDataSession</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../info/dmtree/spi/ReadableDataSession.html" title="interface in info.dmtree.spi">ReadableDataSession</A></DD>
</DL>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../info/dmtree/spi/TransactionalDataSession.html" title="interface in info.dmtree.spi">TransactionalDataSession</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>ReadWriteDataSession</B><DT>extends <A HREF="../../../info/dmtree/spi/ReadableDataSession.html" title="interface in info.dmtree.spi">ReadableDataSession</A></DL>
</PRE>
<P>
Provides non-atomic read-write access to the part of the tree handled by the
plugin that created this session.
<p>
The <code>nodePath</code> parameters appearing in this interface always
contain an array of path segments identifying a node in the subtree of this
plugin. This parameter contains an absolute path, so the first segment is
always ".". Special characters appear escaped in the segments.
<p>
<strong>Error handling</strong>
<p>
When a tree manipulation command is called on the DmtAdmin service, it must
perform an extensive set of checks on the parameters and the authority of the
caller before delegating the call to a plugin. Therefore plugins can take
certain circumstances for granted: that the path is valid and is within the
subtree of the plugin and the session, the command can be applied to the
given node (e.g. the target of <code>setNodeValue</code> is a leaf node),
etc. All errors described by the error codes <A HREF="../../../info/dmtree/DmtException.html#INVALID_URI"><CODE>DmtException.INVALID_URI</CODE></A>, <A HREF="../../../info/dmtree/DmtException.html#URI_TOO_LONG"><CODE>DmtException.URI_TOO_LONG</CODE></A>, <A HREF="../../../info/dmtree/DmtException.html#PERMISSION_DENIED"><CODE>DmtException.PERMISSION_DENIED</CODE></A>,
<A HREF="../../../info/dmtree/DmtException.html#COMMAND_NOT_ALLOWED"><CODE>DmtException.COMMAND_NOT_ALLOWED</CODE></A> and
<A HREF="../../../info/dmtree/DmtException.html#TRANSACTION_ERROR"><CODE>DmtException.TRANSACTION_ERROR</CODE></A> are fully filtered out before control
reaches the plugin.
<p>
If the plugin provides meta-data for a node, the DmtAdmin service must also
check the constraints specified by it, as described in <A HREF="../../../info/dmtree/MetaNode.html" title="interface in info.dmtree"><CODE>MetaNode</CODE></A>. If
the plugin does not provide meta-data, it must perform the necessary checks
for itself and use the <A HREF="../../../info/dmtree/DmtException.html#METADATA_MISMATCH"><CODE>DmtException.METADATA_MISMATCH</CODE></A> error code to
indicate such discrepancies.
<p>
The DmtAdmin also ensures that the targeted nodes exist before calling the
plugin (or that they do not exist, in case of node creation). However, some
small amount of time elapses between the check and the call, so in case of
plugins where the node structure can change independantly from the DMT, the
target node might appear/disappear in that time. For example, a whole subtree
can disappear when a Monitorable application is unregistered, which might
happen in the middle of a DMT session accessing it. Plugins managing such
nodes always need to check the existance or non-existance of nodes and throw
<A HREF="../../../info/dmtree/DmtException.html#NODE_NOT_FOUND"><CODE>DmtException.NODE_NOT_FOUND</CODE></A> or
<A HREF="../../../info/dmtree/DmtException.html#NODE_ALREADY_EXISTS"><CODE>DmtException.NODE_ALREADY_EXISTS</CODE></A> as necessary, but for more static
subtrees there is no need for the plugin to use these error codes.
<p>
The plugin can use the remaining error codes as needed. If an error does not
fit into any other category, the <A HREF="../../../info/dmtree/DmtException.html#COMMAND_FAILED"><CODE>DmtException.COMMAND_FAILED</CODE></A> code
should be used.
<P>
<P>
<HR>
<P>
<!-- ========== 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/spi/ReadWriteDataSession.html#copy(java.lang.String[], java.lang.String[], boolean)">copy</A></B>(java.lang.String[] nodePath,
java.lang.String[] newNodePath,
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/spi/ReadWriteDataSession.html#createInteriorNode(java.lang.String[], java.lang.String)">createInteriorNode</A></B>(java.lang.String[] nodePath,
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/spi/ReadWriteDataSession.html#createLeafNode(java.lang.String[], info.dmtree.DmtData, java.lang.String)">createLeafNode</A></B>(java.lang.String[] nodePath,
<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/spi/ReadWriteDataSession.html#deleteNode(java.lang.String[])">deleteNode</A></B>(java.lang.String[] nodePath)</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/spi/ReadWriteDataSession.html#renameNode(java.lang.String[], java.lang.String)">renameNode</A></B>(java.lang.String[] nodePath,
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/spi/ReadWriteDataSession.html#setNodeTitle(java.lang.String[], java.lang.String)">setNodeTitle</A></B>(java.lang.String[] nodePath,
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/spi/ReadWriteDataSession.html#setNodeType(java.lang.String[], java.lang.String)">setNodeType</A></B>(java.lang.String[] nodePath,
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/spi/ReadWriteDataSession.html#setNodeValue(java.lang.String[], info.dmtree.DmtData)">setNodeValue</A></B>(java.lang.String[] nodePath,
<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>
<A NAME="methods_inherited_from_class_info.dmtree.spi.ReadableDataSession"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface info.dmtree.spi.<A HREF="../../../info/dmtree/spi/ReadableDataSession.html" title="interface in info.dmtree.spi">ReadableDataSession</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../info/dmtree/spi/ReadableDataSession.html#close()">close</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#getChildNodeNames(java.lang.String[])">getChildNodeNames</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#getMetaNode(java.lang.String[])">getMetaNode</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#getNodeSize(java.lang.String[])">getNodeSize</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#getNodeTimestamp(java.lang.String[])">getNodeTimestamp</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#getNodeTitle(java.lang.String[])">getNodeTitle</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#getNodeType(java.lang.String[])">getNodeType</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#getNodeValue(java.lang.String[])">getNodeValue</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#getNodeVersion(java.lang.String[])">getNodeVersion</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#isLeafNode(java.lang.String[])">isLeafNode</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#isNodeUri(java.lang.String[])">isNodeUri</A>, <A HREF="../../../info/dmtree/spi/ReadableDataSession.html#nodeChanged(java.lang.String[])">nodeChanged</A></CODE></TD>
</TR>
</TABLE>
<P>
<!-- ============ 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="copy(java.lang.String[], java.lang.String[], boolean)"><!-- --></A><H3>
copy</H3>
<PRE>
void <B>copy</B>(java.lang.String[] nodePath,
java.lang.String[] newNodePath,
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 managed by the plugin must also be
copied, with the exception of the Timestamp and Version properties.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodePath</CODE> - an absolute path specifying the node or the root of a
subtree to be copied<DD><CODE>newNodePath</CODE> - the absolute path 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>NODE_NOT_FOUND</code> if <code>nodePath</code>
points to a non-existing node, or if <code>newNodePath</code>
points to a node that cannot exist in the tree
<li><code>NODE_ALREADY_EXISTS</code> if
<code>newNodePath</code> points to a node that already exists
<li><code>METADATA_MISMATCH</code> if the node could not be
copied because of meta-data restrictions
<li><code>FEATURE_NOT_SUPPORTED</code> if the copy operation
is not supported by the plugin
<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>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation<DT><B>See Also:</B><DD><A HREF="../../../info/dmtree/DmtSession.html#copy(java.lang.String, java.lang.String, boolean)"><CODE>DmtSession.copy(String, String, boolean)</CODE></A></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[] nodePath,
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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodePath</CODE> - the absolute path 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>NODE_NOT_FOUND</code> if <code>nodePath</code>
points to a node that cannot exist in the tree
<li><code>NODE_ALREADY_EXISTS</code> if <code>nodeUri</code>
points to a node that already exists
<li><code>METADATA_MISMATCH</code> if the node could not be
created because of meta-data restrictions
<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>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation<DT><B>See Also:</B><DD><A HREF="../../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String)"><CODE>DmtSession.createInteriorNode(String)</CODE></A>,
<A HREF="../../../info/dmtree/DmtSession.html#createInteriorNode(java.lang.String, java.lang.String)"><CODE>DmtSession.createInteriorNode(String, String)</CODE></A></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[] nodePath,
<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 must be
taken.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodePath</CODE> - the absolute path 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>NODE_NOT_FOUND</code> if <code>nodePath</code>
points to a node that cannot exist in the tree
<li><code>NODE_ALREADY_EXISTS</code> if <code>nodePath</code>
points to a node that already exists
<li><code>METADATA_MISMATCH</code> if the node could not be
created because of meta-data restrictions
<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>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation<DT><B>See Also:</B><DD><A HREF="../../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String)"><CODE>DmtSession.createLeafNode(String)</CODE></A>,
<A HREF="../../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String, info.dmtree.DmtData)"><CODE>DmtSession.createLeafNode(String, DmtData)</CODE></A>,
<A HREF="../../../info/dmtree/DmtSession.html#createLeafNode(java.lang.String, info.dmtree.DmtData, java.lang.String)"><CODE>DmtSession.createLeafNode(String, DmtData, String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="deleteNode(java.lang.String[])"><!-- --></A><H3>
deleteNode</H3>
<PRE>
void <B>deleteNode</B>(java.lang.String[] nodePath)
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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodePath</CODE> - the absolute path of the node to delete
<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>NODE_NOT_FOUND</code> if <code>nodePath</code>
points to a non-existing node
<li><code>METADATA_MISMATCH</code> if the node could not be
deleted because of meta-data restrictions
<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>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation<DT><B>See Also:</B><DD><A HREF="../../../info/dmtree/DmtSession.html#deleteNode(java.lang.String)"><CODE>DmtSession.deleteNode(String)</CODE></A></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[] nodePath,
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 path is constructed from the base of the old path
and the given name.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodePath</CODE> - the absolute path 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>NODE_NOT_FOUND</code> if <code>nodePath</code>
points to a non-existing node, or if the new node is not defined
in the tree
<li><code>NODE_ALREADY_EXISTS</code> if there already exists a
sibling of <code>nodePath</code> with the name
<code>newName</code>
<li><code>METADATA_MISMATCH</code> if the node could not be
renamed because of meta-data restrictions
<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>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation<DT><B>See Also:</B><DD><A HREF="../../../info/dmtree/DmtSession.html#renameNode(java.lang.String, java.lang.String)"><CODE>DmtSession.renameNode(String, String)</CODE></A></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[] nodePath,
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 is guaranteed
not to exceed the limit of 255 bytes in UTF-8 encoding.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodePath</CODE> - the absolute path 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>NODE_NOT_FOUND</code> if <code>nodePath</code>
points to a non-existing node
<li><code>METADATA_MISMATCH</code> if the title could not be
set because of meta-data restrictions
<li><code>FEATURE_NOT_SUPPORTED</code> if the Title property
is not supported by the plugin
<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>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation<DT><B>See Also:</B><DD><A HREF="../../../info/dmtree/DmtSession.html#setNodeTitle(java.lang.String, java.lang.String)"><CODE>DmtSession.setNodeTitle(String, String)</CODE></A></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[] nodePath,
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, the <code>null</code> type should remove the
reference (if any) to a 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.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodePath</CODE> - the absolute path 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>NODE_NOT_FOUND</code> if <code>nodePath</code>
points to a non-existing node
<li><code>METADATA_MISMATCH</code> if the type could not be
set because of meta-data restrictions
<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>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation<DT><B>See Also:</B><DD><A HREF="../../../info/dmtree/DmtSession.html#setNodeType(java.lang.String, java.lang.String)"><CODE>DmtSession.setNodeType(String, String)</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[] nodePath,
<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 is <code>FORMAT_NODE</code>, while for leaf nodes this format is
never used.
<p>
If the specified value is <code>null</code>, the default value must be
taken; if there is no default value, a <code>DmtException</code> with
error code <code>METADATA_MISMATCH</code> must be thrown.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nodePath</CODE> - the absolute path 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>NODE_NOT_FOUND</code> if <code>nodePath</code>
points to a non-existing node
<li><code>METADATA_MISMATCH</code> if the value could not be
set because of meta-data restrictions
<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 some unspecified error is
encountered while attempting to complete the command
</ul>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller does not have the necessary
permissions to execute the underlying management operation<DT><B>See Also:</B><DD><A HREF="../../../info/dmtree/DmtSession.html#setNodeValue(java.lang.String, info.dmtree.DmtData)"><CODE>DmtSession.setNodeValue(String, DmtData)</CODE></A></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/spi/ReadableDataSession.html" title="interface in info.dmtree.spi"><B>PREV CLASS</B></A>
<A HREF="../../../info/dmtree/spi/TransactionalDataSession.html" title="interface in info.dmtree.spi"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?info/dmtree/spi/ReadWriteDataSession.html" target="_top"><B>FRAMES</B></A>
<A HREF="ReadWriteDataSession.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
|