/usr/share/doc/libosgi-compendium-java/api/org/osgi/service/deploymentadmin/DeploymentPackage.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 | <!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:53 UTC 2011 -->
<TITLE>
DeploymentPackage
</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="DeploymentPackage";
}
}
</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/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/deploymentadmin/DeploymentPackage.html" target="_top"><B>FRAMES</B></A>
<A HREF="DeploymentPackage.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.deploymentadmin</FONT>
<BR>
Interface DeploymentPackage</H2>
<HR>
<DL>
<DT><PRE>public interface <B>DeploymentPackage</B></DL>
</PRE>
<P>
The <code>DeploymentPackage</code> object represents a deployment package
(already installed or being currently processed). A Deployment Package groups
resources as a unit of management. A deployment package is something that can
be installed, updated, and uninstalled as a unit. A deployment package is a
reified concept, like a bundle, in an OSGi Service Platform. It is not known
by the OSGi Framework, but it is managed by the Deployment Admin service. A
deployment package is a stream of resources (including bundles) which, once
processed, will result in new artifacts (effects on the system) being added
to the OSGi platform. These new artifacts can include installed Bundles, new
configuration objects added to the Configuration Admin service, new Wire
objects added to the Wire Admin service, or changed system properties, etc.
All the changes caused by the processing of a deployment package are
persistently associated with the deployment package, so that they can be
appropriately cleaned up when the deployment package is uninstalled. There is
a strict no overlap rule imposed on deployment packages. Two deployment
packages are not allowed to create or manipulate the same artifact.
Obviously, this means that a bundle cannot be in two different deployment
packages. Any violation of this no overlap rule is considered an error and
the install or update of the offending deployment package must be aborted.
<p>
The Deployment Admin service should do as much as possible to ensure
transactionality. It means that if a deployment package installation, update
or removal (uninstall) fails all the side effects caused by the process
should be disappeared and the system should be in the state in which it was
before the process.
<p>
If a deployment package is being updated the old version is visible through
the <code>DeploymentPackage</code> interface until the update process ends.
After the package is updated the updated version is visible and the old one
is not accessible any more.
<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/deploymentadmin/DeploymentPackage.html#EVENT_DEPLOYMENTPACKAGE_CURRENTVERSION">EVENT_DEPLOYMENTPACKAGE_CURRENTVERSION</A></B></CODE>
<BR>
The currently installed version of the Deployment Package.</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/deploymentadmin/DeploymentPackage.html#EVENT_DEPLOYMENTPACKAGE_NAME">EVENT_DEPLOYMENTPACKAGE_NAME</A></B></CODE>
<BR>
The name of the Deployment Package.</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/deploymentadmin/DeploymentPackage.html#EVENT_DEPLOYMENTPACKAGE_NEXTVERSION">EVENT_DEPLOYMENTPACKAGE_NEXTVERSION</A></B></CODE>
<BR>
The version of DP after the successful completion of the install
operation (used in INSTALL event only).</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/deploymentadmin/DeploymentPackage.html#EVENT_DEPLOYMENTPACKAGE_READABLENAME">EVENT_DEPLOYMENTPACKAGE_READABLENAME</A></B></CODE>
<BR>
The human readable name of the DP localized to the default locale.</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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object other)</CODE>
<BR>
Indicates whether some other object is "equal to" this one.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.osgi.framework.Bundle</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getBundle(java.lang.String)">getBundle</A></B>(java.lang.String symbolicName)</CODE>
<BR>
Returns the bundle instance, which is part of this deployment package,
that corresponds to the bundle's symbolic name passed in the
<code>symbolicName</code> parameter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../org/osgi/service/deploymentadmin/BundleInfo.html" title="interface in org.osgi.service.deploymentadmin">BundleInfo</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getBundleInfos()">getBundleInfos</A></B>()</CODE>
<BR>
Returns an array of <A HREF="../../../../org/osgi/service/deploymentadmin/BundleInfo.html" title="interface in org.osgi.service.deploymentadmin"><CODE>BundleInfo</CODE></A> objects representing the bundles
specified in the manifest of this deployment package.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getDisplayName()">getDisplayName</A></B>()</CODE>
<BR>
Returns the Deployment Package human readable name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getHeader(java.lang.String)">getHeader</A></B>(java.lang.String header)</CODE>
<BR>
Returns the requested deployment package manifest header from the main
section.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.net.URL</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getIcon()">getIcon</A></B>()</CODE>
<BR>
Returns a URL pointing to an image that represents the icon for this
Deployment Package.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getName()">getName</A></B>()</CODE>
<BR>
Returns the Deployment Package Symbolic Name of the package.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getResourceHeader(java.lang.String, java.lang.String)">getResourceHeader</A></B>(java.lang.String resource,
java.lang.String header)</CODE>
<BR>
Returns the requested deployment package manifest header from the name
section determined by the resource parameter.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.osgi.framework.ServiceReference</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getResourceProcessor(java.lang.String)">getResourceProcessor</A></B>(java.lang.String resource)</CODE>
<BR>
At the time of deployment, resource processor service instances are
located to resources contained in a deployment package.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getResources()">getResources</A></B>()</CODE>
<BR>
Returns an array of strings representing the resources (including
bundles) that are specified in the manifest of this deployment package.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.osgi.framework.Version</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getVersion()">getVersion</A></B>()</CODE>
<BR>
Returns the version of the deployment package.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#hashCode()">hashCode</A></B>()</CODE>
<BR>
Returns a hash code value for the object.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#isStale()">isStale</A></B>()</CODE>
<BR>
Gives back the state of the deployment package whether it is stale or
not).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstall()">uninstall</A></B>()</CODE>
<BR>
Uninstalls the deployment package.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstallForced()">uninstallForced</A></B>()</CODE>
<BR>
This method is called to completely uninstall a deployment package, which
couldn't be uninstalled using traditional means (<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstall()"><CODE>uninstall()</CODE></A>)
due to exceptions.</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="EVENT_DEPLOYMENTPACKAGE_NAME"><!-- --></A><H3>
EVENT_DEPLOYMENTPACKAGE_NAME</H3>
<PRE>
static final java.lang.String <B>EVENT_DEPLOYMENTPACKAGE_NAME</B></PRE>
<DL>
<DD>The name of the Deployment Package. This name is the same name as that
specified in the DeploymentPackage-SymbolicName Manifest header.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.deploymentadmin.DeploymentPackage.EVENT_DEPLOYMENTPACKAGE_NAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="EVENT_DEPLOYMENTPACKAGE_READABLENAME"><!-- --></A><H3>
EVENT_DEPLOYMENTPACKAGE_READABLENAME</H3>
<PRE>
static final java.lang.String <B>EVENT_DEPLOYMENTPACKAGE_READABLENAME</B></PRE>
<DL>
<DD>The human readable name of the DP localized to the default locale.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.deploymentadmin.DeploymentPackage.EVENT_DEPLOYMENTPACKAGE_READABLENAME">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="EVENT_DEPLOYMENTPACKAGE_CURRENTVERSION"><!-- --></A><H3>
EVENT_DEPLOYMENTPACKAGE_CURRENTVERSION</H3>
<PRE>
static final java.lang.String <B>EVENT_DEPLOYMENTPACKAGE_CURRENTVERSION</B></PRE>
<DL>
<DD>The currently installed version of the Deployment Package. The attribute
is not present, if no version is installed:
<ul>
<li>in the INSTALL event, when an installDeploymentPackage was called and
no earlier version is present
<li>in the COMPLETE event after the _successfully_ completing an
uninstallDeploymentPackage call
</ul>
The value for this event must be a Version object.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.deploymentadmin.DeploymentPackage.EVENT_DEPLOYMENTPACKAGE_CURRENTVERSION">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="EVENT_DEPLOYMENTPACKAGE_NEXTVERSION"><!-- --></A><H3>
EVENT_DEPLOYMENTPACKAGE_NEXTVERSION</H3>
<PRE>
static final java.lang.String <B>EVENT_DEPLOYMENTPACKAGE_NEXTVERSION</B></PRE>
<DL>
<DD>The version of DP after the successful completion of the install
operation (used in INSTALL event only).
The value for this event must be a Version object.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.osgi.service.deploymentadmin.DeploymentPackage.EVENT_DEPLOYMENTPACKAGE_NEXTVERSION">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="isStale()"><!-- --></A><H3>
isStale</H3>
<PRE>
boolean <B>isStale</B>()</PRE>
<DL>
<DD>Gives back the state of the deployment package whether it is stale or
not). After uninstall of a deployment package it becomes stale. Any
active method calls to a stale deployment package raise
<CODE>IllegalStateException</CODE>. Active methods are the following:
<p>
<ul>
<li><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getBundle(java.lang.String)"><CODE>getBundle(String)</CODE></A></li>
<li><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#getResourceProcessor(java.lang.String)"><CODE>getResourceProcessor(String)</CODE></A></li>
<li><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstall()"><CODE>uninstall()</CODE></A></li>
<li><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstallForced()"><CODE>uninstallForced()</CODE></A></li>
</ul>
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if the deployment package is stale. <code>false</code>
otherwise<DT><B>See Also:</B><DD><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstall()"><CODE>uninstall()</CODE></A>,
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstallForced()"><CODE>uninstallForced()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getName()"><!-- --></A><H3>
getName</H3>
<PRE>
java.lang.String <B>getName</B>()</PRE>
<DL>
<DD>Returns the Deployment Package Symbolic Name of the package.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The name of the deployment package. It cannot be null.</DL>
</DD>
</DL>
<HR>
<A NAME="getDisplayName()"><!-- --></A><H3>
getDisplayName</H3>
<PRE>
java.lang.String <B>getDisplayName</B>()</PRE>
<DL>
<DD>Returns the Deployment Package human readable name.
This method returns the localized human readable name as set with the
<code>DeploymentPackage-Name</code> manifest header using the default
locale. If no header is set, this method will return <code>null</code>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The human readable name of the deployment package or
<code>null</code> if header is not set.<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getVersion()"><!-- --></A><H3>
getVersion</H3>
<PRE>
org.osgi.framework.Version <B>getVersion</B>()</PRE>
<DL>
<DD>Returns the version of the deployment package.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>version of the deployment package. It cannot be null.</DL>
</DD>
</DL>
<HR>
<A NAME="getBundleInfos()"><!-- --></A><H3>
getBundleInfos</H3>
<PRE>
<A HREF="../../../../org/osgi/service/deploymentadmin/BundleInfo.html" title="interface in org.osgi.service.deploymentadmin">BundleInfo</A>[] <B>getBundleInfos</B>()</PRE>
<DL>
<DD>Returns an array of <A HREF="../../../../org/osgi/service/deploymentadmin/BundleInfo.html" title="interface in org.osgi.service.deploymentadmin"><CODE>BundleInfo</CODE></A> objects representing the bundles
specified in the manifest of this deployment package. Its size is equal
to the number of the bundles in the deployment package.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>array of <code>BundleInfo</code> objects
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the appropriate
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentAdminPermission</CODE></A> with "metadata" action</DL>
</DD>
</DL>
<HR>
<A NAME="getIcon()"><!-- --></A><H3>
getIcon</H3>
<PRE>
java.net.URL <B>getIcon</B>()</PRE>
<DL>
<DD>Returns a URL pointing to an image that represents the icon for this
Deployment Package.
The <code>DeploymentPackage-Icon</code> header can set an icon for the
the deployment package. This method returns an absolute URL that is
defined by this header. The Deployment Admin service must provide this
icon as a local resource. That is, the Deployment Admin must make a local
copy of the specified icon. The returned <code>URL</code>'s must point to
a local resource.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>An absolute URL to a local (device resident) image resource or
<code>null</code> if not found<DT><B>Since:</B></DT>
<DD>1.1</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="getBundle(java.lang.String)"><!-- --></A><H3>
getBundle</H3>
<PRE>
org.osgi.framework.Bundle <B>getBundle</B>(java.lang.String symbolicName)</PRE>
<DL>
<DD>Returns the bundle instance, which is part of this deployment package,
that corresponds to the bundle's symbolic name passed in the
<code>symbolicName</code> parameter. This method will return null for
request for bundles that are not part of this deployment package.
<p>
As this instance is transient (i.e. a bundle can be removed at any time
because of the dynamic nature of the OSGi platform), this method may also
return null if the bundle is part of this deployment package, but is not
currently defined to the framework.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>symbolicName</CODE> - the symbolic name of the requested bundle
<DT><B>Returns:</B><DD>The <code>Bundle</code> instance for a given bundle symbolic
name.
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the appropriate
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentAdminPermission</CODE></A> with "metadata" action
<DD><CODE>java.lang.IllegalStateException</CODE> - if the package is stale</DL>
</DD>
</DL>
<HR>
<A NAME="getResources()"><!-- --></A><H3>
getResources</H3>
<PRE>
java.lang.String[] <B>getResources</B>()</PRE>
<DL>
<DD>Returns an array of strings representing the resources (including
bundles) that are specified in the manifest of this deployment package. A
string element of the array is the same as the value of the "Name"
attribute in the manifest. The array contains the bundles as well.
<p>
E.g. if the "Name" section of the resource (or individual-section as the
<a
href="http://java.sun.com/j2se/1.4.2/docs/guide/jar/jar.html#Manifest%20Specification">Manifest
Specification</a> calls it) in the manifest is the following
<pre>
Name: foo/readme.txt
Resource-Processor: foo.rp
</pre>
then the corresponding array element is the "foo/readme.txt" string.
<p>
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The string array corresponding to resources. It cannot be null
but its length can be zero.
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the appropriate
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentAdminPermission</CODE></A> with "metadata" action</DL>
</DD>
</DL>
<HR>
<A NAME="getResourceProcessor(java.lang.String)"><!-- --></A><H3>
getResourceProcessor</H3>
<PRE>
org.osgi.framework.ServiceReference <B>getResourceProcessor</B>(java.lang.String resource)</PRE>
<DL>
<DD>At the time of deployment, resource processor service instances are
located to resources contained in a deployment package.
<p>
This call returns a service reference to the corresponding service
instance. If the resource is not part of the deployment package or this
call is made during deployment, prior to the locating of the service to
process a given resource, null will be returned. Services can be updated
after a deployment package has been deployed. In this event, this call
will return a reference to the updated service, not to the instance that
was used at deployment time.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resource</CODE> - the name of the resource (it is the same as the value of the
"Name" attribute in the deployment package's manifest)
<DT><B>Returns:</B><DD>resource processor for the resource or <code>null</code>.
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the appropriate <A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentAdminPermission</CODE></A>
with "metadata" action
<DD><CODE>java.lang.IllegalStateException</CODE> - if the package is stale</DL>
</DD>
</DL>
<HR>
<A NAME="getHeader(java.lang.String)"><!-- --></A><H3>
getHeader</H3>
<PRE>
java.lang.String <B>getHeader</B>(java.lang.String header)</PRE>
<DL>
<DD>Returns the requested deployment package manifest header from the main
section. Header names are case insensitive. If the header doesn't exist
it returns null.
<p>
If the header is localized then the localized value is returned (see OSGi
Service Platform, Mobile Specification Release 4 - Localization related
chapters).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>header</CODE> - the requested header
<DT><B>Returns:</B><DD>the value of the header or <code>null</code> if the header does
not exist
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the appropriate
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentAdminPermission</CODE></A> with "metadata" action</DL>
</DD>
</DL>
<HR>
<A NAME="getResourceHeader(java.lang.String, java.lang.String)"><!-- --></A><H3>
getResourceHeader</H3>
<PRE>
java.lang.String <B>getResourceHeader</B>(java.lang.String resource,
java.lang.String header)</PRE>
<DL>
<DD>Returns the requested deployment package manifest header from the name
section determined by the resource parameter. Header names are case
insensitive. If the resource or the header doesn't exist it returns null.
<p>
If the header is localized then the localized value is returned (see OSGi
Service Platform, Mobile Specification Release 4 - Localization related
chapters).
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resource</CODE> - the name of the resource (it is the same as the value of the
"Name" attribute in the deployment package's manifest)<DD><CODE>header</CODE> - the requested header
<DT><B>Returns:</B><DD>the value of the header or <code>null</code> if the resource or
the header doesn't exist
<DT><B>Throws:</B>
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the appropriate
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentAdminPermission</CODE></A> with "metadata" action</DL>
</DD>
</DL>
<HR>
<A NAME="uninstall()"><!-- --></A><H3>
uninstall</H3>
<PRE>
void <B>uninstall</B>()
throws <A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin">DeploymentException</A></PRE>
<DL>
<DD>Uninstalls the deployment package. After uninstallation, the deployment
package object becomes stale. This can be checked by using
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#isStale()"><CODE>isStale()</CODE></A>, which will return <code>true</code> when stale.
<p>
<P>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin">DeploymentException</A></CODE> - if the deployment package could not be successfully
uninstalled. For detailed error code description see
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentException</CODE></A>.
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the appropriate
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentAdminPermission</CODE></A>("<filter>",
"uninstall") permission.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the package is stale</DL>
</DD>
</DL>
<HR>
<A NAME="uninstallForced()"><!-- --></A><H3>
uninstallForced</H3>
<PRE>
boolean <B>uninstallForced</B>()
throws <A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin">DeploymentException</A></PRE>
<DL>
<DD>This method is called to completely uninstall a deployment package, which
couldn't be uninstalled using traditional means (<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstall()"><CODE>uninstall()</CODE></A>)
due to exceptions. After uninstallation, the deployment package object
becomes stale. This can be checked by using <A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#isStale()"><CODE>isStale()</CODE></A>, which
will return <code>true</code> when stale.
<p>
The method forces removal of the Deployment Package from the repository
maintained by the Deployment Admin service. This method follows the same
steps as <A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentPackage.html#uninstall()"><CODE>uninstall()</CODE></A>. However, any errors or the absence of
Resource Processor services are ignored, they must not cause a roll back.
These errors should be logged.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the operation was successful
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin">DeploymentException</A></CODE> - only <A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentException.html#CODE_TIMEOUT"><CODE>DeploymentException.CODE_TIMEOUT</CODE></A>
and <A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentException.html#CODE_CANCELLED"><CODE>DeploymentException.CODE_CANCELLED</CODE></A> can be thrown. For
detailed error code description see <A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentException</CODE></A>.
<DD><CODE>java.lang.SecurityException</CODE> - if the caller doesn't have the appropriate
<A HREF="../../../../org/osgi/service/deploymentadmin/DeploymentAdminPermission.html" title="class in org.osgi.service.deploymentadmin"><CODE>DeploymentAdminPermission</CODE></A>("<filter>",
"uninstall_forced") permission.
<DD><CODE>java.lang.IllegalStateException</CODE> - if the package is stale</DL>
</DD>
</DL>
<HR>
<A NAME="hashCode()"><!-- --></A><H3>
hashCode</H3>
<PRE>
int <B>hashCode</B>()</PRE>
<DL>
<DD>Returns a hash code value for the object.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>a hash code value for this object</DL>
</DD>
</DL>
<HR>
<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
equals</H3>
<PRE>
boolean <B>equals</B>(java.lang.Object other)</PRE>
<DL>
<DD>Indicates whether some other object is "equal to" this one. Two
deployment packages are equal if they have the same deployment package
symbolic name and version.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>other</CODE> - the reference object with which to compare.
<DT><B>Returns:</B><DD>true if this object is the same as the <code>other</code> argument;
false otherwise.</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/deploymentadmin/DeploymentException.html" title="class in org.osgi.service.deploymentadmin"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/osgi/service/deploymentadmin/DeploymentPackage.html" target="_top"><B>FRAMES</B></A>
<A HREF="DeploymentPackage.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>
|