/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/upnp/UPnPService.html is in libosgi-compendium-java-doc 5.0.0-5.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<title>UPnPService</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="UPnPService";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/osgi/service/upnp/UPnPLocalStateVariable.html" title="interface in org.osgi.service.upnp"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/upnp/UPnPService.html" target="_top">Frames</a></li>
<li><a href="UPnPService.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.osgi.service.upnp</div>
<h2 title="Interface UPnPService" class="title">Interface UPnPService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">UPnPService</span></pre>
<div class="block">A representation of a UPnP Service.
Each UPnP device contains zero or more services. The UPnP description for a
service defines actions, their arguments, and event characteristics.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#ID">ID</a></span></code>
<div class="block">Property key for the optional service id.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#TYPE">TYPE</a></span></code>
<div class="block">Property key for the optional service type uri.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/upnp/UPnPAction.html" title="interface in org.osgi.service.upnp">UPnPAction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#getAction-java.lang.String-">getAction</a></span>(java.lang.String name)</code>
<div class="block">Locates a specific action by name.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/upnp/UPnPAction.html" title="interface in org.osgi.service.upnp">UPnPAction</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#getActions--">getActions</a></span>()</code>
<div class="block">Lists all actions provided by this service.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#getId--">getId</a></span>()</code>
<div class="block">Returns the <code>serviceId</code> field in the UPnP service description.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp">UPnPStateVariable</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#getStateVariable-java.lang.String-">getStateVariable</a></span>(java.lang.String name)</code>
<div class="block">Gets a <code>UPnPStateVariable</code> objects provided by this service by name</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp">UPnPStateVariable</a>[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#getStateVariables--">getStateVariables</a></span>()</code>
<div class="block">Lists all <code>UPnPStateVariable</code> objects provided by this service.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#getType--">getType</a></span>()</code>
<div class="block">Returns the <code>serviceType</code> field in the UPnP service description.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPService.html#getVersion--">getVersion</a></span>()</code>
<div class="block">Returns the version suffix encoded in the <code>serviceType</code> field in
the UPnP service description.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="TYPE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TYPE</h4>
<pre>static final java.lang.String TYPE</pre>
<div class="block">Property key for the optional service type uri.
The service type property is used when registering UPnP Device services
and UPnP Event Listener services. The property contains a <code>String</code>
array (<code>String[]</code>) of service types. A UPnP Device service can thus
announce what types of services it contains. A UPnP Event Listener
service can announce for what type of UPnP services it wants
notifications. The service version is encoded in the type string as
specified in the UPnP specification. A <code>null</code> value is a wildcard,
matching <b>all </b> service types. Value is "UPnP.service.type".</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/upnp/UPnPService.html#getType--"><code>getType()</code></a>,
<a href="../../../../constant-values.html#org.osgi.service.upnp.UPnPService.TYPE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="ID">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ID</h4>
<pre>static final java.lang.String ID</pre>
<div class="block">Property key for the optional service id.
The service id property is used when registering UPnP Device services or
UPnP Event Listener services. The value of the property contains a
<code>String</code> array (<code>String[]</code>) of service ids. A UPnP Device
service can thus announce what service ids it contains. A UPnP Event
Listener service can announce for what UPnP service ids it wants
notifications. A service id does <b>not </b> have to be universally
unique. It must be unique only within a device. A <code>null</code> value is a
wildcard, matching <b>all </b> services. The value is "UPnP.service.id".</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.osgi.service.upnp.UPnPService.ID">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getId--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getId</h4>
<pre>java.lang.String getId()</pre>
<div class="block">Returns the <code>serviceId</code> field in the UPnP service description.
<p>
For standard services defined by a UPnP Forum working committee, the
serviceId must contain the following components in the indicated order:
<ul>
<li><code>urn:upnp-org:serviceId:</code></li>
<li>service ID suffix</li>
</ul>
Example: <code>urn:upnp-org:serviceId:serviceID</code>.
<p>
Note that <code>upnp-org</code> is used instead of <code>schemas-upnp-org</code> in
this example because an XML schema is not defined for each serviceId.
</p>
<p>
For non-standard services specified by UPnP vendors, the serviceId must
contain the following components in the indicated order:
<ul>
<li><code>urn:</code></li>
<li>ICANN domain name owned by the vendor</li>
<li><code>:serviceId:</code></li>
<li>service ID suffix</li>
</ul>
Example: <code>urn:domain-name:serviceId:serviceID</code>.
<p>
This method must continue to return the service id after the UPnP service
has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The service ID suffix defined by a UPnP Forum working committee
or specified by a UPnP vendor. Must be <= 64 characters.
Single URI.</dd>
</dl>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>java.lang.String getType()</pre>
<div class="block">Returns the <code>serviceType</code> field in the UPnP service description.
<p>
For standard services defined by a UPnP Forum working committee, the
serviceType must contain the following components in the indicated order:
<ul>
<li><code>urn:schemas-upnp-org:service:</code></li>
<li>service type suffix:</li>
<li>integer service version</li>
</ul>
Example: <code>urn:schemas-upnp-org:service:serviceType:v</code>.
<p>
For non-standard services specified by UPnP vendors, the
<code>serviceType</code> must contain the following components in the
indicated order:
<ul>
<li><code>urn:</code></li>
<li>ICANN domain name owned by the vendor</li>
<li><code>:service:</code></li>
<li>service type suffix:</li>
<li>integer service version</li>
</ul>
Example: <code>urn:domain-name:service:serviceType:v</code>.
<p>
This method must continue to return the service type after the UPnP
service has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The service type suffix defined by a UPnP Forum working committee
or specified by a UPnP vendor. Must be <= 64 characters, not
including the version suffix and separating colon. Single URI.</dd>
</dl>
</li>
</ul>
<a name="getVersion--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVersion</h4>
<pre>java.lang.String getVersion()</pre>
<div class="block">Returns the version suffix encoded in the <code>serviceType</code> field in
the UPnP service description.
<p>
This method must continue to return the service version after the UPnP
service has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The integer service version defined by a UPnP Forum working
committee or specified by a UPnP vendor.</dd>
</dl>
</li>
</ul>
<a name="getAction-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAction</h4>
<pre><a href="../../../../org/osgi/service/upnp/UPnPAction.html" title="interface in org.osgi.service.upnp">UPnPAction</a> getAction(java.lang.String name)</pre>
<div class="block">Locates a specific action by name.
Looks up an action by its name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of action. Must not contain hyphen or hash characters.
Should be < 32 characters.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The requested action or <code>null</code> if no action is found.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the UPnP service has been removed from
the network.</dd>
</dl>
</li>
</ul>
<a name="getActions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActions</h4>
<pre><a href="../../../../org/osgi/service/upnp/UPnPAction.html" title="interface in org.osgi.service.upnp">UPnPAction</a>[] getActions()</pre>
<div class="block">Lists all actions provided by this service.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array of actions (<code>UPnPAction[]</code> )or <code>null</code> if no
actions are defined for this service.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the UPnP service has been removed from
the network.</dd>
</dl>
</li>
</ul>
<a name="getStateVariables--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStateVariables</h4>
<pre><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp">UPnPStateVariable</a>[] getStateVariables()</pre>
<div class="block">Lists all <code>UPnPStateVariable</code> objects provided by this service.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array of state variables or <code>null</code> if none are defined for
this service.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the UPnP service has been removed from
the network.</dd>
</dl>
</li>
</ul>
<a name="getStateVariable-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getStateVariable</h4>
<pre><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp">UPnPStateVariable</a> getStateVariable(java.lang.String name)</pre>
<div class="block">Gets a <code>UPnPStateVariable</code> objects provided by this service by name</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - Name of the State Variable</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>State variable or <code>null</code> if no such state variable exists
for this service.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the UPnP service has been removed from
the network.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/osgi/service/upnp/UPnPLocalStateVariable.html" title="interface in org.osgi.service.upnp"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/osgi/service/upnp/UPnPService.html" target="_top">Frames</a></li>
<li><a href="UPnPService.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|