Skip to content

Commit

Permalink
[xmlws40] update ug and install docs
Browse files Browse the repository at this point in the history
Signed-off-by: Lukas Jungmann <lukas.jungmann@oracle.com>
  • Loading branch information
lukasj committed Feb 21, 2022
1 parent 43d0128 commit 0c1dd66
Show file tree
Hide file tree
Showing 16 changed files with 5,645 additions and 69 deletions.
257 changes: 257 additions & 0 deletions install/jaxws/docs/XMLWS4.0-ReleaseNotes.html
@@ -0,0 +1,257 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--
Copyright (c) 2018, 2022 Oracle and/or its affiliates. All rights reserved.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License v. 2.0, which is available at
http://www.eclipse.org/legal/epl-2.0.
This Source Code may also be made available under the following Secondary
Licenses when the conditions for such availability set forth in the
Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
version 2 with the GNU Classpath Exception, which is available at
https://www.gnu.org/software/classpath/license.html.
SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
-->
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=windows-1252">
<title>Jakarta XML Web Services TCK Release Notes</title>
<style type="text/css">
<!--
body { background-color: #ffffdd; color: #000000}
pre { background-color: #eeeeee; color: #000099}
code { color: #000099}
h1 { color: #000099}
h2 { color: #000099}
h3 { color: #000099; text-decoration: underline}
h4 { font-style: italic; color: #000099}
.tabletitle { font-style: italic; color: #ffffcc; font-size: small; font-variant: small-caps}
.subtitle { font-style: italic; color: #ffffcc; font-variant: small-caps}
.emphasize { font-style: italic; color: #000099}
.step { font-weight: bold}
-->
</style>
</head>
<body>
<div align="Center">
<h1>Jakarta EE XML Web Services Technology Compatibility Kit, Version 4.0<br>
<em class="emphasize">Release Notes, March 2022</em></h1>
</div>
<hr>

<h2><a name="kit_contents">Kit Contents</a></h2>
<p>The Jakarta EE XML Web Services, Version 4.0 Technology Compatibility Kit
(TCK) includes the following items:</p>
<ul>
<li>
<p><strong>Jakarta EE XML Web Services TCK Signature</strong>,
<strong>API</strong>, <strong> End-to-end</strong>,
<strong>WS-I Conformance</strong>, <strong> Java-to-WSDL/WSDL-to-Java Mapping</strong>
and <strong>Web Services Addressing Conformance</strong> tests:</p>
<ul type="square">
<li><p>A <strong>Signature test</strong> that checks that all of the
public APIs are supported/defined as specified in the Jakarta EE XML
Web Services Version 4.0 implementation that is being tested.</p>
</li>
<li><p><strong>API tests</strong> to verify the functionality of all the
public APIs under <code>jakarta.xml.ws</code>, <code>jakarta.xml.ws.handler</code>,
<code>jakarta.xml.ws.handler.soap</code>, <code>jakarta.xml.ws.http</code>,
<code>jakarta.xml.ws.spi</code>, <code>jakarta.xml.ws.spi.http</code>,
<code>jakarta.xml.ws.soap</code>, <code>jakarta.xml.ws.wsaddressing</code>,
<code>jakarta.jws</code> and <code>jakarta.jws.soap</code>.</p>
</li>
<li><p><strong>End-to-end tests</strong> that demonstrate
marshalling/unmarshalling of all XML supported data types when going
from WSDL-to-Java and all Jakarta EE XML Web Services supported Java
data types when going from Java-to-WSDL as Jakarta EE XML Web Services
SOAP Messages both through synchronous (request/response) and
asynchronous (request/response) and (one-way) RPC invocations. All
client programming model invocation methods (Stub-based, Dynamic
Proxy, and Dispatch interface) are tested.</p>
</li>
<li><p><strong>WS-I Conformance Tests</strong> that test and check for
conformance to the WS-I Basic Profile 1.1, Attachment Profile 1.0, and
Simple Soap Binding Profile 1.0 conformance specifications.</p>
</li>
<li><p><strong>Java-to-WSDL/WSDL-to-Java Mapping Tests</strong> that test
and check for conformance to the Java-to-WSDL and WSDL-to-Java
mappings.</p>
</li>
<li><p><strong>Web Services Addressing Conformance Tests</strong> that test
and check for conformance to the Web Services Addressing 1.0 - Core,
Web Services Addressing 1.0 - Metadata, and Web Services Addressing
1.0 - SOAP Binding conformance specifications.</p>
</li>
</ul>
</ul>
<hr>

<h2><a name="platform">Platform Notes</a></h2>
<p>The Jakarta EE XML Web Services TCK tests have been built with Java SE 11
and tested with the the Compatible Implementation (CI)
Eclipse GlassFish Server 7.0 running on the Java™ Standard
Edition 11 (Java SE 11) or Java SE 17 platforms. If you are using a
different Web server, you will need to make adjustments to the
procedures outlined in this document.</p>
<p>The Jakarta EE XML Web Services TCK tests run on the following
platforms:</p>
<ul>
<li>CentOS Linux 7</li>
<li>Alpine Linux v3.12</li>
</ul>
<p>In the instructions in this document, variables in angle brackets
need to be expanded for each platform. For example, <code>&lt;TS_HOME&gt;</code>
becomes <code>$TS_HOME</code> on Solaris/Linux and <code>%TS_HOME%</code>
on Windows 10. In addition, the forward slashes (<code>/</code>)
used in all of the examples need to be replaced with backslashes (<code>\</code>)
for Windows XP.</p>
<hr>

<h2><a name="updates">Updates for the Jakarta EE XML Web Services TCK
4.0 Release</a></h2>
<p> Added support for Java SE 11 and Java SE 17 based signatures.<br>
Added tests for @Repeatable(value=WebServiceRefs.class)
@WebServiceRef. </p>
<hr>

<h2><a name="Notes">Notes for Jakarta EE XML Web Services TCK 4.0 Release</a></h2>
<p> There are a few Jakarta EE XML Web Services tests that reference
schemas over the internet and this caused build issues when
attempting the rebuildable portion of Jakarta EE XML Web Services
when test machines had no access to the internet. </p>
<p> The following test references schema [ <code>http://www.w3.org/2006/03/addressing/ws-addr.xsd</code> ] </p>
<ul>
<li><code>src/com/sun/ts/tests/jaxws/wsa/j2w/document/literal/epr</code></li>
</ul>
<p> The following test references schema [ <code>http://ws-i.org/profiles/basic/1.1/swaref.xsd</code> ] </p>
<ul>
<li><code>src/com/sun/ts/tests/jaxws/wsi/w2j/document/literal/swareftest</code></li>
</ul>
<p> If you attempt to build the jaxws tree for the VI as part of the
rebuildable technology rules and you do not have access to the
internet than the build will fail for these test cases. You need to
use a Jakarta EE XML Web Services catalog to resolve the URI's
locally. A Jakarta EE XML Web Services catalog file exists under the
following directory: </p>
<ul>
<li><code>&lt;TS_HOME&gt;/src/com/sun/ts/tests/jaxws/common/xml/catalog/META-INF/jax-ws-catalog.xml</code></li>
</ul>
<p> The wsimport ant task within <code>&lt;TS_HOME&gt;/src/com/sun/ts/tests/jaxws/common/xml/common.xml</code>
refers to this catalog file appropriately for both the CI and VI
wsimport ant task tool wrappers. </p>
<p> We do not distribute these standards defined schema files as part
of our test suite. So the licensee will have to ensure to download
and get a copy of the above schemas however they decide to and place
them in the <code>&lt;TS_HOME&gt;/lib/schemas</code> directory of the test suite in order
to build these tests with no internet access. The catalog file
mentioned above will resolve these URI's locally to these schema
files under the <code>&lt;TS_HOME&gt;/lib/schemas</code>. </p>
<hr>

<h2><a name="props"><code>jakarta.xml.ws.Endpoint</code> publishing
API's</a></h2>
<p> The following properties, which are used by the Endpoint API tests
in the <code>jaxws/api/jakarta_xml_ws/Endpoint</code> directory,
must be set in the ts.jte file: </p>
<ul>
<li>The <code>http.server.supports.endpoint.publish</code> property
indicates whether or not your HTTP server supports endpoint
publishing.
</li>
<li>The <code>http.server.supports.endpoint.publish.2</code>
property indicates whether or not the Jakarta EE 10 CI server
supports endpoint publishing.
</li>
</ul>
<p> If your server supports endpoint publishing (supports the use of <code>jakarta.xml.ws.Endpoint.publish()</code>
methods), set the property value to <code>"true"</code>. In an unmanaged
environment, such as that in standalone mode, this call is usually
allowed. When the property is set to <code>"true"</code>, the test will check
that the endpoint publish methods publish the endpoints without
throwing an exception. When this result occurs with this scenario,
the result is considered a PASS. </p>
<p> If your server does not support endpoint publishing (does not
support the use of <code>jakarta.xml.ws.Endpoint.publish()</code>
methods), set the property value to <code>"false"</code>. In a managed
environment, such as the Jakarta EE 10 Compatible Implementation,
this is usually the case and this call would not be allowed. When
the property is set to <code>"false"</code>, the tests will check that these
endpoint publish methods do not publish the endpoints and an
exception will be thrown. When this result occurs with this
scenario, the result is considered a PASS. </p>
<p> The <code>http.server.supports.endpoint.publish.2</code> property
settings are used to specify whether or not endpoint publishing is
supported by the Jakarta EE 10 CI HTTP server. The same settings and
caveats as the <code>http.server.supports.endpoint.publish </code>
property apply to this property, based on whether or not the Jakarta
EE 10 CI supports endpoint publishing. </p>
<hr>

<h2><a name="install_setup_run">Installing, Setting Up, and Running
the Jakarta EE XML Web Services TCK</a></h2>
<p>Refer to the <a href="html-usersguide/title.html">Jakarta EE XML
Web Services TCK 4.0 User's Guide</a>, (or in <a href="./pdf-usersguide/XML-WS-TCK-Users-Guide.pdf"

title="Jakarta EE XML Web Services 4.0 TCK User's Guide (PDF)">PDF</a>)
available in the Jakarta EE XML Web Services TCK 4.0 documentation
bundle, for complete instructions on installing, setting up, and
running the Jakarta EE XML Web Services TCK. </p>
<p>The online version of the JT Harness version 5.0 documentation is
available <a href="https://wiki.openjdk.java.net/display/CodeTools/Documentation">here</a>.</p>
<hr>

<h2><a name="install_config_tomcat10">Quick Steps to Configure Apache
Tomcat 10 for Jakarta EE XML Web Services TCK</a></h2>
<p>Follow the steps below to configure Apache Tomcat 10 for Jakarta EE
XML Web Services TCK 4.0</p>
<ul>
<li>Install Apache Tomcat 10.1.x to <code>/apache-tomcat-10.1.x</code></li>
<li>Install Jakarta EE XML Web Services RI 4.0.0 to <code>/jaxws-ri</code></li>
<li>Install Jakarta EE XML Web Services TCK 4.0 to <code>/jaxwstck</code></li>
<li>Copy Jakarta EE XML Web Services RI 4.0.0 and Jakarta EE XML Web
Services TCK 4.0 jars to appropriate Apache Tomcat 10.1.x
directories
<ul>
<li><code>mkdir -p /apache-tomcat-10.1.x/shared/lib</code></li>
</ul>
</li>
<li>Configure the rest of ts.jte as per Jakarta EE XML Web Services
TCK 4.0 User's Guide (Example: <code>jaxws.classes</code>,
<code>webcontainer.home</code>, etc)
</li>
<li>Edit <code>/apache-tomcat-10.1.x/conf/catalina.properties</code> and set
<code>shared.loader</code> property to:
<ul>
<li><code>shared.loader=${catalina.home}/shared/lib/*.jar</code></li>
</ul>
</li>
<li>Configure the tomcat users in the
<code>/apache-tomcat-10.1.x/conf/tomcat-users.xml</code> file as follows:
</li>
<pre>&lt;tomcat-users&gt;
&lt;role rolename="tomcat"/&gt;
&lt;role rolename="role1"/&gt;
&lt;role rolename="Administrator"/&gt;
&lt;role rolename="Manager"/&gt;
&lt;role rolename="Employee"/&gt;
&lt;user username="both" password="tomcat" roles="tomcat,role1"/&gt;
&lt;user username="tomcat" password="tomcat" roles="tomcat"/&gt;
&lt;user username="j2ee" password="j2ee" roles="Administrator,Employee"/&gt;
&lt;user username="javajoe" password="javajoe" roles="Manager,Employee"/&gt;
&lt;user username="role1" password="tomcat" roles="role1"/&gt;
&lt;/tomcat-users&gt;
</pre>
<li>Restart Apache Tomcat 10.1.x which is now ready for Jakarta EE
XML Web Services TCK 4.0 testing
</li>
</ul>
<hr>

<p><cite><small>Copyright © 2011, 2022 Oracle and/or its affiliates.
All rights reserved.</small></cite></p>
</body>
</html>

0 comments on commit 0c1dd66

Please sign in to comment.