/usr/share/doc/libosgi-compendium-java/api/info/dmtree/spi/DataPlugin.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 | <!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>
DataPlugin
</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="DataPlugin";
}
}
</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">
PREV CLASS
<A HREF="../../../info/dmtree/spi/ExecPlugin.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/DataPlugin.html" target="_top"><B>FRAMES</B></A>
<A HREF="DataPlugin.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 DataPlugin</H2>
<HR>
<DL>
<DT><PRE>public interface <B>DataPlugin</B></DL>
</PRE>
<P>
An implementation of this interface takes the responsibility of handling data
requests in a subtree of the DMT.
<p>
In an OSGi environment such implementations should be registered at the OSGi
service registry specifying the list of root node URIs in a
<code>String</code> array in the <code>dataRootURIs</code> registration
parameter.
<p>
When the first reference in a session is made to a node handled by this
plugin, the DmtAdmin calls one of the <code>open...</code> methods to
retrieve a plugin session object for processing the request. The called
method depends on the lock type of the current session. In case of
<A HREF="../../../info/dmtree/spi/DataPlugin.html#openReadWriteSession(java.lang.String[], info.dmtree.DmtSession)"><CODE>openReadWriteSession(String[], DmtSession)</CODE></A> and
<A HREF="../../../info/dmtree/spi/DataPlugin.html#openAtomicSession(java.lang.String[], info.dmtree.DmtSession)"><CODE>openAtomicSession(String[], DmtSession)</CODE></A>, the plugin may return
<code>null</code> to indicate that the specified lock type is not supported.
In this case the DmtAdmin may call
<A HREF="../../../info/dmtree/spi/DataPlugin.html#openReadOnlySession(java.lang.String[], info.dmtree.DmtSession)"><CODE>openReadOnlySession(String[], DmtSession)</CODE></A> to start a read-only
plugin session, which can be used as long as there are no write operations on
the nodes handled by this plugin.
<p>
The <code>sessionRoot</code> parameter of each method is a String array
containing the segments of the URI pointing to the root of the session. This
is an absolute path, so the first segment is always ".". Special
characters appear escaped in the segments.
<p>
<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> <A HREF="../../../info/dmtree/spi/TransactionalDataSession.html" title="interface in info.dmtree.spi">TransactionalDataSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../info/dmtree/spi/DataPlugin.html#openAtomicSession(java.lang.String[], info.dmtree.DmtSession)">openAtomicSession</A></B>(java.lang.String[] sessionRoot,
<A HREF="../../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> session)</CODE>
<BR>
This method is called to signal the start of an atomic read-write session
when the first reference is made within a <code>DmtSession</code> to a
node which is handled by this plugin.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../info/dmtree/spi/ReadableDataSession.html" title="interface in info.dmtree.spi">ReadableDataSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../info/dmtree/spi/DataPlugin.html#openReadOnlySession(java.lang.String[], info.dmtree.DmtSession)">openReadOnlySession</A></B>(java.lang.String[] sessionRoot,
<A HREF="../../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> session)</CODE>
<BR>
This method is called to signal the start of a read-only session when the
first reference is made within a <code>DmtSession</code> to a node
which is handled by this plugin.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../info/dmtree/spi/ReadWriteDataSession.html" title="interface in info.dmtree.spi">ReadWriteDataSession</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../info/dmtree/spi/DataPlugin.html#openReadWriteSession(java.lang.String[], info.dmtree.DmtSession)">openReadWriteSession</A></B>(java.lang.String[] sessionRoot,
<A HREF="../../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> session)</CODE>
<BR>
This method is called to signal the start of a non-atomic read-write
session when the first reference is made within a <code>DmtSession</code>
to a node which is handled by this plugin.</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="openReadOnlySession(java.lang.String[], info.dmtree.DmtSession)"><!-- --></A><H3>
openReadOnlySession</H3>
<PRE>
<A HREF="../../../info/dmtree/spi/ReadableDataSession.html" title="interface in info.dmtree.spi">ReadableDataSession</A> <B>openReadOnlySession</B>(java.lang.String[] sessionRoot,
<A HREF="../../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> session)
throws <A HREF="../../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>This method is called to signal the start of a read-only session when the
first reference is made within a <code>DmtSession</code> to a node
which is handled by this plugin. Session information is given as it is
needed for sending alerts back from the plugin.
<p>
The plugin can assume that there are no writing sessions open on any
subtree that has any overlap with the subtree of this session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sessionRoot</CODE> - the path to the subtree which is accessed in the
current session, must not be <code>null</code><DD><CODE>session</CODE> - the session from which this plugin instance is accessed,
must not be <code>null</code>
<DT><B>Returns:</B><DD>a plugin session capable of executing read operations
<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>sessionRoot</code>
points to a non-existing node
<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 some underlying operation failed because of
lack of permissions</DL>
</DD>
</DL>
<HR>
<A NAME="openReadWriteSession(java.lang.String[], info.dmtree.DmtSession)"><!-- --></A><H3>
openReadWriteSession</H3>
<PRE>
<A HREF="../../../info/dmtree/spi/ReadWriteDataSession.html" title="interface in info.dmtree.spi">ReadWriteDataSession</A> <B>openReadWriteSession</B>(java.lang.String[] sessionRoot,
<A HREF="../../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> session)
throws <A HREF="../../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>This method is called to signal the start of a non-atomic read-write
session when the first reference is made within a <code>DmtSession</code>
to a node which is handled by this plugin. Session information is given
as it is needed for sending alerts back from the plugin.
<p>
The plugin can assume that there are no other sessions open on any
subtree that has any overlap with the subtree of this session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sessionRoot</CODE> - the path to the subtree which is locked in the current
session, must not be <code>null</code><DD><CODE>session</CODE> - the session from which this plugin instance is accessed,
must not be <code>null</code>
<DT><B>Returns:</B><DD>a plugin session capable of executing read-write operations, or
<code>null</code> if the plugin does not support non-atomic
read-write sessions
<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>sessionRoot</code>
points to a non-existing node
<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 some underlying operation failed because of
lack of permissions</DL>
</DD>
</DL>
<HR>
<A NAME="openAtomicSession(java.lang.String[], info.dmtree.DmtSession)"><!-- --></A><H3>
openAtomicSession</H3>
<PRE>
<A HREF="../../../info/dmtree/spi/TransactionalDataSession.html" title="interface in info.dmtree.spi">TransactionalDataSession</A> <B>openAtomicSession</B>(java.lang.String[] sessionRoot,
<A HREF="../../../info/dmtree/DmtSession.html" title="interface in info.dmtree">DmtSession</A> session)
throws <A HREF="../../../info/dmtree/DmtException.html" title="class in info.dmtree">DmtException</A></PRE>
<DL>
<DD>This method is called to signal the start of an atomic read-write session
when the first reference is made within a <code>DmtSession</code> to a
node which is handled by this plugin. Session information is given as it
is needed for sending alerts back from the plugin.
<p>
The plugin can assume that there are no other sessions open on any
subtree that has any overlap with the subtree of this session.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sessionRoot</CODE> - the path to the subtree which is locked in the current
session, must not be <code>null</code><DD><CODE>session</CODE> - the session from which this plugin instance is accessed,
must not be <code>null</code>
<DT><B>Returns:</B><DD>a plugin session capable of executing read-write operations in an
atomic block, or <code>null</code> if the plugin does not
support atomic read-write sessions
<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>sessionRoot</code>
points to a non-existing node
<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 some underlying operation failed because of
lack of permissions</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">
PREV CLASS
<A HREF="../../../info/dmtree/spi/ExecPlugin.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/DataPlugin.html" target="_top"><B>FRAMES</B></A>
<A HREF="DataPlugin.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>
|