Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixing bean service Readme #306

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 41 additions & 15 deletions bean-service/Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
Introduction
============
This quickstart demonstrates the usage of the bean component. This example shows a bean component
bean-service: demonstrates the usage of the bean component
============================================
Author: SwitchYard Team
Level: Beginner
Technologies: SwitchYard, Camel, SOAP
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you need to add 2x spaces after each of these lines. Otherwise, it renders on a single line. See the GitHub render of this file.

Summary: Demonstrates the usage of the bean component.
Target Product: FSW
Source: <https://github.com/jboss-switchyard/quickstarts>


What is it?
-----------
This quickstart demonstrates the usage of the bean component.

This example shows a bean component
service, OrderService, which is provided through the OrderServiceBean, and an InventoryService which
is provided through the InventoryServiceBean implementation. Orders are submitted through the
OrderService, and the OrderService then looks items up in the InventoryService to see if they are
Expand All @@ -10,31 +22,42 @@ This example is invoked through a SOAP gateway binding.

![Bean Service Quickstart](https://github.com/jboss-switchyard/quickstarts/raw/master/bean-service/bean-service.jpg)

Running the quickstart
======================

JBoss AS 7
----------

System requirements
-------------------

Before building and running this quick start you need:

* Maven 3.0.3 or higher
* JDK 1.6 or 1.7
* JBoss AS 7

Build and Deploy the Quickstart
-------------------------
1. Start JBoss AS 7 in standalone mode:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think section should look like this one: https://github.com/jboss-developer/jboss-wfk-quickstarts/tree/master/helloworld-rf#start-the-jboss-server

@sgilda Do you know if we still refer to the "JBoss Server" despite it being the FSW product?


${AS}/bin/standalone.sh
`${AS}/bin/standalone.sh`

2. Build and deploy the Quickstart :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello, paul! I tried to follow jbossfuse quickstarts pattern - https://raw.github.com/jboss-fuse/quickstarts/master/cbr/README.md

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, no problem. I think the two main issues are:

  1. What AS name to use. I think AS7 is wrong, but not yet sure if it should be JBoss, FSW, etc.
  2. We are missing instructions to configure maven. In the other QS repos, these instructions are in the root readme file and linked from here. However, we don't yet have those instructions, so I think we just leave that bit out.

So in summary, for now I think you just need to replace "JBoss AS 7". I think we need to discuss it in #jboss-jdf. I'll raise it when Sande and Rafael are online, then report back.


mvn install -Pdeploy
mvn install -Pdeploy

3. Submit a webservice request to invoke the SOAP gateway. There are a number of ways to do this :
- Submit a request with your preferred SOAP client - src/test/resources/xml contains sample
Use the bundle
-------------------

Submit a webservice request to invoke the SOAP gateway. There are a number of ways to do this :
* Submit a request with your preferred SOAP client - src/test/resources/xml contains sample
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These bullets don't seem to render correctly. See the preview.

requests and the responses that you should see
- Use the simple bundled SOAP client and the sample request XML e.g.
* Use the simple bundled SOAP client and the sample request XML e.g.
<br/>
```
mvn exec:java
```
<br/>
- SOAP-UI : Use the wsdl for this project (src/main/resources/wsdl/OrderService.wsdl) to create
* SOAP-UI : Use the wsdl for this project (src/main/resources/wsdl/OrderService.wsdl) to create
a soap-ui project. Use the sample request (src/test/resources/xml/soap-request.xml) as an
example of a sample request. The output below is the expected output :
example of a sample request. The expected output is below:

```
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
Expand All @@ -51,7 +74,10 @@ JBoss AS 7
</SOAP-ENV:Envelope>
```

4. Undeploy the quickstart:
Undeploy the bundle
-------------------

Undeploy the quickstart:
mvn clean -Pdeploy

## Further Reading
Expand Down
50 changes: 35 additions & 15 deletions bpel-jms-binding/Readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
Introduction
============
bpel-jms-binding: demonstrates the use of a JMS binding for a BPEL service
============================================
Author: SwitchYard Team
Level: Beginner
Technologies: SwitchYard, BPEL, Camel
Summary: Demonstrates the use of a JMS binding for a BPEL service.
Target Product: FSW
Source: <https://github.com/jboss-switchyard/quickstarts>

What is it?
-----------
This quickstart demonstrates the use of a JMS binding for a BPEL service. Also of
note : the Camel JMS binding in the quickstart uses WSDL as it's interface type
instead of Java.
Expand All @@ -8,36 +17,47 @@ instead of Java.
![BPEL JMS Binding Quickstart](https://github.com/jboss-switchyard/quickstarts/raw/master/bpel-service/jms_binding/bpel-jms-binding.jpg)


Running the quickstart
======================

JBoss AS 7
----------
System requirements
-------------------
Before building and running this quick start you need:

* Maven 3.0.3 or higher
* JDK 1.6 or 1.7
* JBoss AS 7


Build and Deploy the Quickstart
-------------------------
1. Start JBoss AS 7 in standalone-full mode:

${AS}/bin/standalone.sh --server-config=standalone-full.xml
`${AS}/bin/standalone.sh --server-config=standalone-full.xml`

2. Add JMS user using add-user.sh with username=guest, password=guestp.1, Realm=ApplicationRealm, role=guest

${AS}/bin/add-user.sh
`${AS}/bin/add-user.sh`

3. Build and deploy the quickstart
3. Deploy the quickstart with

mvn install -Pdeploy
`mvn install -Pdeploy`

4. Execute HornetQClient

mvn exec:java
`mvn exec:java`

Use the bundle
-------------------
Successful case will produce the following output:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Successful case...


Expected Output
===============
```
Message sent. Waiting for reply ...
REPLY:
<sayHelloResponse xmlns="http://www.jboss.org/bpel/examples">
<tns:result xmlns:tns="http://www.jboss.org/bpel/examples">Hello Skippy</tns:result>
</sayHelloResponse>
```
Undeploy the bundle
-------------------

5. Undeploy the quickstart:
mvn clean -Pdeploy
Undeploy the quickstart:
`mvn clean -Pdeploy`