Web Services Metadata Annotation Example

Contents

• Overview
• Quick Start
• Step By Step
• Supported Annotation tags
• Oracle Web Services Compiler wsc.jar usage

The example shows how use Oracle Web Service Compiler (wsc.jar) to create a web service application (ear file) directly from a Java Source (.java) file with Web Services Metadata annotation in JavaDoc comments. In the source code example Hello.java we use annotation to indicate rpc-literal message style being used, and we also specify the subset of methods that are to be exposed.

NOTE: In order to process javadoc, wsc.jar has dependency on tools.jar from JDK1.4. If wsc.jar cannot find tools.jar under {ORACLE_HOME}/jdk/lib, execution will exit.

Ensure that you have installed the required software and set up your environment. You must have OC4J running. If it is not running on your localhost on port 8888, you'll have to modify the ANT script (build.xml) to use the correct host and port to your server.

Once you have the server configured and running, just type ant. The web service ear file will be generated from the Hello.java source code by wsc.jar, and deployed to OC4J. Then the ant script uses the Web Services Assembler (wsa.jar) to generate aclient-side proxy. After compiling the client proxy, the script runs the client code oracle.demo.metadata.clientHelloClient to invoke the Web Service.

1. To create a deployable ear from a java source file with Web Service annotation in JavaDoc comments, type:

   % ant wsc-Hello

   or

   % java -jar wsc.jar -output build/Hello.ear Hello.java

   This should result in a J2EE Web Services compliant application file: build/Hello.ear. The -output argument is optional. If it is not specified, the generated ear will be named Hello.ear and put in current directory.

2. To deploy and bind the application, type:

   % ant deploy-Hello

   Visit the http test page by going to http://localhost:8888/Hello/Hello and ensure that the application has been deployed properly.

3. To run the client, issue:

   % ant run-Hello-client

   You should see a result like:

   HelloClient: Hello WebService Metadata

   NOTE: The client code is oracle.demo.metadata.client.HelloClient under client-src directory. In order to compile and run this class, client-side stubs(proxy) needs to be generated and compiled into client's classpath. The ant target run-Hello-client does all of these. The script runs wsa with the config file stub-config.xml to generate client proxy.

• Class level tags are placed before the class declaration.
  • @oracle.ws.WebService
    • targetNamespace: the target namespace of generated WSDL.
    • typeNamespace: the target namespace of generated schema for Java Value Types.
    • portTypeName: the abstract port-type name, the generated Service Endpoint Interface mapped to.
    Example:

    /** @oracle.ws.WebService (portTypeName="MyHelloType", typeNamespace="/xsd",
    
     *                         targetNamespace="/index.html") **/

  • @oracle.ws.PortBinding
    • bindingName: the concrete binding name, the generated Service Endpoint Interface mapped to.
    • style: the operation style, "document" or "rpc".
    • use: the use of operation input output message format, "literal" or "encoded".
    Example:

     /** @oracle.ws.PortBinding( bindingName = "HelloPortBinding", 
    
      *                          style = "rpc", use = "literal" ) */

• Method level tags are placed before the method declaration.
  • @oracle.ws.Operation
    • name: the Web Services operation name that this JAVA method is mapped to.
    Example: /** @oracle.ws.Operation (name="say-hello") */
  • @webmethod
    This tag has been used by JDeveloper to select methods to be exposed in a Web Service.
    Example: /** @webmethod */

java -jar wsc.jar options file1.java ...

where possible options include:

• -urlpath path - Specifies the HTTP URL path, by default this is the same as the class name. For this example, the class name, Hello, is used as the URL Path.
• -output ear_file - Specifies the output ear name
• -depend directory - Specifies where to find depend jar or class files
• -help - Prints a usage note.