A Web Service Example: helloservice
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 thesayHello
method invoked by the client described in A Simple JAX-WS Client.The Web Service Endpoint Implementation Class
HelloServiceBean
is the endpoint implementation class. The endpoint implementation class is 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
orjavax.jws.WebServiceProvider
annotations.- The implementing class may explicitly reference an SEI through the
endpointInterface
element of the@WebService
annotation, but is not required to do so. If noendpointInterface
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
orfinal
.- 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 JAX-B-compatible parameters and return types. See Default Data Type Bindings.
- The implementing class must not be declared
final
and must not beabstract
.- 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
orjavax.annotation.PreDestroy
annotations on its methods for life-cycle 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 thesayHello
method, which is annotated@WebMethod
. The source code for theHelloServiceBean
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 + "."; } }Building, Packaging, Deploying, and Testing the helloservice Example
You can build, package, and deploy the
helloservice
example using either NetBeans 5.5 or Ant. You can then use the Admin Console to test the web service endpoint methods.Building, Packaging, and Deploying the helloservice Example Using NetBeans 5.5
Follow these instructions to build, package, and deploy the
helloservice
example to your Application Server instance using the NetBeans 5.5 IDE.
- In NetBeans 5.5, select File
Open Project.
- In the Open Project dialog, navigate to
<
INSTALL
>/javaeetutorial5/examples/ejb/
.- Select the
helloservice
folder.- Select the Open as Main Project and Open Required Projects checkboxes.
- Click Open Project Folder.
- In the Projects tab, right-click the
helloservice
project and select Deploy Project.This builds and packages to application into
helloservice.ear
, located in<
INSTALL
>/javaeetutorial5/examples/ejb/helloservice/dist
, and deploys this ear file to your Application Server instance.Building, Packaging, and Deploying the helloservice Example Using Ant
Follow these instructions to build, package, and deploy the
helloservice
example to your Application Server instance using Ant.
- In a terminal window, go to the
<INSTALL>
/javaeetutorial5/
directory.
examples/ejb/helloservice/- To build
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<
INSTALL
>/examples/ejb/helloservice/dist/helloservice.jar
.- To deploy
helloservice
, type the following command:
ant deploy
Upon deployment, the Application Server generates additional artifacts required for web service invocation, including the WSDL file.
Testing the Service without a Client
The Application Server Admin Console allows you to test the methods of a web service endpoint. To test the
sayHello
method ofHelloServiceBean
, do the following:
- Open the Admin Console by opening the following URL in a web browser:
http://localhost:4848/
- Enter the admin username and password to log in to the Admin Console.
- Click Web Services in the left pane of the Admin Console.
- Click
helloservice
.- Click Test.
- Under Methods, enter a name as the parameter to the
sayHello
method.- Click the
sayHello
button.This will take you to the
sayHello
Method invocation page.- Under Method returned, you'll see the response from the endpoint.