/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/upnp/UPnPAction.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 | <!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>UPnPAction</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="UPnPAction";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":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>Prev Class</li>
<li><a href="../../../../org/osgi/service/upnp/UPnPDevice.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/UPnPAction.html" target="_top">Frames</a></li>
<li><a href="UPnPAction.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>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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 UPnPAction" class="title">Interface UPnPAction</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">UPnPAction</span></pre>
<div class="block">A UPnP action.
Each UPnP service contains zero or more actions. Each action may have zero or
more UPnP state variables as arguments.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>java.lang.String[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPAction.html#getInputArgumentNames--">getInputArgumentNames</a></span>()</code>
<div class="block">Lists all input arguments for this action.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPAction.html#getName--">getName</a></span>()</code>
<div class="block">Returns the action name.</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/UPnPAction.html#getOutputArgumentNames--">getOutputArgumentNames</a></span>()</code>
<div class="block">List all output arguments for this action.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPAction.html#getReturnArgumentName--">getReturnArgumentName</a></span>()</code>
<div class="block">Returns the name of the designated return argument.</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/UPnPAction.html#getStateVariable-java.lang.String-">getStateVariable</a></span>(java.lang.String argumentName)</code>
<div class="block">Finds the state variable associated with an argument name.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>java.util.Dictionary</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/osgi/service/upnp/UPnPAction.html#invoke-java.util.Dictionary-">invoke</a></span>(java.util.Dictionary args)</code>
<div class="block">Invokes the action.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String getName()</pre>
<div class="block">Returns the action name.
The action name corresponds to the <code>name</code> field in the
<code>actionList</code> of the service description.
<ul>
<li>For standard actions defined by a UPnP Forum working committee,
action names must not begin with <code>X_ </code> nor <code>A_</code>.</li>
<li>For non-standard actions specified by a UPnP vendor and added to a
standard service, action names must begin with <code>X_</code>.</li>
</ul>
<p>
This method must continue to return the action name after the UPnP action
has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Name of action, must not contain a hyphen character or a hash
character</dd>
</dl>
</li>
</ul>
<a name="getReturnArgumentName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReturnArgumentName</h4>
<pre>java.lang.String getReturnArgumentName()</pre>
<div class="block">Returns the name of the designated return argument.
<p>
One of the output arguments can be flagged as a designated return
argument.
<p>
This method must continue to return the action return argument name after
the UPnP action has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>The name of the designated return argument or <code>null</code> if
none is marked.</dd>
</dl>
</li>
</ul>
<a name="getInputArgumentNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInputArgumentNames</h4>
<pre>java.lang.String[] getInputArgumentNames()</pre>
<div class="block">Lists all input arguments for this action.
<p>
Each action may have zero or more input arguments.
<p>
This method must continue to return the action input argument names after
the UPnP action has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array of input argument names or <code>null</code> if no input
arguments.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp"><code>UPnPStateVariable</code></a></dd>
</dl>
</li>
</ul>
<a name="getOutputArgumentNames--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputArgumentNames</h4>
<pre>java.lang.String[] getOutputArgumentNames()</pre>
<div class="block">List all output arguments for this action.
<p>
This method must continue to return the action output argument names
after the UPnP action has been removed from the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Array of output argument names or <code>null</code> if there are no
output arguments.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp"><code>UPnPStateVariable</code></a></dd>
</dl>
</li>
</ul>
<a name="getStateVariable-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<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 argumentName)</pre>
<div class="block">Finds the state variable associated with an argument name.
Helps to resolve the association of state variables with argument names
in UPnP actions.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>argumentName</code> - The name of the UPnP action argument.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>State variable associated with the named argument or <code>null</code>
if there is no such argument.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the UPnP action has been removed from
the network.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp"><code>UPnPStateVariable</code></a></dd>
</dl>
</li>
</ul>
<a name="invoke-java.util.Dictionary-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>invoke</h4>
<pre>java.util.Dictionary invoke(java.util.Dictionary args)
throws java.lang.Exception</pre>
<div class="block">Invokes the action.
The input and output arguments are both passed as <code>Dictionary</code>
objects. Each entry in the <code>Dictionary</code> object has a <code>String</code>
object as key representing the argument name and the value is the
argument itself. The class of an argument value must be assignable from
the class of the associated UPnP state variable.
The input argument <code>Dictionary</code> object must contain exactly those
arguments listed by <code>getInputArguments</code> method. The output argument
<code>Dictionary</code> object will contain exactly those arguments listed by
<code>getOutputArguments</code> method.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>args</code> - A <code>Dictionary</code> of arguments. Must contain the correct
set and type of arguments for this action. May be <code>null</code> if
no input arguments exist.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A <code>Dictionary</code> with the output arguments. <code>null</code> if
the action has no output arguments.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/osgi/service/upnp/UPnPException.html" title="class in org.osgi.service.upnp">UPnPException</a></code> - A UPnP error has occurred.</dd>
<dd><code>java.lang.IllegalStateException</code> - if the UPnP action has been removed from
the network.</dd>
<dd><code>java.lang.Exception</code> - The execution fails for some reason.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/osgi/service/upnp/UPnPStateVariable.html" title="interface in org.osgi.service.upnp"><code>UPnPStateVariable</code></a></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>Prev Class</li>
<li><a href="../../../../org/osgi/service/upnp/UPnPDevice.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/UPnPAction.html" target="_top">Frames</a></li>
<li><a href="UPnPAction.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>Field | </li>
<li>Constr | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </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>
|