JBossWS uses the JBoss Application Server as its target container. The following examples focus on web service deployments that leverage EJB3 service implementations and the JAX-WS programming models. For further information on POJO service implementations and advanced topics you need consult the user guide.
JAX-WS does leverage annotations in order to express web service meta data on Java components and to describe the mapping between Java data types and XML. When developing web service implementations you need to decide whether you are going to start with an abstract contract (WSDL) or a Java component.
If you are in charge to provide the service implementation, then you are probably going to start with the implementation and derive the abstract contract from it. You are probably not even getting in touch with the WSDL unless you hand it to 3rd party clients. For this reason we are going to look at a service implementation that leverages JSR-181 annotations.
|Even though detailed knowledge of web service meta data is not required, it will definitely help if you make yourself familiar with it. For further information see|
When starting from Java you must provide the service implementation. A valid endpoint implementation class must meet the following requirements:
- It must carry a javax.jws.WebService annotation (see JSR 181)
- All method parameters and return types must be compatible with the JAXB 2.0
Let's look at a sample EJB3 component that is going to be exposed as a web service.
Don't be confused with the EJB3 annotation @Stateless. We concentrate on the @WebService annotation for now.
The method parameters and return values are going to represent our XML payload and thus require being compatible with JAXB2. Actually you wouldn't need any JAXB annotations for this particular example, because JAXB relies on meaningful defaults. For the sake of documentation we put the more important ones here.
Take a look at the request parameter:
|If you have more complex mapping problems you need to consult the JAXB documentation.|
Service deployment basically depends on the implementation type. As you may already know web services can be implemented as EJB3 components or plain old Java objects. This quick start leverages EJB3 components, that's why we are going to look at this case in the next sections.
Simply wrap up the service implementation class, the endpoint interface and any custom data types in a JAR and drop them in the deployment directory. No additional deployment descriptors required. Any meta data required for the deployment of the actual web service is taken from the annotations provided on the implementation class and the service endpoint interface. JBossWS will intercept that EJB3 deployment (the bean will also be there) and create an HTTP endpoint at deploy-time.
jar -tf jaxws-samples-retail.jar
|If the deployment was successful you should be able to see your endpoint in the application server management console.|
When creating web service clients you would usually start from the WSDL. JBossWS ships with a set of tools to generate the required JAX-WS artefacts to build client implementations. In the following section we will look at the most basic usage patterns. For a more detailed introduction to web service client please consult the user guide.
The wsconsume tool is used to consume the abstract contract (WSDL) and produce annotated Java classes (and optionally sources) that define it. We are going to start with the WSDL from our retail example (ProfileMgmtService.wsdl). For a detailed tool reference you need to consult the user guide.
Let's try it on our sample:
- As you can see we did use the -p switch to specify the package name of the generated sources.
|ProfileMgmt.java||Service Endpoint Interface|
|Customer.java||Custom data type|
|Discount*.java||Custom data type|
|ObjectFactory.java||JAXB XML Registry|
|package-info.java||Holder for JAXB package annotations|
Basically wsconsume generates all custom data types (JAXB annotated classes), the service endpoint interface and a service factory class. We will look at how these artifacts can be used the build web service client implementations in the next section.
Web service clients make use of a service stubs that hide the details of a remote web service invocation. To a client application a WS invocation just looks like an invocation of any other business component. In this case the service endpoint interface acts as the business interface. JAX-WS does use a service factory class to construct this as particular service stub:
- Create a service factory using the WSDL location and the service name
- Use the tool created service endpoint interface to build the service stub
- Use the stub like any other business interface