<!-- | |
! 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. | |
!--> | |
<html> | |
<title>Apache River Release Getting Started & More</title> | |
<body text="#000000" bgcolor="#ffffff" link="#9b37cc" | |
vlink="#cc1877" alink="#ffffff"> | |
<center><h1>Apache River Release v3.0.0<BR>Getting Started</h1></center> | |
<UL> | |
<LI><a href="#examine">Examining the distribution</a> | |
<LI><a href="#install">Installing the <code>jsk-policy.jar</code> file</a> | |
<LI><a href="#example">Example program documentation</a> | |
<LI><a href="#build">Building from the source code</a> | |
<LI><a href="#background">Background Material</a> | |
<LI><a href="#help">Getting Help</a> | |
<LI><a href="#license">Apache River Release License</a> | |
<HR> | |
<p> | |
<LI><a name="examine"><B>Examining the Distribution</B></a> | |
<p> | |
Once you have unarchived this release, your installation folder | |
should contain most if not all of the following items. | |
</p> | |
<blockquote> | |
<dl> | |
<dt><b>DISCLAIMER</b><dd> | |
The disclaimer regarding the fact that this project is currently under incubation at The Apache Software Foundation. | |
<dt><b>LICENSE</b><dd> | |
The Apache License. | |
<dt><b>NOTICE</b><dd> | |
The file containing contributor acknowledgments. | |
<dt><b>configentry</b><dd> | |
The directory that contains configuration entry description files | |
for all of the River services and utilities | |
<dt><b>doc</b><dd> | |
The directory that contains specifications, API documentation, | |
manual pages, release notes, license information, and other documentation | |
<dt><b>lib</b><dd> | |
The directory where the non-download JAR files are located | |
<dt><b>lib-dl</b><dd> | |
The directory where the download JAR files for the services are located | |
<dt><b>lib-ext</b><dd> | |
The directory where the dynamic security policy provider is located | |
<dt><b>src</b><dd> | |
The directory where source code may be located if installed via the separate source release, which is only available as a separate download. | |
<dt><b>examples/hello</b><dd> | |
The directory where the Hello example is located | |
</dl> | |
</blockquote> | |
<!----------------------------------> | |
<LI><a name="install"><B>Installing the <code>jsk-policy.jar</code> file</B></a> | |
<p> | |
This release includes a security policy provider which supports dynamic | |
granting of permissions at run-time. Although use of this policy provider | |
is not required, its use is highly recommended when deploying secure | |
applications and services. To permit effective use of this policy provider, | |
it must first be installed as an extension in the Java 2 SDK (or JRE) | |
that you will be using. Note that installing this provider does not | |
automatically cause it to be used, and its installation should not alter | |
the operation of existing applications. | |
<p> To install this policy provider, providing you didn't do so during your initial installation, | |
you must copy the <code>jsk-policy.jar</code> file from the <code>lib-ext</code> | |
subdirectory of your Apache River release installation to | |
the extensions directory of your Java(TM) 2 SDK (or JRE) installation. | |
<p> An alternative to copying <code>jsk-policy.jar</code> to the extension directory is | |
to use the system property <code>java.ext.dirs</code>. This property specifies one or | |
more directories to search for extensions, each separated by <code>File.pathSeparatorChar</code>. | |
To use <code>jsk-policy.jar</code> in this manner, the system property | |
must be set to include both the path to the Java 2 JRE extension directory | |
(or directories) and the path to the <code>lib-ext</code> subdirectory of | |
your Apache River release installation. | |
Note that in Java(TM) 2 Standard Edition (J2SE(TM)) 1.4, only the original extension directory | |
is granted permissions via the system policy file, so you will have to explicitly grant | |
permissions to <code>jsk-policy.jar</code> in your own policy files. In J2SE 5.0, all the | |
directories specified in <code>java.ext.dirs</code> are granted permissions so the explicit | |
permission grant is not needed. | |
<!----------------------------------> | |
<p> | |
<LI><a name="example"><B>Example program documentation</B></a> | |
<p> | |
<ul> | |
<li>The hello example is included in both the source and binary releases. | |
Once the release is downloaded and unarchived, | |
the example documentation will be located: | |
<p> | |
<a href="build.html"><install_dir>/examples/hello/index.html</a> | |
</ul> | |
<p> | |
<LI><a name="build"><B>Building from the source code</B></a> | |
<p> | |
<UL> | |
<LI>The binaries can be build from the source code, which is available as a | |
separate download. If you wish to build the source code, you will need to | |
download the source release, unarchive it, and refer to the build instructions, | |
located: | |
<p> | |
<a href="build.html"><install_dir>/doc/build.html</a> | |
</UL> | |
<p> | |
<LI><a name="background"><B>Background Material</B></a> | |
<p> | |
<UL> | |
<LI><a href="release-notes/activation.html">Notes on Java(TM) RMI Activation and | |
How it is Used in the Apache River release</a> | |
<LI><a href="release-notes/execpolicy.html">Security Requirements on Activation | |
Group Descriptors used with <code>phoenix</code> or <code>rmid</code></a> | |
<LI><a href="release-notes/evseqnums.html">Note on JavaSpaces Technology, | |
Persistent Outrigger Services, and Event Sequence Numbers</a> | |
<LI><a href= "specs/html/devicearch-spec.html">Device Architecture</a> | |
</UL> | |
<p> | |
<LI><a name="help"><B>Getting Help</B></a> | |
<p> | |
<UL> | |
<LI>The best place to discuss things about the Apache River project right | |
now is on the developer mail list (river-dev). You can subscribe or view the | |
archives from the project <a href="http://incubator.apache.org/river/mailing.html"></a> | |
mailing lists page. In addition, the river-user mailing | |
list is a resource to find out more about general use of River technology and | |
JavaSpaces technology. <a href="http://incubator.apache.org/river/RIVER/mailing-lists.html">Search | |
or Join</a> those lists to get involved.</LI> | |
<LI><a href="https://issues.apache.org/jira/secure/CreateIssue!default.jspa?pid=12310600">Submit a bug or RFE</a> | |
</UL> | |
<p> | |
<p> | |
<LI><a name="license"><B>Apache River Release License</B></a> | |
<p> | |
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 | |
<ul> | |
<LI><a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a> | |
</ul> | |
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. | |
</UL> | |
<p> | |
<p> | |
</body> | |
</html> | |