Skip to content

Commit

Permalink
Subdivide monolithic spec into manageable chapters
Browse files Browse the repository at this point in the history
Signed-off-by: Kevin Sutter <kwsutter@gmail.com>
  • Loading branch information
kwsutter committed Feb 26, 2020
1 parent 026b6ee commit 55f26e3
Show file tree
Hide file tree
Showing 27 changed files with 5,041 additions and 4 deletions.
1,013 changes: 1,013 additions & 0 deletions enterprise-ws-spec/src/main/asciidoc/ClientProgrammingModel.adoc

Large diffs are not rendered by default.

410 changes: 410 additions & 0 deletions enterprise-ws-spec/src/main/asciidoc/Deployment.adoc

Large diffs are not rendered by default.

821 changes: 821 additions & 0 deletions enterprise-ws-spec/src/main/asciidoc/DeploymentDescriptors.adoc

Large diffs are not rendered by default.

25 changes: 25 additions & 0 deletions enterprise-ws-spec/src/main/asciidoc/EnterpriseWebServices.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
include::Introduction.adoc[]

include::Objectives.adoc[]

include::Overview.adoc[]

include::ClientProgrammingModel.adoc[]

include::ServerProgrammingModel.adoc[]

include::Handlers.adoc[]

include::DeploymentDescriptors.adoc[]

include::Deployment.adoc[]

include::Security.adoc[]

include::RelationshipToOtherJavaStandards.adoc[]

include::OptionalSupportForJ2EE1.3Platforms.adoc[]

include::References.adoc[]

include::RevisionHistory.adoc[]
578 changes: 578 additions & 0 deletions enterprise-ws-spec/src/main/asciidoc/Handlers.adoc

Large diffs are not rendered by default.

89 changes: 89 additions & 0 deletions enterprise-ws-spec/src/main/asciidoc/Introduction.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
== Introduction

This specification defines the Web Services for Java EE (WSEE)
architecture. This is a service architecture that leverages the Java EE
component architecture to provide a client and server programming model
which is portable and interoperable across application servers, provides
a scalable secure environment, and yet is familiar to Java EE
developers.

=== Target Audience

This specification is intended to be used by:

* Java EE Vendors implementing support for Web services compliant with
this specification
* Developers of Web service implementations to be deployed into Java EE
application servers
* Developers of Web service clients to be deployed into Java EE
application servers
* Developers of Web service clients that access Web service
implementations deployed into Java EE application servers

This specification assumes that the reader is familiar with the Java EE
platform and specifications. It also assumes that the reader is familiar
with Web services, specifically the JAX-RPC and JAX-WS Specification and
WSDL documents.

=== Acknowledgments

This specification’s origins are based on the vision of Donald F.
Ferguson, IBM Fellow. It has been refined by an industry wide expert
group. The expert group included active representation from the
following companies: IBM, Sun, Oracle, BEA, Sonic Software, SAP, HP,
Silverstream, IONA. We would like to thank those companies along with
other members of the JSR 109 expert group: EDS, Macromedia, Interwoven,
Rational Software, Developmentor, interKeel, Borland, Cisco Systems,
ATG, WebGain, Sybase, Motorola, and WebMethods. We particularly
appreciate the amount of input and support provided by Mark Hapner
(Sun).

The JSR 109 expert group had to coordinate with other JSR expert groups
in order to define a consistent programming model for Web Service for
J2EE. We would like to especially thank Rahul Sharma and the JSR 101
(JAX-RPC) expert group, Farukh Najmi and the JSR 093 (JAX-R) expert
group, and Linda G. DeMichiel and the JSR 153 (EJB 2.1) expert group.

We would also like to acknowledge Roberto Chinnici (JSR-224
Specification Lead), Bill Shannon (JSR-244 Java EE Specification Lead),
Rajiv Mordani (JSR-250 Specification Lead), Jitendra Kotamraju, Doug
Kohlert, Vivek Pandey, Jerome Dochez, Vijay Ramachandran, Mahesh Kannan
and Kenneth Saks (all from Sun Microsystems) for providing invaluable
technical input for the maintenance release (version 1.2) of JSR-109
specification.

We would like to thank Roberto Chinnici (Java EE 6 Specification Lead),
Bill Shannon (Java EE 6 Specification Lead), Kenneth Saks (EJB 3.1
Specification Lead), Bhakti Mehta and Rama Pulavarthi (all from Sun
Microsystems) for providing invaluable input for the 1.3 maintenance
release.

=== Specification Organization

The next two chapters of this specification outline the requirements and
conceptual architecture for Web services support in Java EE
environments. Each of the major integration points for Web services in
Java EE, the client model, the server model, the deployment model, WSDL
bindings, and security have their own chapter. Each of these chapters
consists of two topics: Concepts and Specification. The concepts section
discusses how Web services are used, issues, considerations, and the
scenarios that are supported. The specification section is normative and
defines what implementers of this specification must support.

=== Document conventions.

In the interest of consistency, this specification follows the document
conventions used by the Enterprise JavaBeans specification.

The regular Times font is used for information that is prescriptive by
this specification.

The italic Times font is used for paragraphs that contain descriptive
information, such as notes describing typical use, or notes clarifying
the text with prescriptive specification.

The Courier font is used for code examples.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119.
118 changes: 118 additions & 0 deletions enterprise-ws-spec/src/main/asciidoc/Objectives.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
== Objectives

This section lists the high level objectives of this specification.

* Build on the evolving industry standards for Web services,
specifically WSDL 1.1, SOAP 1.1 and SOAP 1.2.
* Leverage existing Java EE technology.
* Ensure that programmers may implement and package Web services that
properly deploy onto application servers that comply with Java EE and
this specification.
* Ensure that vendor implementations of this specification
inter-operate, i.e. a Web service client on one vendor’s implementation
must be able to interact with Web services executing on another vendors
implementation.
* Define the minimal set of new concepts, interfaces, file formats, etc.
necessary to support Web services within Java EE.
* Clearly and succinctly define functions that Java EE application
server vendors need to provide.
* Define the roles that this specification requires, the functions they
perform and their mapping to Java EE platform roles. Define the
functions that a Web Services for Java EE product provider must provide
to support these roles.
* Support a simple model for defining a new Web service and deploying
this into a Java EE application server.
=== Client Model Goals

The client programming model should be conformant and compatible with
the client programming model defined by JAX-RPC or JAX-WS.

Additional goals for the client programming model are to ensure that:

* Programmers can implement Web services client applications conforming
to this specification that may reside in a Java EE container (e.g. an
EJB that uses a Web service), or a Java EE Client Container can call a
Web service running in a Web Services for Java EE container.
* Client applications conforming to this specification can call any SOAP
1.1 or SOAP 1.2 based Web service through the HTTP 1.1 or HTTPS SOAP
Bindings.
* Programmers using other client environments such as Java 2 Standard
Edition environment can call a Web service running in a Web Services for
Java EE container. Programmers using languages other than Java must be
able to implement SOAP 1.1 or SOAP 1.2 compliant applications that can
use Web services conforming to this specification. Support the Client
Development Scenarios described in Chapter 4.
* Client developers must not have to be aware of how the service
implementation is realized.
* Java 2 Micro Edition clients, defined by JSR 172, should be able to
interoperate using the transport standards declared within WSDL and the
JAX-RPC or JAX-WS runtime with Web Services for Java EE applications.

=== Service Development Goals

The service development model defines how web service implementations
are to be developed and deployed into existing Java EE containers and
includes the following specific goals:

* How the Web service has been implemented should be transparent to the
Web service client. A client should not have to know if the Web service
has been deployed in a Java EE or non-Java EE environment.
* Because the Web service implementation must be deployed in a Java EE
container, the class implementing the service must conform to some
defined requirements to ensure that it does not compromise the integrity
of the application server.
* JAX-RPC defines three server side run time categories, J2SE based
JAX-RPC Runtime, Servlet Container Based JAX-RPC Runtime, and Java EE
Container Based JAX-RPC Runtime. This specification defines the Java EE
container based (Web and EJB) runtime such that it is consistent with
the Servlet Container based model defined by the JAX-RPC specification.
* This specification is amended to define the Java EE container based
(Web and EJB) runtime such that it is consistent with the programming
model defined by the JAX-WS specification.
* Support mapping and dispatching SOAP 1.1 or 1.2 requests to methods on
Java EE Stateless or Singleton(only JAX-WS) Session Beans.
* Support mapping and dispatching SOAP 1.1 or 1.2 requests to methods on
JAX-RPC or JAX-WS Service Endpoint classes in the Web Container.

=== Service Deployment Goals

* Web service deployment is declarative. We do this through extending
the Java EE model for deployment descriptors and EAR file format. These
changes are minimized, however.
* Web service deployment is supported on Java EE environments.
* Deployment requires that a service be representable by WSDL.
Deployment requires a WSDL file. The deployment of Web services must
support:

* those who wish to deploy a Web service as the focus of the deployment
* those who wish to expose existing, deployed Java EE components as a
Web service

=== Service Publication Goals

* Service deployment may publish the WSDL to the appropriate service
registry, repository (if required by the Web service), File, or URL.
* If a Web service needs to be published by the deployment tools, all of
the data required to perform the publication must be provided in the
deployment package or during the deployment process.
* If any publication to UDDI is performed, the WSDL must also be made
available at a URL.

=== Web Services Registry Goals

The Web services registry API and programming model is out of the scope
of this specification. The Web service implementation, Web service
client, or Web service deployment tool may use any registry API
including JAX-R. JAX-R does not support WSDL publication directly. It
does support interaction with UDDI directories. UDDI.org specifies how
to publish a WSDL described service to a UDDI directory.

This specification defines the service publication responsibilities of
the deployment tool.

Service definition discovery (finding the WSDL to be implemented) during
development or deployment of a service implementation is not defined.

Service discovery during development, deployment, or runtime of service
clients is not defined.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[appendix]
== Optional support for J2EE 1.3 platforms

Web Services for J2EE Version 1.1 does not require support for
applications built according to the Web Services for J2EE Version 1.0
specification. A vendor may optionally support Web Services for J2EE 1.0
by implementing that version of the specification. See the Web Services
Version 1.0 Change Log for more details on the differences between the
two specifications.

0 comments on commit 55f26e3

Please sign in to comment.