From 2c4d5ccbbc12a688afbc5ccc4728ec7781dc3b38 Mon Sep 17 00:00:00 2001 From: "Greg L. Turnquist" Date: Thu, 6 Aug 2020 16:17:59 -0500 Subject: [PATCH] Migrate to Asciidoctor. --- README.adoc | 54 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 52 ------------------------------------------ airline/README.adoc | 15 ++++++++++++ airline/README.md | 18 --------------- echo/README.adoc | 12 ++++++++++ echo/README.md | 15 ------------ mtom/README.adoc | 11 +++++++++ mtom/README.md | 14 ------------ tutorial/README.adoc | 16 +++++++++++++ tutorial/README.md | 20 ---------------- weather/README.adoc | 17 ++++++++++++++ weather/README.md | 19 ---------------- 12 files changed, 125 insertions(+), 138 deletions(-) create mode 100644 README.adoc delete mode 100644 README.md create mode 100644 airline/README.adoc delete mode 100644 airline/README.md create mode 100644 echo/README.adoc delete mode 100644 echo/README.md create mode 100644 mtom/README.adoc delete mode 100644 mtom/README.md create mode 100644 tutorial/README.adoc delete mode 100644 tutorial/README.md create mode 100644 weather/README.adoc delete mode 100644 weather/README.md diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..ccb675c --- /dev/null +++ b/README.adoc @@ -0,0 +1,54 @@ += Spring Web Services Samples + +https://spring.io/projects/spring-ws[Spring Web Services] is a product of the Spring community focused on creating +document-driven, contract-first Web services. This repository contains sample +projects illustrating usage of Spring Web Services. + +== Sample Applications + +The following sample applications demonstrate the capabilities of https://spring.io/projects/spring-ws[Spring Web +Services]. See the README within each sample project for more information and +additional instructions. + +* link:./airline[airline] - a complete airline sample that shows both Web Service and +O/X Mapping functionality in a complete application +* link:./echo[echo] - a simple sample that shows a bare-bones Echo service +* link:./mtom[mtom] - shows how to use MTOM and JAXB2 marshalling +* link:./stockquote[stockquote] - shows how to use WS-Addressing and the Java 6 HTTP Server +* link:./tutorial[tutorial] - contains the code from the Spring-WS tutorial +* link:./weather[weather] - shows how to connect to a public SOAP service + +== Running the Server + +Most of the sample apps can be built and run using the following commands from +within the `server` folder. + +---- +```sh +$ ./mvnw spring-boot:run +``` +---- + +Or alternatively, run the following to create runnable JAR file that will run anywhere there's a JDK: + +---- +```sh +$ ./mvnw package +``` +---- + +== Running the Client(s) + +Most of the sample apps have a separate `client` directory containing clients +that connect to the server. You can run these clients by using the following +command from within each of client subdirectories: + +---- +```sh +$ ./mvnw spring-boot:run +``` +---- + +== License + +https://projects.spring.io/spring-ws[Spring Web Services] is released under version 2.0 of the http://www.apache.org/licenses/LICENSE-2.0[Apache License]. \ No newline at end of file diff --git a/README.md b/README.md deleted file mode 100644 index 7939df5..0000000 --- a/README.md +++ /dev/null @@ -1,52 +0,0 @@ -# Spring Web Services Samples - -[Spring Web Services] is a product of the Spring community focused on creating -document-driven, contract-first Web services. This repository contains sample -projects illustrating usage of Spring Web Services. - -## Sample Applications - -The following sample applications demonstrate the capabilities of [Spring Web -Services]. See the README within each sample project for more information and -additional instructions. - -- [airline](./airline) - a complete airline sample that shows both Web Service and - O/X Mapping functionality in a complete application -- [echo](./echo) - a simple sample that shows a bare-bones Echo service -- [mtom](./mtom) - shows how to use MTOM and JAXB2 marshalling -- [stockquote](./stockquote) - shows how to use WS-Addressing and the Java 6 HTTP Server -- [tutorial](./tutorial) - contains the code from the Spring-WS tutorial -- [weather](./weather) - shows how to connect to a public SOAP service - -## Running the Server - -Most of the sample apps can be built and run using the following commands from -within the ``server`` folder. - - ```sh - $ ./gradlew tomcatRun - ``` - -Or alternatively, run the following to create war archive which can be deployed -in any Web Container. - - ```sh - $ ./gradlew war - ``` - -## Running the Client(s) - -Most of the sample apps have a separate ``client`` directory containing clients -that connect to the server. You can run these clients by using the following -command from within each of client subdirectories: - - ```sh - $ gradle runClient - ``` - -## License - -[Spring Web Services] is released under version 2.0 of the [Apache License]. - -[Spring Web Services]: https://projects.spring.io/spring-ws -[Apache License]: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/airline/README.adoc b/airline/README.adoc new file mode 100644 index 0000000..a94a5bd --- /dev/null +++ b/airline/README.adoc @@ -0,0 +1,15 @@ += Airline Sample + +Features a web service on top of an airline reservation system, backed by a +database. The web service works by using XML Marshalling techniques (JAXB2), +and XPath in combination with XPath queries to pull information from a message. +Additionally, the Airline service has JMS support. All messages follow the +messages.xsd schema. + +== Build and deploy + +See the main link:../README.adoc[README] for build instructions. + +== License + +https://projects.spring.io/spring-ws[Spring Web Services] is released under version 2.0 of the http://www.apache.org/licenses/LICENSE-2.0[Apache License]. \ No newline at end of file diff --git a/airline/README.md b/airline/README.md deleted file mode 100644 index 6b9fbd8..0000000 --- a/airline/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# Airline Sample - -Features a web service on top of an airline reservation system, backed by a -database. The web service works by using XML Marshalling techniques (JAXB2), -and XPath in combination with XPath queries to pull information from a message. -Additionally, the Airline service has JMS support. All messages follow the -messages.xsd schema in src/main/webapp. - -## Build and deploy - -See the main [README](../README.md) for build instructions. - -## License - -[Spring Web Services] is released under version 2.0 of the [Apache License]. - -[Spring Web Services]: https://projects.spring.io/spring-ws -[Apache License]: http://www.apache.org/licenses/LICENSE-2.0 \ No newline at end of file diff --git a/echo/README.adoc b/echo/README.adoc new file mode 100644 index 0000000..d245905 --- /dev/null +++ b/echo/README.adoc @@ -0,0 +1,12 @@ += Echo Sample + +This sample shows a bare-bones echoing service. Incoming messages are handled +via DOM, and a simple 'business logic' service is used to obtain the result. + +== Build and deploy + +See the main link:../README.adoc[README] for build instructions. + +== License + +https://projects.spring.io/spring-ws[Spring Web Services] is released under version 2.0 of the http://www.apache.org/licenses/LICENSE-2.0[Apache License]. \ No newline at end of file diff --git a/echo/README.md b/echo/README.md deleted file mode 100644 index 676e7fd..0000000 --- a/echo/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Echo Sample - -This sample shows a bare-bones echoing service. Incoming messages are handled -via DOM, and a simple 'business logic' service is used to obtain the result. - -## Build and deploy - -See the main [README](../README.md) for build instructions. - -## License - -[Spring Web Services] is released under version 2.0 of the [Apache License]. - -[Spring Web Services]: https://projects.spring.io/spring-ws -[Apache License]: http://www.apache.org/licenses/LICENSE-2.0 \ No newline at end of file diff --git a/mtom/README.adoc b/mtom/README.adoc new file mode 100644 index 0000000..f3b9690 --- /dev/null +++ b/mtom/README.adoc @@ -0,0 +1,11 @@ += MTOM Sample + +This sample shows how to use marshal and unmarshal MTOM attachments using JAXB2. + +== Build and deploy + +See the main link:../README.adoc[README] for build instructions. + +== License + +https://projects.spring.io/spring-ws[Spring Web Services] is released under version 2.0 of the http://www.apache.org/licenses/LICENSE-2.0[Apache License]. \ No newline at end of file diff --git a/mtom/README.md b/mtom/README.md deleted file mode 100644 index 2613a1b..0000000 --- a/mtom/README.md +++ /dev/null @@ -1,14 +0,0 @@ -# MTOM Sample - -This sample shows how to use marshal and unmarshal MTOM attachments using JAXB2. - -## Build and deploy - -See the main [README](../README.md) for build instructions. - -## License - -[Spring Web Services] is released under version 2.0 of the [Apache License]. - -[Spring Web Services]: https://projects.spring.io/spring-ws -[Apache License]: http://www.apache.org/licenses/LICENSE-2.0 \ No newline at end of file diff --git a/tutorial/README.adoc b/tutorial/README.adoc new file mode 100644 index 0000000..29d637a --- /dev/null +++ b/tutorial/README.adoc @@ -0,0 +1,16 @@ += Spring Web Service Tutorial + +This sample contains the code for the tutorial, which can be found in the +https://projects.spring.io/spring-ws[Spring Web Services] reference documentation. + +== Build and deploy + +. See the main link:../README.adoc[README] for build instructions. + +. Access the WSDL at the following URL: + +http://localhost:8080/tutorial/holiday.wsdl + +== License + +https://projects.spring.io/spring-ws[Spring Web Services] is released under version 2.0 of the http://www.apache.org/licenses/LICENSE-2.0[Apache License]. \ No newline at end of file diff --git a/tutorial/README.md b/tutorial/README.md deleted file mode 100644 index baf91eb..0000000 --- a/tutorial/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Spring Web Service Tutorial - -This sample contains the code for the tutorial, which can be found in the -[Spring Web Services] reference documentation. - -## Build and deploy - -1. See the main [README](../README.md) for build instructions. - -2. Access the WSDL at the following URL: - - [http://localhost:8080/tutorial/holiday.wsdl](http://localhost:8080/tutorial/holiday.wsdl) - - -## License - -[Spring Web Services] is released under version 2.0 of the [Apache License]. - -[Spring Web Services]: https://projects.spring.io/spring-ws -[Apache License]: http://www.apache.org/licenses/LICENSE-2.0 \ No newline at end of file diff --git a/weather/README.adoc b/weather/README.adoc new file mode 100644 index 0000000..64de817 --- /dev/null +++ b/weather/README.adoc @@ -0,0 +1,17 @@ += Weather Forecast Sample + +This sample shows how to use Spring Web Services to connect to the https://wiki.cdyne.com/index.php/CDYNE_Weather[CDYNE Weather Service]. +It uses JAXB to generate classes from the service's WSDL, and the `WebServiceTemplate` to +send the request to and receive the response from the service. + +You can run the client by using the following command from within this directory: + +---- +```sh +$ ./mvnw spring-boot:run +``` +---- + +== License + +https://projects.spring.io/spring-ws[Spring Web Services] is released under version 2.0 of the http://www.apache.org/licenses/LICENSE-2.0[Apache License]. \ No newline at end of file diff --git a/weather/README.md b/weather/README.md deleted file mode 100644 index aa367d0..0000000 --- a/weather/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Weather Forecast Sample - -This sample shows how to use Spring Web Services to connect to the [CDYNE Weather Service]. -It uses JAXB to generate classes from the service's WSDL, and the `WebServiceTemplate` to -send the request to and receive the response from the service. - -You can run the client by using the following command from within this directory: - - ```sh - $ gradle runClient - ``` - -## License - -[Spring Web Services] is released under version 2.0 of the [Apache License]. - -[Spring Web Services]: https://projects.spring.io/spring-ws -[Apache License]: http://www.apache.org/licenses/LICENSE-2.0 -[CDYNE Weather Service]: https://wiki.cdyne.com/index.php/CDYNE_Weather \ No newline at end of file