A Web Service Example: helloservice (original) (raw)

This example demonstrates a simple web service that generates a response based on information received from the client. HelloServiceBean is a stateless session bean that implements a single method: sayHello. This method matches the sayHello method invoked by the client described in A Simple JAX-WS Application Client.

The Web Service Endpoint Implementation Class

HelloServiceBean is the endpoint implementation class, typically the primary programming artifact for enterprise bean web service endpoints. The web service endpoint implementation class has the following requirements.

The class must be annotated with either the javax.jws.WebService or the javax.jws.WebServiceProvider annotation.
The implementing class may explicitly reference an SEI through the endpointInterface element of the @WebService annotation but is not required to do so. If no endpointInterface is specified in @WebService, an SEI is implicitly defined for the implementing class.
The business methods of the implementing class must be public and must not be declared static or final.
Business methods that are exposed to web service clients must be annotated with javax.jws.WebMethod.
Business methods that are exposed to web service clients must have JAXB-compatible parameters and return types. See the list of JAXB default data type bindings at Types Supported by JAX-WS.
The implementing class must not be declared final and must not be abstract.
The implementing class must have a default public constructor.
The endpoint class must be annotated @Stateless.
The implementing class must not define the finalize method.
The implementing class may use the javax.annotation.PostConstruct or javax.annotation.PreDestroy annotations on its methods for lifecycle event callbacks.
The @PostConstruct method is called by the container before the implementing class begins responding to web service clients.
The @PreDestroy method is called by the container before the endpoint is removed from operation.

Stateless Session Bean Implementation Class

The HelloServiceBean class implements the sayHello method, which is annotated @WebMethod. The source code for the HelloServiceBean class follows:

package com.sun.tutorial.javaee.ejb;

import javax.ejb.Stateless; import javax.jws.WebMethod; import javax.jws.WebService;

@Stateless @WebService public class HelloServiceBean { private String message = "Hello, ";

public void HelloServiceBean() {}

@WebMethod
public String sayHello(String name) {
    return message + name + ".";
}

}

Running the helloservice Example

You can use either NetBeans IDE or Ant to build, package, and deploy the helloservice example. You can then use the Administration Console to test the web service endpoint methods.

To Build, Package, and Deploy the helloservice Example Using NetBeans IDE

From the File menu, choose Open Project.
In the Open Project dialog, navigate to:
tut-install/examples/ejb/
Select the helloservice folder.
Select the Open as Main Project check box.
Click Open Project.
In the Projects tab, right-click the helloservice project and select Deploy.
This builds and packages the application into helloservice.ear, located in tut-install/examples/ejb/helloservice/dist/, and deploys this EAR file to the GlassFish Server.

To Build, Package, and Deploy the helloservice Example Using Ant

In a terminal window, go to:
tut-install/examples/ejb/helloservice/
Type the following command:
ant
This runs the default task, which compiles the source files and packages the application into a JAR file located at tut-install/examples/ejb/helloservice/dist/helloservice.jar.
To deploy helloservice, type the following command:
ant deploy
Upon deployment, the GlassFish Server generates additional artifacts required for web service invocation, including the WSDL file.

To Test the Service without a Client

The GlassFish Server Administration Console allows you to test the methods of a web service endpoint. To test the sayHello method of HelloServiceBean, follow these steps.

Open the Administration Console by opening the following URL in a web browser:
http://localhost:4848/
In the left pane of the Administration Console, select the Applications node.
In the Applications table, click helloservice.
In the Modules and Components table, click View Endpoint.
On the Web Service Endpoint Information page, click the Tester link:
/HelloServiceBeanService/HelloServiceBean?Tester
A Web Service Test Links page opens.
On the Web Service Test Links page, click the non-secure link (the one that specifies port 8080).
A HelloServiceBeanService Web Service Tester page opens.
Under Methods, type a name as the parameter to the sayHello method.
Click the sayHello button.
The sayHello Method invocation page opens. Under Method returned, you’ll see the response from the endpoint.