Added: commons/sandbox/runtime/trunk/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/site/xdoc/index.xml?rev=1084131&view=auto
==============================================================================
--- commons/sandbox/runtime/trunk/src/site/xdoc/index.xml (added)
+++ commons/sandbox/runtime/trunk/src/site/xdoc/index.xml Tue Mar 22 11:04:49
2011
@@ -0,0 +1,144 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<document>
+
+<properties>
+ <title>Home</title>
+ <author email="[email protected]">Mladen Turk</author>
+</properties>
+
+<body>
+<section name="Apache Commons Runtime">
+<p>In today's world Java is used mainly to develop server based
+application. On the other hand Java doesn't offer API that
+can fully benefit from the features most modern operating systems provide.
+</p>
+<p>Apache Commons Runtime tries to solve that gap by providing the
+JNI layer and Java API over that layer, allowing application to
+fully utilize operating system features that are missing from the
+main JDK implementation.
+</p>
+<p>Supported operating systems are chosen on the deployment basis
+but any new operating system can be easily added by writing the
+appropriate wrappers.
+</p>
+<p>
+ <table>
+ <tr>
+ <th>Operating System</th>
+ <th>Minimum Supported Version</th>
+ <th>Notes</th>
+ </tr>
+ <tr>
+ <td>Linux</td>
+ <td>2.6.18</td>
+ <td>Kernel needs AIO support</td>
+ </tr>
+ <tr>
+ <td>Microsoft Windows</td>
+ <td>XP</td>
+ <td>Needs Vista+ for Kernel Transactions</td>
+ </tr>
+ <tr>
+ <td>Oracle Solaris</td>
+ <td>10</td>
+ <td>Intel and Sparc</td>
+ </tr>
+ <tr>
+ <td>Mac OS X</td>
+ <td>10.5</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>Hewlett Packard</td>
+ <td>HP-UX 11</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td>IBM</td>
+ <td>AIX 5.3</td>
+ <td></td>
+ </tr>
+ </table>
+</p>
+ <p>Supported Java platform is <b>Java 6</b> and later versions.
+ </p>
+<p>Apache Commons Runtime supports the following extensions to
+the existing JDK classes:
+<ul>
+ <li><b>Memory Management</b><br/>
+ Used for managing the memory allocated directly from the operating
+ system.
+ </li>
+ <li><b>Mutex and Semaphore</b><br/>
+ Mutex and Semaphore objects are used for cross process synchronization.
+ </li>
+ <li><b>Shared Memory</b><br/>
+ Full support for named and anonymous shared memory.
+ </li>
+ <li><b>Memory Mapping</b><br/>
+ File memory mapping.
+ </li>
+ <li><b>Security</b><br/>
+ Native operating system security management and auditing.
+ </li>
+ <li><b>Asynchronous IO</b><br/>
+ Asynchronous IO for Files, Pipes and Sockets.
+ </li>
+ <li><b>OpenSSL</b><br/>
+ Using OpenSSL for SSL and TLS networking.
+ </li>
+ <li><b>Platform Specifics</b><br/>
+ Platform specific classes like Windows Registry or SELinux.
+ </li>
+</ul>
+</p>
+
+</section>
+
+<section name="History">
+<p>Apache Commons Runtime originates from two projects; Apache Commons Daemon
+and Tomcat Native, and is meant to be a direct replacement for those two
projects.
+</p>
+<p>Commons Daemon lacks the features found in Tomcat Native and vice verse.
+The primary reason for merging those two projects was the need for allowing
graceful
+restarts for Java server based applications without restart down time.
+</p>
+<p>That kind of concept is well known inside Apache Httpd project where parent
+process creates the sockets that are passed to the child processes. When
restart
+is needed the previous child generation is stopped after the new child is
created,
+thus allowing zero down time.
+</p>
+<p>Tomcat Native uses Apache Portable Runtime (APR) for its native layer,
+but since APR is generalization of the operating system it makes certain
+compromises to allow cross platform API.
+</p>
+<p>Apache Commons Runtime uses APR code but without the APR memory pools since
+being embedded inside JVM we already have a full garbage collector and
+object life time management out of the box. APR pools in such environment
+make additional layer which introduces unwanted memory overhead and
+performance degradation, so unlike Tomcat Native, we use direct memory
+allocation for all APR objects.
+</p>
+
+</section>
+
+</body>
+</document>
Propchange: commons/sandbox/runtime/trunk/src/site/xdoc/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/sandbox/runtime/trunk/src/site/xdoc/issue-tracking.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/site/xdoc/issue-tracking.xml?rev=1084131&view=auto
==============================================================================
--- commons/sandbox/runtime/trunk/src/site/xdoc/issue-tracking.xml (added)
+++ commons/sandbox/runtime/trunk/src/site/xdoc/issue-tracking.xml Tue Mar 22
11:04:49 2011
@@ -0,0 +1,100 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: sandbox-issue-tracking-template.xml |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:sandbox-jira-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.jira.componentid (required, numeric) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.jira.componentid>12311182</commons.jira.componentid> |
+ | </properties> |
+ | |
+ +======================================================================+
+-->
+<document>
+ <properties>
+ <title>Commons Runtime (Sandbox) Issue tracking</title>
+ <author email="[email protected]">Commons Documentation Team</author>
+ </properties>
+ <body>
+
+ <section name="Commons Runtime (Sandbox) Issue tracking">
+ <p>
+ Commons Runtime (Sandbox) uses <a
href="http://issues.apache.org/jira/">ASF JIRA</a> for tracking issues.
+ See the <a href="http://issues.apache.org/jira/browse/SANDBOX">Sandbox
JIRA project page</a>.
+ </p>
+
+ <p>
+ To use JIRA you may need to <a
href="http://issues.apache.org/jira/secure/Signup!default.jspa">create an
account</a>
+ (if you have previously created/updated Commons issues using Bugzilla an
account will have been automatically
+ created and you can use the <a
href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot
Password</a>
+ page to get a new password).
+ </p>
+
+ <p>
+ If you would like to report a bug, or raise an enhancement request with
+ Commons Runtime (Sandbox) please do the following:
+ <ol>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=12313156&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">Search
existing open bugs</a>.
+ If you find your issue listed then please add a comment with your
details.</li>
+ <li><a href="mail-lists.html">Search the mailing list archive(s)</a>.
+ You may find your issue or idea has already been discussed.</li>
+ <li>Decide if your issue is a bug or an enhancement.</li>
+ <li>Submit either a <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310491&components=12313156&issuetype=1&priority=4&assignee=-1">bug
report</a>
+ or <a
href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310491&components=12313156&issuetype=4&priority=4&assignee=-1">enhancement
request</a>.</li>
+ </ol>
+ </p>
+
+ <p>
+ Please also remember these points:
+ <ul>
+ <li>the more information you provide, the better we can help you</li>
+ <li>test cases are vital, particularly for any proposed
enhancements</li>
+ <li>the developers of Commons Runtime (Sandbox) are all unpaid
volunteers</li>
+ </ul>
+ </p>
+
+ <p>
+ For more information on subversion and creating patches see the
+ <a href="http://www.apache.org/dev/contributors.html">Apache
Contributors Guide</a>.
+ </p>
+
+ <p>
+ You may also find these links useful:
+ <ul>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=12313156&sorter/field=issuekey&sorter/order=DESC&status=1&status=3&status=4">All
Open Commons Runtime (Sandbox) bugs</a></li>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=12313156&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All
Resolved Commons Runtime (Sandbox) bugs</a></li>
+ <li><a
href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310491&component=12313156&sorter/field=issuekey&sorter/order=DESC">All
Commons Runtime (Sandbox) bugs</a></li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>
Propchange: commons/sandbox/runtime/trunk/src/site/xdoc/issue-tracking.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/sandbox/runtime/trunk/src/site/xdoc/mail-lists.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/site/xdoc/mail-lists.xml?rev=1084131&view=auto
==============================================================================
--- commons/sandbox/runtime/trunk/src/site/xdoc/mail-lists.xml (added)
+++ commons/sandbox/runtime/trunk/src/site/xdoc/mail-lists.xml Tue Mar 22
11:04:49 2011
@@ -0,0 +1,202 @@
+<?xml version="1.0"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements. See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+<!--
+ +======================================================================+
+ |**** ****|
+ |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****|
+ |**** DO NOT EDIT DIRECTLY ****|
+ |**** ****|
+ +======================================================================+
+ | TEMPLATE FILE: mail-lists-template.xml |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ | |
+ | 1) Re-generate using: mvn commons:mail-page |
+ | |
+ | 2) Set the following properties in the component's pom: |
+ | - commons.componentid (required, alphabetic, lower case) |
+ | |
+ | 3) Example Properties |
+ | |
+ | <properties> |
+ | <commons.componentid>math</commons.componentid> |
+ | </properties> |
+ | |
+ +======================================================================+
+-->
+<document>
+ <properties>
+ <title>Commons Runtime (Sandbox) Mailing Lists</title>
+ <author email="[email protected]">Commons Documentation Team</author>
+ </properties>
+ <body>
+
+ <section name="Overview">
+ <p>
+ <a href="index.html">Commons Runtime (Sandbox)</a> shares mailing
lists with all the other
+ <a href="http://commons.apache.org/components.html">Commons
Components</a>.
+ To make it easier for people to only read messages related to
components they are interested in,
+ the convention in Commons is to prefix the subject line of messages
with the component's name,
+ for example:
+ <ul>
+ <li>[runtime] Problem with the ...</li>
+ </ul>
+ </p>
+ <p>
+ Questions related to the usage of Commons Runtime (Sandbox) should be
posted to the
+ <a href="http://mail-archives.apache.org/mod_mbox/commons-user/">User
List</a>.
+ <br />
+ The <a
href="http://mail-archives.apache.org/mod_mbox/commons-dev/">Developer List</a>
+ is for questions and discussion related to the development of Commons
Runtime (Sandbox).
+ <br />
+ Please do not cross-post; developers are also subscribed to the user
list.
+ </p>
+ <p>
+ <strong>Note:</strong> please don't send patches or attachments to any
of the mailing lists.
+ Patches are best handled via the <a href="issue-tracking.html">Issue
Tracking</a> system.
+ Otherwise, please upload the file to a public server and include the
URL in the mail.
+ </p>
+ </section>
+
+ <section name="Commons Runtime (Sandbox) Mailing Lists">
+ <p>
+ <strong>Please prefix the subject line of any messages for <a
href="index.html">Commons Runtime (Sandbox)</a>
+ with <i>[runtime]</i></strong> - <i>thanks!</i>
+ <br />
+ <br />
+ </p>
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Subscribe</th>
+ <th>Unsubscribe</th>
+ <th>Post</th>
+ <th>Archive</th>
+ <th>Other Archives</th>
+ </tr>
+
+
+ <tr>
+ <td>
+ <strong>Commons User List</strong>
+ <br /><br />
+ Questions on using Commons Runtime (Sandbox).
+ <br /><br />
+ </td>
+ <td><a
href="mailto:[email protected]">Subscribe</a></td>
+ <td><a
href="mailto:[email protected]">Unsubscribe</a></td>
+ <td><a
href="mailto:[email protected]?subject=[runtime]">Post</a></td>
+ <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-user/">mail-archives.apache.org</a></td>
+ <td><a
href="http://markmail.org/list/org.apache.commons.users/">markmail.org</a><br />
+ <a
href="http://www.mail-archive.com/[email protected]/">www.mail-archive.com</a><br
/>
+ <a
href="http://news.gmane.org/gmane.comp.jakarta.commons.devel">news.gmane.org</a>
+ </td>
+ </tr>
+
+
+ <tr>
+ <td>
+ <strong>Commons Developer List</strong>
+ <br /><br />
+ Discussion of development of Commons Runtime (Sandbox).
+ <br /><br />
+ </td>
+ <td><a
href="mailto:[email protected]">Subscribe</a></td>
+ <td><a
href="mailto:[email protected]">Unsubscribe</a></td>
+ <td><a
href="mailto:[email protected]?subject=[runtime]">Post</a></td>
+ <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-dev/">mail-archives.apache.org</a></td>
+ <td><a
href="http://markmail.org/list/org.apache.commons.dev/">markmail.org</a><br />
+ <a
href="http://www.mail-archive.com/[email protected]/">www.mail-archive.com</a><br
/>
+ <a
href="http://news.gmane.org/gmane.comp.jakarta.commons.devel">news.gmane.org</a>
+ </td>
+ </tr>
+
+
+ <tr>
+ <td>
+ <strong>Commons Issues List</strong>
+ <br /><br />
+ Only for e-mails automatically generated by the <a
href="issue-tracking.html">issue tracking</a> system.
+ <br /><br />
+ </td>
+ <td><a
href="mailto:[email protected]">Subscribe</a></td>
+ <td><a
href="mailto:[email protected]">Unsubscribe</a></td>
+ <td><i>read only</i></td>
+ <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-issues/">mail-archives.apache.org</a></td>
+ <td><a
href="http://markmail.org/list/org.apache.commons.issues/">markmail.org</a><br
/>
+ <a
href="http://www.mail-archive.com/[email protected]/">www.mail-archive.com</a>
+ </td>
+ </tr>
+
+
+ <tr>
+ <td>
+ <strong>Commons Commits List</strong>
+ <br /><br />
+ Only for e-mails automatically generated by the <a
href="source-repository.html">source control</a> sytem.
+ <br /><br />
+ </td>
+ <td><a
href="mailto:[email protected]">Subscribe</a></td>
+ <td><a
href="mailto:[email protected]">Unsubscribe</a></td>
+ <td><i>read only</i></td>
+ <td><a
href="http://mail-archives.apache.org/mod_mbox/commons-commits/">mail-archives.apache.org</a></td>
+ <td><a
href="http://markmail.org/list/org.apache.commons.commits/">markmail.org</a><br
/>
+ <a
href="http://www.mail-archive.com/[email protected]/">www.mail-archive.com</a>
+ </td>
+ </tr>
+
+ </table>
+
+ </section>
+ <section name="Apache Mailing Lists">
+ <p>
+ Other mailing lists which you may find useful include:
+ </p>
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Subscribe</th>
+ <th>Unsubscribe</th>
+ <th>Post</th>
+ <th>Archive</th>
+ <th>Other Archives</th>
+ </tr>
+ <tr>
+ <td>
+ <strong>Apache Announce List</strong>
+ <br /><br />
+ General announcements of Apache project releases.
+ <br /><br />
+ </td>
+ <td><a class="externalLink"
href="mailto:[email protected]">Subscribe</a></td>
+ <td><a class="externalLink"
href="mailto:[email protected]">Unsubscribe</a></td>
+ <td><i>read only</i></td>
+ <td><a class="externalLink"
href="http://mail-archives.apache.org/mod_mbox/announce/">mail-archives.apache.org</a></td>
+ <td><a class="externalLink"
href="http://markmail.org/list/org.apache.announce/">markmail.org</a><br />
+ <a class="externalLink"
href="http://old.nabble.com/Apache-News-and-Announce-f109.html">old.nabble.com</a><br
/>
+ <a class="externalLink"
href="http://www.mail-archive.com/[email protected]/">www.mail-archive.com</a><br
/>
+ <a class="externalLink"
href="http://news.gmane.org/gmane.comp.apache.announce">news.gmane.org</a>
+ </td>
+ </tr>
+ </table>
+
+ </section>
+ </body>
+</document>
Propchange: commons/sandbox/runtime/trunk/src/site/xdoc/mail-lists.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: commons/sandbox/runtime/trunk/src/site/xdoc/proposal.xml
URL:
http://svn.apache.org/viewvc/commons/sandbox/runtime/trunk/src/site/xdoc/proposal.xml?rev=1084131&view=auto
==============================================================================
--- commons/sandbox/runtime/trunk/src/site/xdoc/proposal.xml (added)
+++ commons/sandbox/runtime/trunk/src/site/xdoc/proposal.xml Tue Mar 22
11:04:49 2011
@@ -0,0 +1,70 @@
+<document>
+<properties>
+<title>Proposal for Runtime Package</title>
+</properties>
+<body>
+
+
+<section name="Proposal for Runtime Package">
+
+<subsection name="(0) Rationale">
+
+<p>Apache Commons Runtime provide Java classes and
+native libraries for various operating system features not
+provided by standard JDK.</p>
+
+</subsection>
+<subsection name="(1) Scope of the Package">
+
+<p>Provide JNI abstraction layer of various operating system features
+in a portable way.</p>
+
+</subsection>
+<subsection name="(1.5) Interaction With Other Packages">
+
+<p><em>runtime</em> relies on standard JDK 1.6 (or later) APIs for
+production deployment. It utilizes the JUnit unit testing framework for
+developing and executing unit tests, but this is of interest only to
+developers of the component. </p>
+
+<p><em>runtime</em> relies on OpenSSL 0.9.8a (or later) APIs for
+SSL module support.</p>
+
+</subsection>
+<subsection name="(2) Initial Source of the Package">
+
+<p>Most of the code originates from Apache Tomcat Native Connector
+and Apache Portable Runtime projects.</p>
+
+<p>The proposed package name for the new component is
+<code>org.apache.commons.runtime</code>.</p>
+
+</subsection>
+<subsection name="(3) Required Apache Commons Resources">
+
+<ul>
+<li>SVN Repository - New directory <code>runtime</code> in the
+ <code>apache-commons</code> SVN repository.</li>
+<li>Mailing List - Discussions will take place on the general
+ <em>[email protected]</em> mailing list. To help
+ list subscribers identify messages of interest, it is suggested that
+ the message subject of messages about this component be prefixed with
+ [runtime].</li>
+<li>Bugzilla - New component "Runtime" under the "Commons" product
+ category, with appropriate version identifiers as needed.</li>
+</ul>
+
+
+</subsection>
+<subsection name="(4) Initial Committers">
+
+<p>The initial committers on the runtime component shall be as follows:
+<ul>
+<li>Mladen Turk (mturk)</li>
+</ul>
+</p>
+
+</subsection>
+</section>
+</body>
+</document>
Propchange: commons/sandbox/runtime/trunk/src/site/xdoc/proposal.xml
------------------------------------------------------------------------------
svn:eol-style = native