/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/upnp/UPnPDevice.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 | <!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 Wed Nov 09 19:45:52 UTC 2011 -->
<TITLE>
UPnPDevice
</TITLE>
<META NAME="date" CONTENT="2011-11-09">
<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="UPnPDevice";
}
}
</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="../../../../org/osgi/service/upnp/UPnPAction.html" title="interface in org.osgi.service.upnp"><B>PREV CLASS</B></A>
<A HREF="../../../../org/osgi/service/upnp/UPnPEventListener.html" title="interface in org.osgi.service.upnp"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/upnp/UPnPDevice.html" target="_top"><B>FRAMES</B></A>
<A HREF="UPnPDevice.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">
org.osgi.service.upnp</FONT>
<BR>
Interface UPnPDevice</H2>
<HR>
<DL>
<DT><PRE>public interface <B>UPnPDevice</B></DL>
</PRE>
<P>
Represents a UPnP device.
For each UPnP root and embedded device, an object is registered with the
framework under the <code>UPnPDevice</code> interface.
<p>
The relationship between a root device and its embedded devices can be
deduced using the <code>UPnPDevice.CHILDREN_UDN</code> and
<code>UPnPDevice.PARENT_UDN</code> service registration properties.
<p>
The values of the UPnP property names are defined by the UPnP Forum.
<p>
All values of the UPnP properties are obtained from the device using the
device's default locale.
<p>
If an application wants to query for a set of localized property values, it
has to use the method <code>UPnPDevice.getDescriptions(String locale)</code>.
<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 java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#CHILDREN_UDN">CHILDREN_UDN</A></B></CODE>
<BR>
The property key that must be set for all devices containing other
embedded devices.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#DEVICE_CATEGORY">DEVICE_CATEGORY</A></B></CODE>
<BR>
Constant for the value of the service property <code>DEVICE_CATEGORY</code>
used for all UPnP devices.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#FRIENDLY_NAME">FRIENDLY_NAME</A></B></CODE>
<BR>
Mandatory property key for a short user friendly version of the device
name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#ID">ID</A></B></CODE>
<BR>
Property key for the Unique Device ID property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#MANUFACTURER">MANUFACTURER</A></B></CODE>
<BR>
Mandatory property key for the device manufacturer's property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#MANUFACTURER_URL">MANUFACTURER_URL</A></B></CODE>
<BR>
Optional property key for a URL to the device manufacturers Web site.</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="../../../../org/osgi/service/upnp/UPnPDevice.html#MATCH_GENERIC">MATCH_GENERIC</A></B></CODE>
<BR>
Constant for the UPnP device match scale, indicating a generic match for
the device.</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="../../../../org/osgi/service/upnp/UPnPDevice.html#MATCH_MANUFACTURER_MODEL">MATCH_MANUFACTURER_MODEL</A></B></CODE>
<BR>
Constant for the UPnP device match scale, indicating a match with the
device model.</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="../../../../org/osgi/service/upnp/UPnPDevice.html#MATCH_MANUFACTURER_MODEL_REVISION">MATCH_MANUFACTURER_MODEL_REVISION</A></B></CODE>
<BR>
Constant for the UPnP device match scale, indicating a match with the
device revision.</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="../../../../org/osgi/service/upnp/UPnPDevice.html#MATCH_MANUFACTURER_MODEL_REVISION_SERIAL">MATCH_MANUFACTURER_MODEL_REVISION_SERIAL</A></B></CODE>
<BR>
Constant for the UPnP device match scale, indicating a match with the
device revision and the serial number.</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="../../../../org/osgi/service/upnp/UPnPDevice.html#MATCH_TYPE">MATCH_TYPE</A></B></CODE>
<BR>
Constant for the UPnP device match scale, indicating a match with the
device type.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#MODEL_DESCRIPTION">MODEL_DESCRIPTION</A></B></CODE>
<BR>
Optional (but recommended) property key for a <code>String</code> object
with a long description of the device for the end user.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#MODEL_NAME">MODEL_NAME</A></B></CODE>
<BR>
Mandatory property key for the device model name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#MODEL_NUMBER">MODEL_NUMBER</A></B></CODE>
<BR>
Optional (but recommended) property key for a <code>String</code> class
typed property holding the model number of the device.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#MODEL_URL">MODEL_URL</A></B></CODE>
<BR>
Optional property key for a <code>String</code> typed property holding a
string representing the URL to the Web site for this model.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#PARENT_UDN">PARENT_UDN</A></B></CODE>
<BR>
The property key that must be set for all embedded devices.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#PRESENTATION_URL">PRESENTATION_URL</A></B></CODE>
<BR>
Optional (but recommended) property key for a <code>String</code> typed
property holding a string representing the URL to a device representation
Web page.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#SERIAL_NUMBER">SERIAL_NUMBER</A></B></CODE>
<BR>
Optional (but recommended) property key for a <code>String</code> typed
property holding the serial number of the device.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#TYPE">TYPE</A></B></CODE>
<BR>
Property key for the UPnP Device Type property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#UDN">UDN</A></B></CODE>
<BR>
Property key for the Unique Device Name (UDN) property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#UPC">UPC</A></B></CODE>
<BR>
Optional property key for a <code>String</code> typed property holding the
Universal Product Code (UPC) of the device.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#UPNP_EXPORT">UPNP_EXPORT</A></B></CODE>
<BR>
The <code>UPnP.export</code> service property is a hint that marks a device
to be picked up and exported by the UPnP Service.</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> java.util.Dictionary</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#getDescriptions(java.lang.String)">getDescriptions</A></B>(java.lang.String locale)</CODE>
<BR>
Get a set of localized UPnP properties.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/upnp/UPnPIcon.html" title="interface in org.osgi.service.upnp">UPnPIcon</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#getIcons(java.lang.String)">getIcons</A></B>(java.lang.String locale)</CODE>
<BR>
Lists all icons for this device in a given locale.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/upnp/UPnPService.html" title="interface in org.osgi.service.upnp">UPnPService</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#getService(java.lang.String)">getService</A></B>(java.lang.String serviceId)</CODE>
<BR>
Locates a specific service by its service id.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/upnp/UPnPService.html" title="interface in org.osgi.service.upnp">UPnPService</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/upnp/UPnPDevice.html#getServices()">getServices</A></B>()</CODE>
<BR>
Lists all services provided by this device.</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="MATCH_GENERIC"><!-- --></A><H3>
MATCH_GENERIC</H3>
<PRE>
static final int <B>MATCH_GENERIC</B></PRE>
<DL>
<DD>Constant for the UPnP device match scale, indicating a generic match for
the device. Value is 1.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MATCH_GENERIC">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MATCH_TYPE"><!-- --></A><H3>
MATCH_TYPE</H3>
<PRE>
static final int <B>MATCH_TYPE</B></PRE>
<DL>
<DD>Constant for the UPnP device match scale, indicating a match with the
device type. Value is 3.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MATCH_TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MATCH_MANUFACTURER_MODEL"><!-- --></A><H3>
MATCH_MANUFACTURER_MODEL</H3>
<PRE>
static final int <B>MATCH_MANUFACTURER_MODEL</B></PRE>
<DL>
<DD>Constant for the UPnP device match scale, indicating a match with the
device model. Value is 7.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MATCH_MANUFACTURER_MODEL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MATCH_MANUFACTURER_MODEL_REVISION"><!-- --></A><H3>
MATCH_MANUFACTURER_MODEL_REVISION</H3>
<PRE>
static final int <B>MATCH_MANUFACTURER_MODEL_REVISION</B></PRE>
<DL>
<DD>Constant for the UPnP device match scale, indicating a match with the
device revision. Value is 15.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MATCH_MANUFACTURER_MODEL_REVISION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MATCH_MANUFACTURER_MODEL_REVISION_SERIAL"><!-- --></A><H3>
MATCH_MANUFACTURER_MODEL_REVISION_SERIAL</H3>
<PRE>
static final int <B>MATCH_MANUFACTURER_MODEL_REVISION_SERIAL</B></PRE>
<DL>
<DD>Constant for the UPnP device match scale, indicating a match with the
device revision and the serial number. Value is 31.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MATCH_MANUFACTURER_MODEL_REVISION_SERIAL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DEVICE_CATEGORY"><!-- --></A><H3>
DEVICE_CATEGORY</H3>
<PRE>
static final java.lang.String <B>DEVICE_CATEGORY</B></PRE>
<DL>
<DD>Constant for the value of the service property <code>DEVICE_CATEGORY</code>
used for all UPnP devices. Value is "UPnP".
<P>
<DL>
<DT><B>See Also:</B><DD>"{@code org.osgi.service.device.Constants.DEVICE_CATEGORY}",
<A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.DEVICE_CATEGORY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="UPNP_EXPORT"><!-- --></A><H3>
UPNP_EXPORT</H3>
<PRE>
static final java.lang.String <B>UPNP_EXPORT</B></PRE>
<DL>
<DD>The <code>UPnP.export</code> service property is a hint that marks a device
to be picked up and exported by the UPnP Service. Imported devices do not
have this property set. The registered property requires no value.
<p>
The UPNP_EXPORT string is "UPnP.export".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.UPNP_EXPORT">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="UDN"><!-- --></A><H3>
UDN</H3>
<PRE>
static final java.lang.String <B>UDN</B></PRE>
<DL>
<DD>Property key for the Unique Device Name (UDN) property. It is the unique
identifier of an instance of a <code>UPnPDevice</code>. The value of the
property is a <code>String</code> object of the Device UDN. Value of the
key is "UPnP.device.UDN". This property must be set.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.UDN">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ID"><!-- --></A><H3>
ID</H3>
<PRE>
static final java.lang.String <B>ID</B></PRE>
<DL>
<DD>Property key for the Unique Device ID property. This property is an alias
to <code>UPnPDevice.UDN</code>. It is merely provided for reasons of
symmetry with the <code>UPnPService.ID</code> property. The value of the
property is a <code>String</code> object of the Device UDN. The value of
the key is "UPnP.device.UDN".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.ID">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TYPE"><!-- --></A><H3>
TYPE</H3>
<PRE>
static final java.lang.String <B>TYPE</B></PRE>
<DL>
<DD>Property key for the UPnP Device Type property. Some standard property
values are defined by the Universal Plug and Play Forum. The type string
also includes a version number as defined in the UPnP specification. This
property must be set.
<p>
For standard devices defined by a UPnP Forum working committee, this must
consist of the following components in the given order separated by
colons:
<ul>
<li><code>urn</code></li>
<li>schemas-upnp-org</li>
<li><code>device</code></li>
<li>a device type suffix</li>
<li>an integer device version</li>
</ul>
For non-standard devices specified by UPnP vendors following components
must be specified in the given order separated by colons:
<ul>
<li><code>urn</code></li>
<li>an ICANN domain name owned by the vendor</li>
<li><code>device</code></li>
<li>a device type suffix</li>
<li>an integer device version</li>
</ul>
<p>
To allow for backward compatibility the UPnP driver must automatically
generate additional Device Type property entries for smaller versions
than the current one. If for example a device announces its type as
version 3, then properties for versions 2 and 1 must be automatically
generated.
<p>
In the case of exporting a UPnPDevice, the highest available version must
be announced on the network.
<p>
Syntax Example: <code>urn:schemas-upnp-org:device:deviceType:v</code>
<p>
The value is "UPnP.device.type".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.TYPE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MANUFACTURER"><!-- --></A><H3>
MANUFACTURER</H3>
<PRE>
static final java.lang.String <B>MANUFACTURER</B></PRE>
<DL>
<DD>Mandatory property key for the device manufacturer's property. The
property value holds a String representation of the device manufacturer's
name. Value is "UPnP.device.manufacturer".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MANUFACTURER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MODEL_NAME"><!-- --></A><H3>
MODEL_NAME</H3>
<PRE>
static final java.lang.String <B>MODEL_NAME</B></PRE>
<DL>
<DD>Mandatory property key for the device model name. The property value
holds a <code>String</code> object giving more information about the device
model. Value is "UPnP.device.modelName".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MODEL_NAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FRIENDLY_NAME"><!-- --></A><H3>
FRIENDLY_NAME</H3>
<PRE>
static final java.lang.String <B>FRIENDLY_NAME</B></PRE>
<DL>
<DD>Mandatory property key for a short user friendly version of the device
name. The property value holds a <code>String</code> object with the user
friendly name of the device. Value is "UPnP.device.friendlyName".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.FRIENDLY_NAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MANUFACTURER_URL"><!-- --></A><H3>
MANUFACTURER_URL</H3>
<PRE>
static final java.lang.String <B>MANUFACTURER_URL</B></PRE>
<DL>
<DD>Optional property key for a URL to the device manufacturers Web site. The
value of the property is a <code>String</code> object representing the URL.
Value is "UPnP.device.manufacturerURL".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MANUFACTURER_URL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MODEL_DESCRIPTION"><!-- --></A><H3>
MODEL_DESCRIPTION</H3>
<PRE>
static final java.lang.String <B>MODEL_DESCRIPTION</B></PRE>
<DL>
<DD>Optional (but recommended) property key for a <code>String</code> object
with a long description of the device for the end user. The value is
"UPnP.device.modelDescription".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MODEL_DESCRIPTION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MODEL_NUMBER"><!-- --></A><H3>
MODEL_NUMBER</H3>
<PRE>
static final java.lang.String <B>MODEL_NUMBER</B></PRE>
<DL>
<DD>Optional (but recommended) property key for a <code>String</code> class
typed property holding the model number of the device. Value is
"UPnP.device.modelNumber".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MODEL_NUMBER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MODEL_URL"><!-- --></A><H3>
MODEL_URL</H3>
<PRE>
static final java.lang.String <B>MODEL_URL</B></PRE>
<DL>
<DD>Optional property key for a <code>String</code> typed property holding a
string representing the URL to the Web site for this model. Value is
"UPnP.device.modelURL".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.MODEL_URL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SERIAL_NUMBER"><!-- --></A><H3>
SERIAL_NUMBER</H3>
<PRE>
static final java.lang.String <B>SERIAL_NUMBER</B></PRE>
<DL>
<DD>Optional (but recommended) property key for a <code>String</code> typed
property holding the serial number of the device. Value is
"UPnP.device.serialNumber".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.SERIAL_NUMBER">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="UPC"><!-- --></A><H3>
UPC</H3>
<PRE>
static final java.lang.String <B>UPC</B></PRE>
<DL>
<DD>Optional property key for a <code>String</code> typed property holding the
Universal Product Code (UPC) of the device. Value is "UPnP.device.UPC".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.UPC">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PRESENTATION_URL"><!-- --></A><H3>
PRESENTATION_URL</H3>
<PRE>
static final java.lang.String <B>PRESENTATION_URL</B></PRE>
<DL>
<DD>Optional (but recommended) property key for a <code>String</code> typed
property holding a string representing the URL to a device representation
Web page. Value is "UPnP.presentationURL".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.PRESENTATION_URL">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PARENT_UDN"><!-- --></A><H3>
PARENT_UDN</H3>
<PRE>
static final java.lang.String <B>PARENT_UDN</B></PRE>
<DL>
<DD>The property key that must be set for all embedded devices. It contains
the UDN of the parent device. The property is not set for root devices.
The value is "UPnP.device.parentUDN".
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.PARENT_UDN">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CHILDREN_UDN"><!-- --></A><H3>
CHILDREN_UDN</H3>
<PRE>
static final java.lang.String <B>CHILDREN_UDN</B></PRE>
<DL>
<DD>The property key that must be set for all devices containing other
embedded devices.
<p>
The value is an array of UDNs for each of the device's children (
<code>String[]</code>). The array contains UDNs for the immediate
descendants only.
</p>
<p>
If an embedded device in turn contains embedded devices, the latter are
not included in the array.
</p>
The UPnP Specification does not encourage more than two levels of
nesting.
<p>
The property is not set if the device does not contain embedded devices.
<p>
The property is of type <code>String[]</code>. Value is
"UPnP.device.childrenUDN"
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.upnp.UPnPDevice.CHILDREN_UDN">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="getService(java.lang.String)"><!-- --></A><H3>
getService</H3>
<PRE>
<A HREF="../../../../org/osgi/service/upnp/UPnPService.html" title="interface in org.osgi.service.upnp">UPnPService</A> <B>getService</B>(java.lang.String serviceId)</PRE>
<DL>
<DD>Locates a specific service by its service id.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>serviceId</CODE> - The service id
<DT><B>Returns:</B><DD>The requested service or null if not found.</DL>
</DD>
</DL>
<HR>
<A NAME="getServices()"><!-- --></A><H3>
getServices</H3>
<PRE>
<A HREF="../../../../org/osgi/service/upnp/UPnPService.html" title="interface in org.osgi.service.upnp">UPnPService</A>[] <B>getServices</B>()</PRE>
<DL>
<DD>Lists all services provided by this device.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Array of services or <code>null</code> if no services are
available.</DL>
</DD>
</DL>
<HR>
<A NAME="getIcons(java.lang.String)"><!-- --></A><H3>
getIcons</H3>
<PRE>
<A HREF="../../../../org/osgi/service/upnp/UPnPIcon.html" title="interface in org.osgi.service.upnp">UPnPIcon</A>[] <B>getIcons</B>(java.lang.String locale)</PRE>
<DL>
<DD>Lists all icons for this device in a given locale.
The UPnP specification allows a device to present different icons based
on the client's locale.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - A language tag as defined by RFC 1766 and maintained by ISO
639. Examples include "<code>de</code>", "<code>en</code>" or "
<code>en-US</code>". The default locale of the device is specified
by passing a <code>null</code> argument.
<DT><B>Returns:</B><DD>Array of icons or null if no icons are available.</DL>
</DD>
</DL>
<HR>
<A NAME="getDescriptions(java.lang.String)"><!-- --></A><H3>
getDescriptions</H3>
<PRE>
java.util.Dictionary <B>getDescriptions</B>(java.lang.String locale)</PRE>
<DL>
<DD>Get a set of localized UPnP properties.
The UPnP specification allows a device to present different device
properties based on the client's locale. The properties used to register
the UPnPDevice service in the OSGi registry are based on the device's
default locale. To obtain a localized set of the properties, an
application can use this method.
<p>
Not all properties might be available in all locales. This method does
<b>not </b> substitute missing properties with their default locale
versions.
<p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>locale</CODE> - A language tag as defined by RFC 1766 and maintained by ISO
639. Examples include "<code>de</code>", "<code>en</code>" or "
<code>en-US</code>". The default locale of the device is specified
by passing a <code>null</code> argument.
<DT><B>Returns:</B><DD>Dictionary mapping property name Strings to property value
Strings</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="../../../../org/osgi/service/upnp/UPnPAction.html" title="interface in org.osgi.service.upnp"><B>PREV CLASS</B></A>
<A HREF="../../../../org/osgi/service/upnp/UPnPEventListener.html" title="interface in org.osgi.service.upnp"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/upnp/UPnPDevice.html" target="_top"><B>FRAMES</B></A>
<A HREF="UPnPDevice.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>
|