blob: 254f9c6a1708b0f06077adb99e77d5899bd03b69 [file] [log] [blame]
<html><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Virgo User Guide</title><meta content="DocBook XSL Stylesheets V1.76.0" name="generator"><link rel="home" href="index.html" title="Virgo User Guide"><link rel="next" href="ch01.html" title="Chapter&nbsp;1.&nbsp;Introduction"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table summary="Navigation header" width="100%"><tr><td align="left" width="20%">&nbsp;</td><th align="center" width="60%">&nbsp;</th><td align="right" width="20%">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr></table><hr></div><div class="book" title="Virgo User Guide"><div class="titlepage"><div><div><h1 class="title"><a name="N10001"></a>Virgo User Guide</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Rob</span> <span class="surname">Harrop</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Paul</span> <span class="surname">Kuzan</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Sam</span> <span class="surname">Brannen</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Paul</span> <span class="surname">Harris</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Christopher</span> <span class="surname">Frost</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Ben</span> <span class="surname">Hale</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Glyn</span> <span class="surname">Normington</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Juliet</span> <span class="surname">Shackell</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Steve</span> <span class="surname">Powell</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Violeta</span> <span class="surname">Georgieva</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Hristo</span> <span class="surname">Iliev</span></h3></div><div class="author"><h3 class="author"><span class="firstname">Borislav</span> <span class="surname">Kapukaranov</span></h3></div></div></div><div><p class="releaseinfo">3.5.0</p></div><div><div class="legalnotice" title="Legal Notice"><a name="N10058"></a><p>
Copyright &copy; 2009, 2011 VMware Inc. and others
</p><p>
Contributors:
</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem"><p>
VMware Inc. - initial contribution and subsequent updates
</p></li><li class="listitem"><p>
Violeta Georgieva, SAP AG - Tomcat context configuration
</p></li><li class="listitem"><p>
Hristo Iliev, SAP AG - Setting jmx.properties permissions
</p></li><li class="listitem"><p>
Borislav Kapukaranov, SAP AG - Configuring framework extensions and fragments on system bundle; Added Virgo Nano references and tips
</p></li></ul></div><p>
</p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="ch01.html">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="ch01.html#N10073">A Note for Virgo Kernel Users</a></span></dt><dt><span class="section"><a href="ch01s02.html">A Note for Virgo Jetty Server Users</a></span></dt><dt><span class="section"><a href="ch01s03.html">A Note for Virgo Nano Users</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch02.html">2. Concepts</a></span></dt><dd><dl><dt><span class="section"><a href="ch02.html#concepts.modular">Modular Runtimes and Applications</a></span></dt><dt><span class="section"><a href="ch02s02.html">OSGi Concepts</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s02.html#N100B2">Bundles</a></span></dt><dt><span class="section"><a href="ch02s02.html#N10111">Life Cycle</a></span></dt><dt><span class="section"><a href="ch02s02.html#concepts.services">Services</a></span></dt><dt><span class="section"><a href="ch02s02.html#N10184">Versioning</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s03.html">Spring DM and Blueprint Concepts</a></span></dt><dt><span class="section"><a href="ch02s04.html">Virgo Concepts</a></span></dt><dd><dl><dt><span class="section"><a href="ch02s04.html#concepts.repositories">The Provisioning Repository</a></span></dt></dl></dd><dt><span class="section"><a href="ch02s05.html">p2 Concepts</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch03.html">3. Using the p2 director</a></span></dt><dd><dl><dt><span class="section"><a href="ch03.html#prereqs">Prerequisites</a></span></dt><dt><span class="section"><a href="ch03s02.html">Installing with the p2 director from Eclipse</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch04.html">4. Installing Virgo Server for Apache Tomcat</a></span></dt><dd><dl><dt><span class="section"><a href="ch04.html#installation-prereqs">Prerequisites</a></span></dt><dt><span class="section"><a href="ch04s02.html">Installing from the ZIP Download</a></span></dt><dd><dl><dt><span class="section"><a href="ch04s02.html#N104AD">Downloading the ZIP file</a></span></dt><dt><span class="section"><a href="ch04s02.html#installation-zip-installing">Installing</a></span></dt></dl></dd><dt><span class="section"><a href="ch04s03.html">Installing from an update site</a></span></dt><dd><dl><dt><span class="section"><a href="ch04s03.html#N104E1">The repository location</a></span></dt><dt><span class="section"><a href="ch04s03.html#N104EA">Using the p2 director</a></span></dt></dl></dd><dt><span class="section"><a href="ch04s04.html">Post-installation steps</a></span></dt><dd><dl><dt><span class="section"><a href="ch04s04.html#installation-post-env">Set environment variable variables</a></span></dt><dt><span class="section"><a href="ch04s04.html#installation-post-env-server-win-troubleshooting">Microsoft Windows - Troubleshooting Security Permissions</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch05.html">5. Installing Virgo Kernel</a></span></dt><dd><dl><dt><span class="section"><a href="ch05.html#kernel-installation-prereqs">Prerequisites</a></span></dt><dt><span class="section"><a href="ch05s02.html">Installing from the ZIP Download</a></span></dt><dd><dl><dt><span class="section"><a href="ch05s02.html#N105BA">Downloading the ZIP file</a></span></dt><dt><span class="section"><a href="ch05s02.html#kernel-installation-zip-installing">Installing</a></span></dt></dl></dd><dt><span class="section"><a href="ch05s03.html">Installing from an update site</a></span></dt><dd><dl><dt><span class="section"><a href="ch05s03.html#N105EE">The repository location</a></span></dt><dt><span class="section"><a href="ch05s03.html#N105F7">Using the p2 director</a></span></dt></dl></dd><dt><span class="section"><a href="ch05s04.html">Post-installation steps</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch06.html">6. Installing Virgo Nano</a></span></dt><dd><dl><dt><span class="section"><a href="ch06.html#nano-installation-prereqs">Prerequisites</a></span></dt><dt><span class="section"><a href="ch06s02.html">Installing from the ZIP Download</a></span></dt><dd><dl><dt><span class="section"><a href="ch06s02.html#N10623">Downloading the ZIP file</a></span></dt><dt><span class="section"><a href="ch06s02.html#nano-installation-zip-installing">Installing</a></span></dt></dl></dd><dt><span class="section"><a href="ch06s03.html">Installing from an update site</a></span></dt><dd><dl><dt><span class="section"><a href="ch06s03.html#N10657">The repository location</a></span></dt><dt><span class="section"><a href="ch06s03.html#N10660">Using the p2 director</a></span></dt></dl></dd><dt><span class="section"><a href="ch06s04.html">Post-installation steps</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch07.html">7. Starting and Stopping VTS</a></span></dt><dd><dl><dt><span class="section"><a href="ch07.html#N10681">Starting Virgo Server for Apache Tomcat</a></span></dt><dd><dl><dt><span class="section"><a href="ch07.html#N10697">Linux</a></span></dt><dt><span class="section"><a href="ch07.html#N106AA">Microsoft Windows</a></span></dt></dl></dd><dt><span class="section"><a href="ch07s02.html">Starting in Clean Mode</a></span></dt><dd><dl><dt><span class="section"><a href="ch07s02.html#N106D0">Linux</a></span></dt><dt><span class="section"><a href="ch07s02.html#N106DC">Microsoft Windows</a></span></dt></dl></dd><dt><span class="section"><a href="ch07s03.html">Starting in Debug Mode</a></span></dt><dd><dl><dt><span class="section"><a href="ch07s03.html#N106EB">Linux</a></span></dt><dt><span class="section"><a href="ch07s03.html#N1071B">Microsoft Windows</a></span></dt></dl></dd><dt><span class="section"><a href="ch07s04.html">Starting with JMX Access Modifications</a></span></dt><dd><dl><dt><span class="section"><a href="ch07s04.html#N1075B">Linux</a></span></dt><dt><span class="section"><a href="ch07s04.html#N107E6">Microsoft Windows</a></span></dt></dl></dd><dt><span class="section"><a href="ch07s05.html">Starting with a Custom Configuration Directory</a></span></dt><dd><dl><dt><span class="section"><a href="ch07s05.html#N1089F">Linux</a></span></dt><dt><span class="section"><a href="ch07s05.html#N108AA">Windows</a></span></dt></dl></dd><dt><span class="section"><a href="ch07s06.html">Stopping Virgo Server for Apache Tomcat</a></span></dt><dd><dl><dt><span class="section"><a href="ch07s06.html#N108B8">Linux</a></span></dt><dt><span class="section"><a href="ch07s06.html#N108E6">Microsoft Windows</a></span></dt></dl></dd><dt><span class="section"><a href="ch07s07.html">Cleaning Virgo Server for Apache Tomcat without Starting it</a></span></dt><dd><dl><dt><span class="section"><a href="ch07s07.html#N1092E">Linux</a></span></dt><dt><span class="section"><a href="ch07s07.html#N1093A">Microsoft Windows</a></span></dt></dl></dd><dt><span class="section"><a href="ch07s08.html">Using Equinox Launcher</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch08.html">8. Equinox Console</a></span></dt><dd><dl><dt><span class="section"><a href="ch08.html#admin-shell-enable">Enabling the Equinox Console</a></span></dt><dt><span class="section"><a href="ch08s02.html">Using Virgo Shell Commands</a></span></dt><dd><dl><dt><span class="section"><a href="ch08s02.html#admin-shell-vsh-using-command-list">Virgo Shell Commands</a></span></dt></dl></dd><dt><span class="section"><a href="ch08s03.html">Virgo Shell Command Reference</a></span></dt><dd><dl><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-bundle-command">bundle Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-config-command">config Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-package-command">packages Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-par-command">par Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-plan-command">plan Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-service-command">service Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-install-command">install Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-vsh-shutdown-command">shutdown Command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-cl-clhas">clhas command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-cl-clexport">clexport command</a></span></dt><dt><span class="section"><a href="ch08s03.html#admin-shell-cl-clload">clload command</a></span></dt></dl></dd><dt><span class="section"><a href="ch08s04.html">Using the p2 for extending your Virgo installation</a></span></dt><dd><dl><dt><span class="section"><a href="ch08s04.html#N10F94">Extending with the p2 director</a></span></dt><dt><span class="section"><a href="ch08s04.html#N10FA4">Extending via the p2 shell commands</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch09.html">9. The Admin Console</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#admin-console-login">Invoking the Admin Console</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#admin-console-auth">Changing the Admin User</a></span></dt></dl></dd><dt><span class="section"><a href="ch09s02.html">Typical Admin Console Use Cases</a></span></dt><dd><dl><dt><span class="section"><a href="ch09s02.html#admin-console-manage-artifacts">Viewing and Managing the Lifecycle of Deployed Artifacts</a></span></dt><dt><span class="section"><a href="ch09s02.html#admin-console-install-artifacts">Installing a New Artifact</a></span></dt><dt><span class="section"><a href="ch09s02.html#admin-console-view-properties">Viewing Properties of Deployed Configuration Artifacts</a></span></dt><dt><span class="section"><a href="ch09s02.html#admin-console-view-dumps">Viewing the Details of Dump Files</a></span></dt><dt><span class="section"><a href="ch09s02.html#admin-console-view-osgi-state">Viewing Overview and Details of the OSGi State</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch10.html">10. The Provisioning Repository</a></span></dt><dd><dl><dt><span class="section"><a href="ch10.html#repository-introduction">Overview of the Provisioning Repository</a></span></dt><dd><dl><dt><span class="section"><a href="ch10.html#repository-structure">Local Repository Structure</a></span></dt><dt><span class="section"><a href="ch10.html#repository-installing-bundles">Installing Artifacts to a Repository</a></span></dt></dl></dd><dt><span class="section"><a href="ch10s02.html">Downloading Bundles from the SpringSource Enterprise Bundle Repository</a></span></dt><dt><span class="section"><a href="ch10s03.html">Configuring the Repository</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch11.html">11. Serviceability and Diagnostics</a></span></dt><dd><dl><dt><span class="section"><a href="ch11.html#serviceability-info-log">Event Logging</a></span></dt><dt><span class="section"><a href="ch11s02.html">(Trace) Logging</a></span></dt><dd><dl><dt><span class="section"><a href="ch11s02.html#serviceability-info-trace-app">Application Output</a></span></dt></dl></dd><dt><span class="section"><a href="ch11s03.html">Service Dumps</a></span></dt></dl></dd><dt><span class="chapter"><a href="ch12.html">12. Working with Applications</a></span></dt><dd><dl><dt><span class="section"><a href="ch12.html#deployment-deploying">Deploying Artifacts</a></span></dt><dd><dl><dt><span class="section"><a href="ch12.html#deployment-deploying-hot">Hot Deploy</a></span></dt><dt><span class="section"><a href="ch12.html#deployment-deploying-manual">Deploying Using the Admin Console</a></span></dt><dt><span class="section"><a href="ch12.html#deployment-deploying-happens">What Happens When You Deploy</a></span></dt><dt><span class="section"><a href="ch12.html#deployment-deploying-ordering">Deployment Ordering</a></span></dt><dt><span class="section"><a href="ch12.html#deployment-deploying-shared">Deploying Shared Artifacts</a></span></dt><dt><span class="section"><a href="ch12.html#deployment-deploying-restrictions">Restrictions</a></span></dt></dl></dd><dt><span class="section"><a href="ch12s02.html">Undeploying Artifacts</a></span></dt><dd><dl><dt><span class="section"><a href="ch12s02.html#deployment-undeploy-hot">Hot Undeploy</a></span></dt><dt><span class="section"><a href="ch12s02.html#deployment-undeploy-manual">Undeploying Using the Admin Console</a></span></dt><dt><span class="section"><a href="ch12s02.html#deployment-undeploying-shared">Undeploying Shared Artifacts</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="ch13.html">13. Configuration</a></span></dt><dd><dl><dt><span class="section"><a href="ch13.html#configuring-osgi-framework">Configuring the OSGi Framework</a></span></dt><dd><dl><dt><span class="section"><a href="ch13.html#configuring-framework-properties">Configuring OSGi Framework Properties</a></span></dt><dt><span class="section"><a href="ch13.html#configuring-framework-bundles">Configuring OSGi Framework Bundles</a></span></dt><dt><span class="section"><a href="ch13.html#configuring-framework-profile">Configuring OSGi Framework Profile</a></span></dt></dl></dd><dt><span class="section"><a href="ch13s02.html">Configuring Framework Extensions and Fragments on the System Bundle</a></span></dt><dt><span class="section"><a href="ch13s03.html">Configuring Serviceability and Diagnostics</a></span></dt><dd><dl><dt><span class="section"><a href="ch13s03.html#configuring-serviceability-medic">The org.eclipse.virgo.medic.properties File</a></span></dt><dt><span class="section"><a href="ch13s03.html#configuring-serviceability-logback">The serviceability.xml File</a></span></dt></dl></dd><dt><span class="section"><a href="ch13s04.html">Configuring the Local Provisioning Repository</a></span></dt><dd><dl><dt><span class="section"><a href="ch13s04.html#configuring-repository-watched-versus-external">Should I Configure a Watched or External Repository?</a></span></dt><dt><span class="section"><a href="ch13s04.html#configuring-provisioning-repository-search-paths">Search Paths: Additional Information</a></span></dt><dt><span class="section"><a href="ch13s04.html#configuring-provisioning-repository-using-system-properties">Using System Properties</a></span></dt><dt><span class="section"><a href="ch13s04.html#configuring-provisioning-repository-examples">Example Repository Configurations</a></span></dt></dl></dd><dt><span class="section"><a href="ch13s05.html">Configuring a Hosted Repository</a></span></dt><dt><span class="section"><a href="ch13s06.html">Configuring the Kernel and User Region</a></span></dt><dd><dl><dt><span class="section"><a href="ch13s06.html#configuring-kernel-properties">Configuring the Kernel</a></span></dt><dt><span class="section"><a href="ch13s06.html#configuring-kernel-files">Configuration Files</a></span></dt><dt><span class="section"><a href="ch13s06.html#configuring-deployment">Configuring Deployment</a></span></dt><dt><span class="section"><a href="ch13s06.html#configuring-user-region">Configuring the User Region</a></span></dt><dt><span class="section"><a href="ch13s06.html#configuring-authentication">Configuring Authentication</a></span></dt></dl></dd><dt><span class="section"><a href="ch13s07.html">Configuring the Embedded Tomcat Servlet Container</a></span></dt><dd><dl><dt><span class="section"><a href="ch13s07.html#overview-tomcat-servlet-container">Description of the Default Apache Tomcat Configuration</a></span></dt><dt><span class="section"><a href="ch13s07.html#configuring-tomcat-connectors">Connector Configuration</a></span></dt><dt><span class="section"><a href="ch13s07.html#configuring-tomcat-clustering">Cluster Configuration</a></span></dt><dt><span class="section"><a href="ch13s07.html#configuring-tomcat-contexts">Context Configuration</a></span></dt></dl></dd><dt><span class="section"><a href="ch13s08.html">Configuring the Web Integration Layer</a></span></dt><dt><span class="section"><a href="ch13s09.html">Configuring the Embedded Jetty Servlet Container</a></span></dt></dl></dd><dt><span class="appendix"><a href="apa.html">A. Event log codes</a></span></dt><dd><dl><dt><span class="section"><a href="apa.html#event-log-codes-format">Format of the event log codes</a></span></dt></dl></dd><dt><span class="appendix"><a href="apb.html">B. Known Issues</a></span></dt><dd><dl><dt><span class="section"><a href="apb.html#known-issues-firewall-timeout">Timeout During Startup Due to Firewall Settings</a></span></dt><dt><span class="section"><a href="apbs02.html">Timeout During Startup Due to Insufficient Resources</a></span></dt><dt><span class="section"><a href="apbs03.html">OutOfMemoryError: PermGen Space Running on Sun JVM</a></span></dt><dt><span class="section"><a href="apbs04.html">Alternate <code class="literal">serviceability</code> and <code class="literal">work</code> Directories</a></span></dt><dt><span class="section"><a href="apbs05.html">Problem Deleting Installation Directory under Windows</a></span></dt><dt><span class="section"><a href="apbs06.html">Long Work Directory Paths under Windows</a></span></dt><dt><span class="section"><a href="apbs07.html">Virgo Jetty Server Restrictions</a></span></dt><dt><span class="section"><a href="apbs08.html">Shutdown Log Messages in Telnet Shell</a></span></dt></dl></dd><dt><span class="appendix"><a href="apc.html">C.
Further Reading
</a></span></dt></dl></div><div class="list-of-figures"><p><b>List of Figures</b></p><dl><dt>2.1. <a href="ch02s02.html#N10135">Bundle life cycle</a></dt></dl></div></div><div class="navfooter"><hr><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%">&nbsp;</td><td align="center" width="20%">&nbsp;</td><td align="right" width="40%">&nbsp;<a accesskey="n" href="ch01.html">Next</a></td></tr></table></div></body></html>