chap-jee-agents.xml revision 48ee224232724691bca4ccc07ee048434afc0f21
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CCPL HEADER START
!
! This work is licensed under the Creative Commons
! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
! To view a copy of this license, visit
! or send a letter to Creative Commons, 444 Castro Street,
! Suite 900, Mountain View, California, 94041, USA.
!
! You can also obtain a copy of the license at
! See the License for the specific language governing permissions
! and limitations under the License.
!
! If applicable, add the following below this CCPL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CCPL HEADER END
!
! Copyright 2012-2013 ForgeRock AS
!
-->
<chapter xml:id='chap-j2ee-agents'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Java EE Policy Agents <?eval ${agentsDocTargetVersion}?></title>
<para>This chapter concerns OpenAM Java EE policy agents. Java EE policy
agents run in web application containers and protect Java EE
applications.</para>
<section xml:id="what-new-javaee-agents">
<title>New in Java EE Policy Agents <?eval ${javaEEAgentsDocTargetVersion}?></title>
<itemizedlist>
<listitem>
<para>All of the web policy agents have been updated to include support for Internet
Protocol version 6 (IPv6) support, in addition to support for IPv4. <!--include in the notes when
AME-1134 is closed, which includes removing unused libraries.--></para>
<para>IPv6 replaces IPv4 to fix the problems of IPv4 address exhaustion. The new
protocol version increases the number of available internet addresses by using
128-bit addresses instead of the 32-bit addresses of IPv4.</para>
</listitem>
<listitem>
<para>The Java EE agent goto URL can now be modified (<link
xlink:show="new">OPENAM-1299</link>).</para>
</listitem>
<listitem>
<para>The Apache Tomcat policy agent now supports Tomcat 7 as well (<link
xlink:show="new">OPENAM-1273</link>).</para>
</listitem>
<listitem>
<para>Java EE policy agents can now conditionally redirect users based on
the incoming request URL (<link
xlink:show="new">OPENAM-1265</link>).</para>
</listitem>
<listitem>
now parses as valid XML (<link
xlink:href="https://bugster.forgerock.org/jira/browse/OPENAM-674"
xlink:show="new">OPENAM-674</link>).</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="before-you-start-javaee-agents">
<title>Before You Install OpenAM Java EE Policy Agents</title>
<para>This section covers software and hardware prerequisites for installing
and running OpenAM Java EE Policy Agents.</para>
<para>If you have a special request to support a combination not listed here,
contact ForgeRock at <link xlink:href="mailto:info@forgerock.com"
>info@forgerock.com</link>.</para>
<section xml:id="java-requirements-javaee-agents">
<title>Java EE Agents Java Requirements</title>
<para>Java EE policy agents run in a container using Java 6 or later.
ForgeRock recommends the most recent release of Java 6 or later to ensure
you have the latest security fixes.</para>
<para>ForgeRock has tested this release with Oracle Java SE JDK.</para>
</section>
<section xml:id="browser-requirements-javaee-agents">
<title>Java EE Agents Browsers Tested</title>
<itemizedlist>
<para>ForgeRock has tested this policy agent release with the following web
browsers.</para>
<listitem><para>Chrome release 16 and later</para></listitem>
<listitem><para>Firefox 3.6 and later</para></listitem>
<listitem><para>Internet Explorer 7 and later</para></listitem>
</itemizedlist>
</section>
<section xml:id="web-container-requirements-javaee-agents">
<title>Web Application Container Requirements</title>
<itemizedlist>
<para>Java EE policy agents support the following Java EE application
containers.</para>
<listitem>
<para>Apache Tomcat 6, 7</para>
</listitem>
<listitem>
<para>GlassFish v2, v3</para>
</listitem>
<listitem>
<para>IBM WebSphere Application Server <!-- 6.1, -->7, 8, 8.5</para>
</listitem>
<listitem>
<para>JBoss Enterprise Application Platform 5</para>
<!-- Pending OPENAM-1735: <para>JBoss Application Server 7.1</para>-->
</listitem>
<listitem>
<para>Jetty 7</para>
</listitem>
<listitem>
<para>Oracle WebLogic Server 10g or later</para>
</listitem>
</itemizedlist>
</section>
<section xml:id="platform-requirements-javaee-agents">
<title>Java EE Agents Platform Requirements</title>
<para>Apache Tomcat Java EE policy agents have been tested on Linux 2.6 or
later, and on Microsoft Windows Server 2008 R2.</para>
<para>GlassFish Java EE policy agents have been tested on Oracle Solaris 10
or later.</para>
<para>Other Java EE policy agents have been tested on Linux 2.6 or
later.</para>
<para>Testing has focused on 64-bit operating systems.</para>
</section>
<section xml:id="hardware-requirements-javaee-agents">
<title>Java EE Agents Hardware Requirements</title>
<para>You can deploy OpenAM Java EE policy agents on any hardware supported
for the combination of software required.</para>
<para>ForgeRock has tested this release on x86 and x64 based systems.</para>
</section>
</section>
<section xml:id="javaee-agent-compatibility">
<title>Java EE Policy Agent Compatibility</title>
<para>This section concerns OpenAM Java EE Policy Agents
<?eval ${javaEEAgentsDocTargetVersion}?>.</para>
<section xml:id="javaee-agent-major-changes">
<title>Major Changes to Java EE Policy Agent Functionality</title>
<para>No major changes affecting compatibility have been made to the OpenAM
Java EE Policy Agents in this release.</para>
</section>
<section xml:id="javaee-agent-deprecated">
<title>Deprecated Functionality</title>
<para>No functionality has been deprecated in this release.</para>
<!-- Keep the wording here for use in a future release:
<para>The following functionality is deprecated in OpenAM Java EE Policy
Agents <?eval ${javaEEAgentsDocTargetVersion}?>, and is likely to be removed
in a future release.</para>
<itemizedlist>
<listitem>
<para>Functionality, description...</para>
</listitem>
</itemizedlist>
-->
</section>
<section xml:id="javaee-agent-removed">
<title>Removed Functionality</title>
<para>No functionality has been removed in OpenAM Java EE Policy Agents
<?eval ${javaEEAgentsDocTargetVersion}?>.</para>
</section>
</section>
<section xml:id="javaee-agent-issues">
<title>Java EE Policy Agents Fixes, Limitations, & Known Issues</title>
<para>OpenAM Java EE policy agent issues are tracked at <link xlink:show="new"
xlink:href="https://bugster.forgerock.org/jira/browse/OPENAM"
<section xml:id="javaee-agent-fixes">
<title>Key Fixes</title>
<para>The following bugs were fixed in release
<?eval ${javaEEAgentsDocTargetVersion}?>. For details, see the <link
>OpenAM issue tracker</link>.</para>
<para>TODO</para>
</section>
<section xml:id="javaee-agent-limitations">
<title>Limitations</title>
<!-- For OPENAM-1991 TODO: Remove when this is fixed after 3.1.0-Xpress -->
<para>Apache Tomcat can fail to shut down properly when the Java EE policy
agent for Tomcat is deployed. To work around this limitation, add the
following to your Tomcat configuration in the <literal><Server port="8005"
shutdown="SHUTDOWN"></literal> section.</para>
<literallayout class="monospaced"
><Listener
className="org.forgerock.agents.tomcat.v6.TomcatLifeCycleListener" /></literallayout>
</section>
<section xml:id="javaee-agent-known-issues">
<title>Known Issues</title>
<para>The following important known issues remained open at the time
release <?eval ${javaEEAgentsDocTargetVersion}?> became available. For
details and information on other issues, see the <link xlink:show="new"
xlink:href="https://bugster.forgerock.org/jira/browse/OPENAM">OpenAM issue
tracker</link>.</para>
<para>TODO</para>
</section>
</section>
</chapter>