commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From x..@apache.org
Subject commons-crypto git commit: CRYPTO-5: Create site for apache commons crypto
Date Mon, 25 Apr 2016 05:34:19 GMT
Repository: commons-crypto
Updated Branches:
  refs/heads/master 4920d2729 -> 8f888a572


CRYPTO-5: Create site for apache commons crypto

add src/site to master branch

add site

fix comment

delete the userguide.xml

fix comment

logo

fix comments

fix comment


Project: http://git-wip-us.apache.org/repos/asf/commons-crypto/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-crypto/commit/8f888a57
Tree: http://git-wip-us.apache.org/repos/asf/commons-crypto/tree/8f888a57
Diff: http://git-wip-us.apache.org/repos/asf/commons-crypto/diff/8f888a57

Branch: refs/heads/master
Commit: 8f888a572492e0e9bd6c48e3dec9e408d2c44d90
Parents: 4920d27
Author: JKSelf <ke.a.jia@intel.com>
Authored: Tue Apr 19 09:49:33 2016 +0800
Committer: Ferdinand Xu <cheng.a.xu@intel.com>
Committed: Mon Apr 25 06:11:56 2016 +0800

----------------------------------------------------------------------
 src/site/resources/download_crypto.cgi |   5 +
 src/site/resources/images/logo.png     | Bin 0 -> 10943 bytes
 src/site/resources/profile.jacoco      |  17 +++
 src/site/resources/profile.noanimal    |  19 +++
 src/site/site.xml                      |  40 ++++++
 src/site/xdoc/download_crypto.xml      | 138 +++++++++++++++++++
 src/site/xdoc/index.xml                | 111 +++++++++++++++
 src/site/xdoc/issue-tracking.xml       | 102 ++++++++++++++
 src/site/xdoc/mail-lists.xml           | 205 ++++++++++++++++++++++++++++
 src/site/xdoc/proposal.xml             | 119 ++++++++++++++++
 10 files changed, 756 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/resources/download_crypto.cgi
----------------------------------------------------------------------
diff --git a/src/site/resources/download_crypto.cgi b/src/site/resources/download_crypto.cgi
new file mode 100644
index 0000000..3d6f003
--- /dev/null
+++ b/src/site/resources/download_crypto.cgi
@@ -0,0 +1,5 @@
+#!/bin/sh
+# Just call the standard mirrors.cgi script. It will use download.html
+# as the input template.
+exec /www/www.apache.org/dyn/mirrors/mlirrors.cgi $*
+

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/resources/images/logo.png
----------------------------------------------------------------------
diff --git a/src/site/resources/images/logo.png b/src/site/resources/images/logo.png
new file mode 100644
index 0000000..fd27bf2
Binary files /dev/null and b/src/site/resources/images/logo.png differ

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/resources/profile.jacoco
----------------------------------------------------------------------
diff --git a/src/site/resources/profile.jacoco b/src/site/resources/profile.jacoco
new file mode 100644
index 0000000..a12755f
--- /dev/null
+++ b/src/site/resources/profile.jacoco
@@ -0,0 +1,17 @@
+# 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.
+# -----------------------------------------------------------------------------
+#
+# Empty file used to automatically trigger JaCoCo profile from commons parent pom

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/resources/profile.noanimal
----------------------------------------------------------------------
diff --git a/src/site/resources/profile.noanimal b/src/site/resources/profile.noanimal
new file mode 100644
index 0000000..a9143dc
--- /dev/null
+++ b/src/site/resources/profile.noanimal
@@ -0,0 +1,19 @@
+# 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.
+# -----------------------------------------------------------------------------
+# Empty file used to bypass the check of running the Animal Sniffer plugin.
+# Animal Sniffer plugin is checking generated code does not included references to 
+# methods/classes etc that are not present in the standard Java runtime for the defined target

+# version.

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/site.xml
----------------------------------------------------------------------
diff --git a/src/site/site.xml b/src/site/site.xml
new file mode 100644
index 0000000..f1361ee
--- /dev/null
+++ b/src/site/site.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ 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.
+-->
+<project name="Apache Commons Crypto">
+    <bannerRight>
+        <name>Apache Commons Crypto</name>
+        <src>/images/logo.png</src>
+        <href>/index.html</href>
+        <alt>Commons Crypto&trade; logo</alt>
+    </bannerRight>
+    <body>
+        <menu name="Documentation">
+            <item name="Download"
+                   href="http://commons.apache.org/crypto/download_crypto.cgi"/>
+            <item name="Download" href="/download_crypto.html"/>
+            <item name="Users guide"   href="/userguide.html"/>
+            <item name="Javadoc trunk" href="/apidocs/index.html"/>            
+        </menu>
+
+        <menu name="Development">
+            <item name="Mailing Lists"        href="/mail-lists.html"/>
+            <item name="Issue Tracking"       href="/issue-tracking.html"/>
+            <item name="Source Repository"    href="/source-repository.html"/>
+        </menu>
+    </body>
+</project>

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/xdoc/download_crypto.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/download_crypto.xml b/src/site/xdoc/download_crypto.xml
new file mode 100644
index 0000000..ac12ce0
--- /dev/null
+++ b/src/site/xdoc/download_crypto.xml
@@ -0,0 +1,138 @@
+<?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: download-page-template.xml                            |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ |                                                                      |
+ | 1) Re-generate using: mvn commons:download-page                      |
+ |                                                                      |
+ | 2) Set the following properties in the component's pom:              |
+ |    - commons.componentid (required, alphabetic, lower case)          |
+ |    - commons.release.version (required)                              |
+ |    - commons.binary.suffix (optional)                                |
+ |      (defaults to "-bin", set to "" for pre-maven2 releases)         |
+ |                                                                      |
+ | 3) Example Properties                                                |
+ |                                                                      |
+ |  <properties>                                                        |
+ |    <commons.componentid>math</commons.componentid>                   |
+ |    <commons.release.version>1.2</commons.release.version>            |
+ |  </properties>                                                       |
+ |                                                                      |
+ +======================================================================+
+-->
+<document>
+  <properties>
+    <title>Download Apache Commons Crypto</title>
+    <author email="dev@commons.apache.org">Commons Documentation Team</author>
+  </properties>
+  <body>
+    <section name="Download Apache Commons Crypto">
+    <subsection name="Using a Mirror">
+      <p>
+        We recommend you use a mirror to download our release
+        builds, but you <strong>must</strong> verify the integrity of
+        the downloaded files using signatures downloaded from our main
+        distribution directories. Recent releases (48 hours) may not yet
+        be available from the mirrors.
+      </p>
+
+      <p>
+        You are currently using <b>[preferred]</b>.  If you
+        encounter a problem with this mirror, please select another
+        mirror.  If all mirrors are failing, there are <i>backup</i>
+        mirrors (at the end of the mirrors list) that should be
+        available.
+        <br></br>
+        [if-any logo]<a href="[link]"><img align="right" src="[logo]" border="0"></img></a>[end]
+      </p>
+
+      <form action="[location]" method="get" id="SelectMirror">
+        <p>
+          Other mirrors:
+          <select name="Preferred">
+          [if-any http]
+            [for http]<option value="[http]">[http]</option>[end]
+          [end]
+          [if-any ftp]
+            [for ftp]<option value="[ftp]">[ftp]</option>[end]
+          [end]
+          [if-any backup]
+            [for backup]<option value="[backup]">[backup] (backup)</option>[end]
+          [end]
+          </select>
+          <input type="submit" value="Change"></input>
+        </p>
+      </form>
+
+      <p>
+        The <a href="http://www.apache.org/dist/commons/KEYS">KEYS</a>
+        link links to the code signing keys used to sign the product.
+        The <code>PGP</code> link downloads the OpenPGP compatible signature
from our main site.
+        The <code>MD5</code> link downloads the checksum from the main site.
+      </p>
+    </subsection>
+    </section>
+    <section name="Apache Commons Crypto 1.0.0 (Requires Java 1.6 or later)">
+      <subsection name="Binaries">
+        <table>
+          <tr>
+              <td><a href="[preferred]/commons/crypto/binaries/commons-crypto-1.0.0-bin.tar.gz">commons-crypto-1.0.0-bin.tar.gz</a></td>
+              <td><a href="http://www.apache.org/dist/commons/crypto/binaries/commons-crypto-1.0.0-bin.tar.gz.md5">md5</a></td>
+              <td><a href="http://www.apache.org/dist/commons/crypto/binaries/commons-crypto-1.0.0-bin.tar.gz.asc">pgp</a></td>
+          </tr>
+          <tr>
+              <td><a href="[preferred]/commons/crypto/binaries/commons-crypto-1.0.0-bin.zip">commons-crypto-1.0.0-bin.zip</a></td>
+              <td><a href="http://www.apache.org/dist/commons/crypto/binaries/commons-crypto-1.0.0-bin.zip.md5">md5</a></td>
+              <td><a href="http://www.apache.org/dist/commons/crypto/binaries/commons-crypto-1.0.0-bin.zip.asc">pgp</a></td>
+          </tr>
+        </table>
+      </subsection>
+      <subsection name="Source">
+        <table>
+          <tr>
+              <td><a href="[preferred]/commons/crypto/source/commons-crypto-1.0.0-src.tar.gz">commons-crypto-1.0.0-src.tar.gz</a></td>
+              <td><a href="http://www.apache.org/dist/commons/crypto/source/commons-crypto-1.0.0-src.tar.gz.md5">md5</a></td>
+              <td><a href="http://www.apache.org/dist/commons/crypto/source/commons-crypto-1.0.0-src.tar.gz.asc">pgp</a></td>
+          </tr>
+          <tr>
+              <td><a href="[preferred]/commons/crypto/source/commons-crypto-1.0.0-src.zip">commons-crypto-1.0.0-src.zip</a></td>
+              <td><a href="http://www.apache.org/dist/commons/crypto/source/commons-crypto-1.0.0-src.zip.md5">md5</a></td>
+              <td><a href="http://www.apache.org/dist/commons/crypto/source/commons-crypto-1.0.0-src.zip.asc">pgp</a></td>
+          </tr>
+        </table>
+      </subsection>
+    </section>
+    <section name="Archives">
+        <p>
+          Older releases can be obtained from the archives.
+        </p>
+        <ul>
+          <li class="download"><a href="[preferred]/commons/crypto/">browse download
area</a></li>
+          <li><a href="http://archive.apache.org/dist/commons/crypto/">archives...</a></li>
+        </ul>
+    </section>
+  </body>
+</document>

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
new file mode 100644
index 0000000..5984788
--- /dev/null
+++ b/src/site/xdoc/index.xml
@@ -0,0 +1,111 @@
+<?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>Overview</title>
+  <author email="dev@commons.apache.org">Commons Documentation Team</author>
+ </properties>
+<body>
+<!-- ================================================== -->
+<section name="Apache Commons Crypto">
+    <p>Apache Commons Crypto is a cryptographic library optimized with AES-NI (Advanced
Encryption
+        Standard New Instructions). It provides Java API for both cipher level and Java stream
+        level. Developers can use it to implement high performance AES encryption/decryption
with
+        the minimum code and effort. Please note that Apache Commons Crypto doesn't implement
the
+        cryptographic algorithm such as AES directly. It wraps to Openssl or JCE which implement
the
+        algorithms.
+    </p>
+</section>
+<!-- ================================================== -->
+<section name="Features">
+  <p>
+    <ul>
+      <li>Cipher API for low level cryptographic operations.</li>
+      <li>Secure true random number generator.</li>
+      <li>Java stream API for high level stream
+        encyrption/decryption.
+      </li>
+      <li>High performance AES encryption/decryption optimized with Intel AES-NI.
+      </li>
+      <li>Portable across various operating systems (currently only Linux); Apache
Commons Crypto loads the
+          library according to your machine environment (It looks system properties, os.name
and
+          os.arch).
+      </li>
+      <li>Simple usage. Add the commons-crypto-(version).jar file to your classpath.</li>
+    </ul>
+  </p>
+</section>
+<!-- ================================================== -->
+<section name="Documentation">
+    <p>
+        An overview of the functionality is provided in the
+        <a href="userguide.html">user guide</a>.
+        Various
+        <a href="project-reports.html">project reports</a>
+        are also available.
+    </p>
+    <p>
+        The Javadoc API documents are available online:
+    </p>
+    <ul>
+        <li>
+            <a href="apidocs/index.html">Javadoc trunk</a>
+        </li>
+    </ul>
+    <p>
+        The <a href="source-repository.html">subversion repository</a> can be
+        <a href="http://svn.apache.org/viewvc/commons/proper/crypto/trunk/">browsed</a>.
+    </p>
+</section>
+<!-- ================================================== -->
+<section name="Releases">
+<ul>
+    <li>
+        <a href="http://commons.apache.org/crypto/download_crypto.cgi">Crypto 1.0.0
(mirrors)</a>
+        requires Java 1.7
+    </li>
+</ul>
+<p>
+See the
+<a href="http://commons.apache.org/crypto/download_crypto.cgi">Download Page</a>
+for the latest releases.<br />
+</p>
+<p>
+<a href="changes-report.html">Change reports</a> are also available.
+</p>
+<p>
+For previous releases, see the <a href="http://archive.apache.org/dist/commons/crypto/">Apache
+    Archive</a>
+</p>
+</section>
+<!-- ================================================== -->
+<section name="Support">
+<p>
+The <a href="mail-lists.html">commons mailing lists</a> act as the main support
forum.
+The user list is suitable for most library usage queries.
+The dev list is intended for the development discussion.
+Please remember that the lists are shared between all commons components,
+so prefix your email by [crypto].
+</p>
+<p>
+Issues may be reported via <a href="issue-tracking.html">ASF JIRA</a>.
+</p>
+</section>
+<!-- ================================================== -->
+ </body>
+</document>

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/xdoc/issue-tracking.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/issue-tracking.xml b/src/site/xdoc/issue-tracking.xml
new file mode 100644
index 0000000..ce9f4b7
--- /dev/null
+++ b/src/site/xdoc/issue-tracking.xml
@@ -0,0 +1,102 @@
+<?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: issue-tracking-template.xml                           |
+ | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates |
+ +======================================================================+
+ |                                                                      |
+ | 1) Re-generate using: mvn commons:jira-page                          |
+ |                                                                      |
+ | 2) Set the following properties in the component's pom:              |
+ |    - commons.jira.id  (required, alphabetic, upper case)             |
+ |    - commons.jira.pid (required, numeric)                            |
+ |                                                                      |
+ | 3) Example Properties                                                |
+ |                                                                      |
+ |  <properties>                                                        |
+ |    <commons.jira.id>MATH</commons.jira.id>                           |
+ |    <commons.jira.pid>12310485</commons.jira.pid>                     |
+ |  </properties>                                                       |
+ |                                                                      |
+ +======================================================================+
+-->
+<document>
+  <properties>
+    <title>Apache Commons Crypto Issue tracking</title>
+    <author email="dev@commons.apache.org">Commons Documentation Team</author>
+  </properties>
+  <body>
+
+    <section name="Apache Commons Crypto Issue tracking">
+      <p>
+      Apache Commons Crypto uses <a href="http://issues.apache.org/jira/">ASF JIRA</a>
for tracking issues.
+      See the <a href="http://issues.apache.org/jira/browse/CRYPTO">Apache Commons
Crypto 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
+      Apache Commons Crypto please do the following:
+      <ol>
+        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310487&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;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=12310487&amp;issuetype=1&amp;priority=4&amp;assignee=-1">bug
report</a>
+            or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310487&amp;issuetype=4&amp;priority=4&amp;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 Apache Commons Crypto 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&amp;pid=12310487&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=1&amp;status=3&amp;status=4">All
Open Apache Commons Crypto bugs</a></li>
+        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310487&amp;sorter/field=issuekey&amp;sorter/order=DESC&amp;status=5&amp;status=6">All
Resolved Apache Commons Crypto bugs</a></li>
+        <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&amp;pid=12310487&amp;sorter/field=issuekey&amp;sorter/order=DESC">All
Apache Commons Crypto bugs</a></li>
+      </ul>
+      </p>
+    </section>
+  </body>
+</document>

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/xdoc/mail-lists.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/mail-lists.xml b/src/site/xdoc/mail-lists.xml
new file mode 100644
index 0000000..d25b496
--- /dev/null
+++ b/src/site/xdoc/mail-lists.xml
@@ -0,0 +1,205 @@
+<?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>Apache Commons Crypto Mailing Lists</title>
+    <author email="dev@commons.apache.org">Commons Documentation Team</author>
+  </properties>
+  <body>
+
+    <section name="Overview">
+      <p>
+        <a href="index.html">Apache Commons Crypto</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>[crypto] Problem with the ...</li>
+        </ul>
+      </p>
+      <p>
+        Questions related to the usage of Apache Commons Crypto 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 Apache Commons Crypto.
+        <br />
+        Please do not cross-post; developers are also subscribed to the user list.
+        <br />
+        You must be subscribed to post to the mailing lists.  Follow the Subscribe links
below
+        to subscribe.
+      </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="Apache Commons Crypto Mailing Lists">
+      <p>
+        <strong>Please prefix the subject line of any messages for <a href="index.html">Apache
Commons Crypto</a>
+        with <i>[crypto]</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 Apache Commons Crypto.
+            <br /><br />
+          </td>
+          <td><a href="mailto:user-subscribe@commons.apache.org">Subscribe</a></td>
+          <td><a href="mailto:user-unsubscribe@commons.apache.org">Unsubscribe</a></td>
+          <td><a href="mailto:user@commons.apache.org?subject=[crypto]">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/user@commons.apache.org/">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 Apache Commons Crypto.
+            <br /><br />
+          </td>
+          <td><a href="mailto:dev-subscribe@commons.apache.org">Subscribe</a></td>
+          <td><a href="mailto:dev-unsubscribe@commons.apache.org">Unsubscribe</a></td>
+          <td><a href="mailto:dev@commons.apache.org?subject=[crypto]">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/dev@commons.apache.org/">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:issues-subscribe@commons.apache.org">Subscribe</a></td>
+          <td><a href="mailto:issues-unsubscribe@commons.apache.org">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/issues@commons.apache.org/">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:commits-subscribe@commons.apache.org">Subscribe</a></td>
+          <td><a href="mailto:commits-unsubscribe@commons.apache.org">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/commits@commons.apache.org/">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:announce-subscribe@apache.org">Subscribe</a></td>
+          <td><a class="externalLink" href="mailto:announce-unsubscribe@apache.org">Unsubscribe</a></td>
+          <td><i>read only</i></td>
+          <td><a class="externalLink" href="http://mail-archives.apache.org/mod_mbox/www-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/announce@apache.org/">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>

http://git-wip-us.apache.org/repos/asf/commons-crypto/blob/8f888a57/src/site/xdoc/proposal.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/proposal.xml b/src/site/xdoc/proposal.xml
new file mode 100644
index 0000000..2a8f69f
--- /dev/null
+++ b/src/site/xdoc/proposal.xml
@@ -0,0 +1,119 @@
+<?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>Apache Commons Crypto: Proposal</title>
+ </properties>
+
+ <body>
+  
+   <section name="Proposal for Apache Commons Crypto Package"><br/>
+   <h4>March 24, 2016</h4>
+  
+
+  
+<subsection name="(0) Rationale">
+  <p>
+   Providing Java based optimized and high performance cryptographic IO streams for
+   the applications who wants to implement the data encryption. It also provides cipher
+   level API to use. It does provide the openssl API integration and provide the fallback
+   mechanism to use JCE when openssl library unavailable.
+  </p>
+
+  </subsection>
+<subsection name="(1) Scope of the Package">
+  <p>
+      This proposal is to create a package of cryptographic IO classes with the integration
+      of Openssl library.
+      It focuses on AES-NI optimizations mainly and it can be extended to other algorithms
+      based on demand from the users later.
+  </p>
+
+  </subsection>
+<subsection name="(1.5) Interaction With Other Packages">
+
+  <p>
+   <em>IO</em> Commons Crypto relies on standard JDK 7 (or later) APIs for production
+   deployment and on OpenSSL 1.0.1c devl libraries. It utilizes the JUnit unit testing
+   framework, but this is of interest only to developers of the component.
+   The functionality provided by Commons Crypto is currently in use by Apache Hadoop
+   and Apache Spark, and both of those communities have expressed interest in changing
+   their dependency to be on the central Commons Crypto package once it exists.
+  </p>
+
+  <p>No external configuration files are utilized.</p>
+
+  </subsection>
+<subsection name="(2) Initial Source of the Package">
+
+  <p>
+   The initial classes came from the Apache Hadoop.
+  </p>
+
+  <p>
+   The proposed package name for the new component is <code>org.apache.commons.crypto</code>.
+  </p>
+
+  </subsection>
+<subsection name="(3)  Required Apache Commons Resources">
+
+  <ul>
+   <li>
+    Git Repository - New repository <code>commons-crypto</code>
+   </li>
+   <li>
+       Mailing List - Discussions will take place on the general<em>dev@commons.apache.org</em>
+       mailing list.
+       <br>To help list subscribers identify messages of interest, it is suggested
that the message
+           subject of messages about this component be prefixed with [Crypto].
+       </br>
+   </li>
+   <li>
+       JIRA - New component "Crypto" under the "Commons" project.
+   </li>
+   <li>
+       Confluence FAQ - New category ¡°commons-crypto" (when available).
+   </li>
+  </ul>
+
+  </subsection>
+<subsection name="(4) Initial Committers">
+
+  <p>
+   The initial committers on the Apache Commons Crypto component shall be as follows:
+   <ul>
+       <li>Aaron T Myers (atm@apache.org, Apache Hadoop PMC, one of the original Crypto
dev team in Apache Hadoop)</li>
+       <li>Andrew Wang (wang@apache.org, Apache Hadoop PMC, one of the original Crypto
dev team in Apache Hadoop)</li>
+       <li>Chris Nauroth (cnauroth@apache.org, Apache Hadoop PMC and active reviewer)</li>
+       <li>Colin P. McCabe (cmccabe@apache.org, Apache Hadoop PMC, one of the original
Crypto dev team in Apache Hadoop)</li>
+       <li>Dapeng Sun (sdp@apache.org, Apache Sentry Committer, Chimera contributor)</li>
+       <li>Dian Fu (dianfu@apache.org, Apache Sqoop Committer, Chimera contributor)</li>
+       <li>Dong Chen (dongc@apache.org, Apache Hive Committer,interested on Chimera)</li>
+       <li>Ferdinand Xu (xuf@apache.org, Apache Hive Committer, Chimera contributor)</li>
+       <li>Haifeng Chen (haifengchen@apache.org, Chimera lead and code contributor)</li>
+       <li>Marcelo Vanzin(Apache Spark Committer, Chimera contributor)</li>
+       <li>Uma Maheswara Rao G(umamahesh@apache.org, Apache Hadoop PMC, One of Crypto
dev/review in Apache Hadoop)</li>
+       <li>Yi Liu (yliu@apache.org, Apache Hadoop PMC,  One of Crypto dev/review in
Apache Hadoop)</li>
+   </ul>
+  </p>
+
+ </subsection>
+</section>
+</body>
+</document>


Mime
View raw message