Programming Web Services for WebLogic Server

Programming the JWS File

The following sections provide information about programming the JWS file that implements your Web Service:

Overview of JWS Files and JWS Annotations

One way to program a WebLogic Web Service is to code the standard JSR-921 EJB or Java class from scratch and generate its associated artifacts manually (deployment descriptor files, WSDL file, data binding artifacts for user-defined data types, and so on). This process can be difficult and tedious. BEA recommends that you take advantage of the new JDK 5.0 metadata annotations feature and use a programming model in which you create an annotated Java file and then use Ant tasks to compile the file into the Java source code and generate all the associated artifacts.

The Java Web Service (JWS) annotated file is the core of your Web Service. It contains the Java code that determines how your Web Service behaves. A JWS file is an ordinary Java class file that uses JDK 5.0 metadata annotations to specify the shape and characteristics of the Web Service. The JWS annotations you can use in a JWS file include the standard ones defined by the Web Services Metadata for the Java Platform specification (JSR-181) as well as a set of WebLogic-specific ones.

This topic is part of the iterative development procedure for creating a Web Service, described in Iterative Development of WebLogic Web Services Starting From Java: Main Steps and Iterative Development of WebLogic Web Services Starting From a WSDL File: Main Steps. It is assumed that you have created a JWS file and now want to add JWS annotations to it.

Programming the JWS File: Java Requirements

When you program your JWS file, you must follow a set of requirements, as specified by the JSR-181 specification (Web Services Metadata for the Java Platform). In particular, the Java class that implements the Web Service:

Programming the JWS File: Typical Steps

The following sections how to use standard ( JSR-181) and WebLogic-specific annotations in your JWS file to program basic Web Service features. The annotations are used at different levels, or targets, in your JWS file. Some are used at the class-level to indicate that the annotation applies to the entire JWS file. Others are used at the method-level and yet others at the parameter level. The sections discuss the following basic JWS annotations:

See Advanced JWS Programming: Implementing Asynchronous Features, for information on using other JWS annotations to program more advanced features, such as Web Service reliable messaging, conversations, SOAP message handlers, and so on.

For reference documentation about both the standard and WebLogic-specific JWS annotations, see JWS Annotation Reference.

The following procedure describes the typical basic steps when programming the JWS file that implements a Web Service. See Example of a JWS File for a code example.

Example of a JWS File

The following sample JWS file shows how to implement a simple Web Service.

package examples.webservices.simple;

// Import the standard JWS annotation interfaces

import javax.jws.WebMethod;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;

// Import the WebLogic-specific JWS annotation interfaces

import weblogic.jws.WLHttpTransport;

// Standard JWS annotation that specifies that the porType name of the Web
// Service is "SimplePortType", the service name is "SimpleService", and the
// targetNamespace used in the generated WSDL is "http://example.org"

@WebService(name="SimplePortType", serviceName="SimpleService",
            targetNamespace="http://example.org")

// Standard JWS annotation that specifies the mapping of the service onto the
// SOAP message protocol.  In particular, it specifies that the SOAP messages
// are document-literal-wrapped.

@SOAPBinding(style=SOAPBinding.Style.DOCUMENT,
             use=SOAPBinding.Use.LITERAL,
             parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)

// WebLogic-specific JWS annotation that specifies the context path and
// service URI used to build the URI of the Web Service is
// "simple/SimpleService"

@WLHttpTransport(contextPath="simple", serviceUri="SimpleService",
                 portName="SimpleServicePort")

/**
 * This JWS file forms the basis of simple Java-class implemented WebLogic
 * Web Service with a single operation: sayHello
 *
 */

public class SimpleImpl {

  // Standard JWS annotation that specifies that the method should be exposed
  // as a public operation.  Because the annotation does not include the
  // member-value "operationName", the public name of the operation is the
 // same as the method name: sayHello.

  @WebMethod()
  public String sayHello(String message) {
    System.out.println("sayHello:" + message);
    return "Here is the message: '" + message + "'";
  }
}

Specifying That the JWS File Implements a Web Service

Use the standard @WebService annotation to specify, at the class level, that the JWS file implements a Web Service, as shown in the following code excerpt:

@WebService(name="SimplePortType", serviceName="SimpleService",
            targetNamespace="http://example.org")

In the example, the name of the Web Service is SimplePortType, which will later map to the wsdl:portType element in the WSDL file generated by the jwsc Ant task. The service name is SimpleService, which will map to the wsdl:service element in the generated WSDL file. The target namespace used in the generated WSDL is http://example.org.

You can also specify the following additional attribute of the @WebService annotation:

None of the attributes of the @WebService annotation is required. See the Web Services Metadata for the Java Platform for the default values of each attribute.

Specifying the Mapping of the Web Service to the SOAP Message Protocol

It is assumed that you want your Web Service to be available over the SOAP message protocol; for this reason, your JWS file should include the standard @SOAPBinding annotation, at the class level, to specify the SOAP bindings of the Web Service (such as RPC-encoded or document-literal-wrapped), as shown in the following code excerpt:

@SOAPBinding(style=SOAPBinding.Style.DOCUMENT,
             use=SOAPBinding.Use.LITERAL,
             parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)

In the example, the Web Service uses document-wrapped-style encodings and literal message formats, which are also the default formats if you do not specify the @SOAPBinding annotation.

You can also use the WebLogic-specific @weblogic.jws.soap.SOAPBinding annotation to specify the SOAP binding at the method level; the attributes are the same as the standard @javax.jws.soap.SOAPBinding annotation.

You use the parameterStyle attribute (in conjunction with the style=SOAPBinding.Style.DOCUMENT attribute) to specify whether the Web Service operation parameters represent the entire SOAP message body, or whether the parameters are elements wrapped inside a top-level element with the same name as the operation.

The following table lists the possible and default values for the three attributes of the @SOAPBinding (either the standard or WebLogic-specific) annotation.

Specifying the Context Path and Service URI of the Web Service

Use the WebLogic-specific @WLHttpTransport annotation to specify the context path and service URI sections of the URL used to invoke the Web Service over the HTTP transport, as well as the name of the port in the generated WSDL, as shown in the following code excerpt:

@WLHttpTransport(contextPath="simple", serviceUri="SimpleService",
                 portName="SimpleServicePort")

In the example, the name of the port in the WSDL (in particular, the name attribute of the <port> element) file generated by the jwsc Ant task is SimpleServicePort. The URL used to invoke the Web Service over HTTP includes a context path of simple and a service URI of SimpleService, as shown in the following example:

http://host:port/simple/SimpleService

For reference documentation on this and other WebLogic-specific annotations, see JWS Annotation Reference.

Specifying That a JWS Method Be Exposed as a Public Operation

Use the standard @WebMethod annotation to specify that a method of the JWS file should be exposed as a public operation of the Web Service, as shown in the following code excerpt:

public class SimpleImpl {

  @WebMethod(operationName="sayHelloOperation")
  public String sayHello(String message) {
    System.out.println("sayHello:" + message);
    return "Here is the message: '" + message + "'";
  }
...

In the example, the sayHello() method of the SimpleImpl JWS file is exposed as a public operation of the Web Service. The operationName attribute specifies, however, that the public name of the operation in the WSDL file is sayHelloOperation. If you do not specify the operationName attribute, the public name of the operation is the name of the method itself.

You can also use the action attribute to specify the action of the operation. When using SOAP as a binding, the value of the action attribute determines the value of the SOAPAction header in the SOAP messages.

You can specify that an operation not return a value to the calling application by using the standard @Oneway annotation, as shown in the following example:

 public class OneWayImpl {

  @WebMethod()
  @Oneway()

  public void ping() {
    System.out.println("ping operation");
  }

...

If you specify that an operation is one-way, the implementing method is required to return void, cannot use a Holder class as a parameter, and cannot throw any checked exceptions.

None of the attributes of the @WebMethod annotation is required. See the Web Services Metadata for the Java Platform for the default values of each attribute, as well as additional information about the @WebMethod and @Oneway annotations.

If none of the public methods in your JWS file are annotated with the @WebMethod annotation, then by default all public methods are exposed as Web Service operations.

Customizing the Mapping Between Operation Parameters and WSDL Parts

Use the standard @WebParam annotation to customize the mapping between operation input parameters of the Web Service and elements of the generated WSDL file, as well as specify the behavior of the parameter, as shown in the following code excerpt:

 public class SimpleImpl {

  @WebMethod()
  @WebResult(name="IntegerOutput",
             targetNamespace="http://example.org/docLiteralBare")
  public int echoInt(
      @WebParam(name="IntegerInput",
                targetNamespace="http://example.org/docLiteralBare")
      int input)

  {
      System.out.println("echoInt '" + input + "' to you too!");
      return input;
  }
...

In the example, the name of the parameter of the echoInt operation in the generated WSDL is IntegerInput; if the @WebParam annotation were not present in the JWS file, the name of the parameter in the generated WSDL file would be the same as the name of the method’s parameter: input. The targetNamespace attribute specifies that the XML namespace for the parameter is http://example.org/docLiteralBare; this attribute is relevant only when using document-style SOAP bindings where the parameter maps to an XML element.

You can also specify the following additional attributes of the @WebParam annotation:

None of the attributes of the @WebParam annotation is required. See the Web Services Metadata for the Java Platform for the default value of each attribute.

Customizing the Mapping Between the Operation Return Value and a WSDL Part

Use the standard @WebResult annotation to customize the mapping between the Web Service operation return value and the corresponding element of the generated WSDL file, as shown in the following code excerpt:

 public class Simple {

  @WebMethod()
  @WebResult(name="IntegerOutput",
             targetNamespace="http://example.org/docLiteralBare")
  public int echoInt(
      @WebParam(name="IntegerInput",
                targetNamespace="http://example.org/docLiteralBare")
      int input)

  {
      System.out.println("echoInt '" + input + "' to you too!");
      return input;
  }
...

In the example, the name of the return value of the echoInt operation in the generated WSDL is IntegerOutput; if the @WebResult annotation were not present in the JWS file, the name of the return value in the generated WSDL file would be the hard-coded name return. The targetNamespace attribute specifies that the XML namespace for the return value is http://example.org/docLiteralBare; this attribute is relevant only when using document-style SOAP bindings where the return value maps to an XML element.

None of the attributes of the @WebResult annotation is required. See the Web Services Metadata for the Java Platform for the default value of each attribute.

Accessing Runtime Information about a Web Service Using the JwsContext

When a client application invokes a WebLogic Web Service that was implemented with a JWS file, WebLogic Server automatically creates a context that the Web Service can use to access, and sometimes change, runtime information about the service. Much of this information is related to conversations, such as whether the current conversation is finished, the current values of the conversational properties, changing conversational properties at runtime, and so on. (See Creating Conversational Web Services for information about conversations and how to implement them.) Some of the information accessible via the context is more generic, such as the protocol that was used to invoke the Web Service (HTTP/S or JMS), the SOAP headers that were in the SOAP message request, and so on.

You can use annotations and WebLogic Web Service APIs in your JWS file to access runtime context information, as described in the following sections.

Guidelines for Accessing the Web Service Context

The following example shows a simple JWS file that uses the context to determine the protocol that was used to invoke the Web Service; the code in bold is discussed in the programming guidelines described after the example.

package examples.webservices.jws_context;

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.WLHttpTransport;
import weblogic.jws.Context;

import weblogic.wsee.jws.JwsContext;
import weblogic.wsee.jws.Protocol;

@WebService(name="JwsContextPortType", serviceName="JwsContextService",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="contexts", serviceUri="JwsContext",
                 portName="JwsContextPort")

/**
 * Simple web service to show how to use the @Context annotation.
 */

public class JwsContextImpl {

  @Context
  private JwsContext ctx;

  @WebMethod()
  public String getProtocol() {

    Protocol protocol = ctx.getProtocol();

    System.out.println("protocol: " + protocol);
    return "This is the protocol: " + protocol;
  }
}

Use the following guidelines in your JWS file to access the runtime context of the Web Service, as shown in the code in bold in the preceding example:

Methods of the JwsContext

The following table briefly describes the methods of the JwsContext that you can use in your JWS file to access runtime information about the Web Service. See weblogic.wsee.* Javadocs for detailed reference information about JwsContext, and other context-related APIs, as Protocol and ServiceHandle.

Should You Implement a Stateless Session EJB?

The jwsc Ant task always chooses a plain Java object as the underlying implementation of a Web Service when processing your JWS file.

Sometimes, however, you might want the underlying implementation of your Web Service to be a stateless session EJB so as to take advantage of all that EJBs have to offer, such as instance pooling, transactions, security, container-managed persistence, container-managed relationships, and data caching. If you decide you want an EJB implementation for your Web Service, then follow the programming guidelines in the following section.

Programming Guidelines When Implementing an EJB in Your JWS File

The general guideline is to always use EJBGen annotations in your JWS file to automatically generate, rather than manually create, the EJB Remote and Home interface classes and deployment descriptor files needed when implementing an EJB. EJBGen annotations work in the same way as JWS annotations: they follow the JDK 5.0 metadata syntax and greatly simplify your programming tasks.

For more information on EJBGen, see the EJBGen Reference section in Programming WebLogic Enterprise JavaBeans.

Follow these guidelines when explicitly implementing a stateless session EJB in your JWS file. See Example of a JWS File That Implements an EJB for an example; the relevant sections are shown in bold:

If you follow all these guidelines in your JWS file, the jwsc Ant task later compiles the Web Service into an EJB and packages it into an EJB JAR file inside of the Enterprise Application.

Example of a JWS File That Implements an EJB

The following example shows a simple JWS file that implement a stateless session EJB. The relevant code is shown in bold.

package examples.webservices.transactional;

import javax.ejb.SessionBean;
import javax.ejb.SessionContext;

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.WLHttpTransport;
import weblogic.jws.Transactional;

import weblogic.ejbgen.Session;

@Session(ejbName="TransactionEJB")

@WebService(name="TransactionPortType", serviceName="TransactionService",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="transactions", serviceUri="TransactionService",
                 portName="TransactionPort")

/**
 * This JWS file forms the basis of simple EJB-implemented WebLogic
 * Web Service with a single operation: sayHello.  The operation executes
 * as part of a transaction.
 *
 */

public class TransactionImpl implements SessionBean {

  @WebMethod()
  @Transactional(value=true)

  public String sayHello(String message) {
    System.out.println("sayHello:" + message);
    return "Here is the message: '" + message + "'";
  }

  // Standard EJB methods.  Typically there's no need to override the methods.

  public void ejbCreate() {}
  public void ejbActivate() {}
  public void ejbRemove() {}
  public void ejbPassivate() {}
  public void setSessionContext(SessionContext sc) {}
}

Programming the User-Defined Java Data Type

The methods of the JWS file that are exposed as Web Service operations do not necessarily take built-in data types (such as Strings and integers) as parameters and return values, but rather, might use a Java data type that you create yourself. An example of a user-defined data type is TradeResult, which has two fields: a String stock symbol and an integer number of shares traded.

If your JWS file uses user-defined data types as parameters or return values of one or more of its methods, you must create the Java code of the data type yourself, and then import the class into your JWS file and use it appropriately. The jwsc Ant task will later take care of creating all the necessary data binding artifacts, such as the corresponding XML Schema representation of the Java user-defined data type, the JAX-RPC type mapping file, and so on.

Follow these basic requirements when writing the Java class for your user-defined data type:

These requirements are specified by JAX-RPC 1.1; for more detailed information and the complete list of requirements, see the JAX-RPC specification.

The jwsc Ant task can generate data binding artifacts for most common XML and Java data types. For the list of supported user-defined data types, see Supported User-Defined Data Types. See Supported Built-In Data Types for the full list of supported built-in data types.

The following example shows a simple Java user-defined data type called BasicStruct:

package examples.webservices.complex;

/**
 * Defines a simple JavaBean called BasicStruct that has integer, String,
 * and String[] properties
 */

public class BasicStruct {

  // Properties

  private int intValue;
  private String stringValue;
  private String[] stringArray;

  // Getter and setter methods

  public int getIntValue() {
    return intValue;
  }

  public void setIntValue(int intValue) {
    this.intValue = intValue;
  }

  public String getStringValue() {
    return stringValue;
  }

  public void setStringValue(String stringValue) {
    this.stringValue = stringValue;
  }

  public String[] getStringArray() {
    return stringArray;
  }

  public void setStringArray(String[] stringArray) {
    this.stringArray = stringArray;
  }

}

The following snippets from a JWS file show how to import the BasicStruct class and use it as both a parameter and return value for one of its methods; for the full JWS file, see Sample ComplexImpl.java JWS File:

package examples.webservices.complex;

// Import the standard JWS annotation interfaces

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;

// Import the WebLogic-specific JWS annotation interface

import weblogic.jws.WLHttpTransport;

// Import the BasicStruct JavaBean

import examples.webservices.complex.BasicStruct;

@WebService(serviceName="ComplexService", name="ComplexPortType",
            targetNamespace="http://example.org")

...

public class ComplexImpl {

  @WebMethod(operationName="echoComplexType")
  public BasicStruct echoStruct(BasicStruct struct)

  {
    return struct;
  }
}

Throwing Exceptions

When you write the error-handling Java code in methods of the JWS file, you can either throw your own user-defined exceptions or throw a javax.xml.rpc.soap.SOAPFaultException exception. If you throw a SOAPFaultException, WebLogic Server maps it to a SOAP fault and sends it to the client application that invokes the operation.

If your JWS file throws any type of Java exception other than SOAPFaultException, WebLogic Server tries to map it to a SOAP fault as best it can. However, if you want to control what the client application receives and send it the best possible exception information, you should explicitly throw a SOAPFaultException exception or one that extends the exception. See the JAX-RPC 1.1 specification for detailed information about creating and throwing your own user-defined exceptions.

The following excerpt describes the SOAPFaultException class:

public class SOAPFaultException extends java.lang.RuntimeException {
    public SOAPFaultException (QName faultcode,
                               String faultstring,
                               String faultactor,
                               javax.xml.soap.Detail detail ) {...}
    public Qname getFaultCode() {...}
    public String getFaultString() {...}
    public String getFaultActor() {...}
    public javax.xml.soap.Detail getDetail() {...}
}

Use the SOAP with Attachments API for Java 1.1 (SAAJ) javax.xml.soap.SOAPFactory.createDetail() method to create the Detail object, which is a container for DetailEntry objects that provide detailed application-specific information about the error.

You can use your own implementation of the SOAPFactory, or use BEA's, which can be accessed in the JWS file by calling the static method weblogic.wsee.util.WLSOAPFactory.createSOAPFactory() which returns a javax.xml.soap.SOAPFactory object. Then at runtime, use the -Djavax.xml.soap.SOAPFactory flag to specify BEA’s SOAPFactory implementation as shown:

-Djavax.xml.soap.SOAPFactory=weblogic.xml.saaj.SOAPFactoryImpl

The following JWS file shows an example of creating and throwing a SOAPFaultException from within a method that implements an operation of your Web Service; the sections in bold highlight the exception code:

package examples.webservices.soap_exceptions;

import javax.xml.namespace.QName;
import javax.xml.soap.Detail;
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPFactory;
import javax.xml.rpc.soap.SOAPFaultException;

// Import the @WebService annotation

import javax.jws.WebService;

// Import WLHttpTransport

import weblogic.jws.WLHttpTransport;

@WebService(serviceName="SoapExceptionsService",
            name="SoapExceptionsPortType",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="exceptions",
                 serviceUri="SoapExceptionsService",
                 portName="SoapExceptionsServicePort")
/**
 * This JWS file forms the basis of simple Java-class implemented WebLogic
 * Web Service with a single operation: sayHelloWorld
 *
 * @author Copyright (c) 2005 by BEA Systems.  All rights reserved.
 */

public class SoapExceptionsImpl {

  public SoapExceptionsImpl() {

  }

  public void tirarSOAPException() {

    Detail detail = null;

    try {

      SOAPFactory soapFactory = SOAPFactory.newInstance();
      detail = soapFactory.createDetail();

    } catch (SOAPException e) {
        // do something
    }

    QName faultCode = null;
    String faultString = "the fault string";
    String faultActor = "the fault actor";
    throw new SOAPFaultException(faultCode, faultString, faultActor, detail);
  }
}

The preceding example uses the default implementation of SOAPFactory.

Invoking Another Web Service from the JWS File

From within your JWS file you can invoke another Web Service, either one deployed on WebLogic Server or one deployed on some other application server, such as .NET. The steps to do this are similar to those described in Invoking a Web Service from a Stand-alone JAX-RPC Java Client, except that rather than running the clientgen Ant task to generate the client stubs, you include a <clientgen> child element of the jwsc Ant task that builds the invoking Web Service to generate the client stubs instead. You then use the standard JAX-RPC APIs in your JWS file the same as you do in a stand-alone client application.

See Invoking a Web Service from Another Web Service for detailed instructions.

Programming Additional Miscellaneous Features Using JWS Annotations and APIs

The following sections describe additional miscellaneous features you can program by specifying particular JWS annotations in your JWS file or using WebLogic Web Services APIs:

Streaming SOAP Attachments

Using the @weblogic.jws.StreamAttachments JWS annotation, you can specify that a Web Service use a streaming API when reading inbound SOAP messages that include attachments, rather than the default behavior in which the service reads the entire message into memory. This feature increases the performance of Web Services whose SOAP messages are particular large.

See weblogic.jws.StreamAttachments for an example of specifying that attachments should be streamed.

Using SOAP 1.2

WebLogic Web Services use, by default, Version 1.1 of Simple Object Access Protocol (SOAP) as the message format when transmitting data and invocation calls between the Web Service and its client. To specify that the Web Service use Version 1.2 of SOAP, use the class-level @weblogic.jws.Binding annotation in your JWS file and set its single attribute to the value Binding.Type.SOAP12, as shown in the following example (relevant code shown in bold):

package examples.webservices.soap12;

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.WLHttpTransport;
import weblogic.jws.Binding;

@WebService(name="SOAP12PortType",
            serviceName="SOAP12Service",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="soap12",
                 serviceUri="SOAP12Service",
                 portName="SOAP12ServicePort")

@Binding(Binding.Type.SOAP12)

/**
 * This JWS file forms the basis of simple Java-class implemented WebLogic
 * Web Service with a single operation: sayHello.  The class uses SOAP 1.2
 * as its binding.
 *
 */

public class SOAP12Impl {

  @WebMethod()
  public String sayHello(String message) {
    System.out.println("sayHello:" + message);
    return "Here is the message: '" + message + "'";
  }
}

Other than set this annotation, you do not have to do anything else for the Web Service to use SOAP 1.2, including changing client applications that invoke the Web Service; the WebLogic Web Services runtime takes care of all the rest.

Specifying that Operations Run Inside of a Transaction

When a client application invokes a WebLogic Web Service operation, the operation invocation takes place outside the context of a transaction, by default. If you want the operation to run inside a transaction, specify the @weblogic.jws.Transactional annotation in your JWS file, and set the boolean value attribute to true, as shown in the following example (relevant code shown in bold):

package examples.webservices.transactional;

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.WLHttpTransport;
import weblogic.jws.Transactional;

@WebService(name="TransactionPojoPortType",
            serviceName="TransactionPojoService",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="transactionsPojo",
                 serviceUri="TransactionPojoService",
                 portName="TransactionPojoPort")

/**
 * This JWS file forms the basis of simple WebLogic
 * Web Service with a single operation: sayHello.  The operation executes
 * as part of a transaction.
 *
 */

public class TransactionPojoImpl {

  @WebMethod()
  @Transactional(value=true)
  public String sayHello(String message) {
    System.out.println("sayHello:" + message);
    return "Here is the message: '" + message + "'";
  }
}

If you want all operations of a Web Service to run inside of a transaction, specify the @Transactional annotation at the class-level. If you want only a subset of the operations to be transactional, specify the annotation at the method-level. If there is a conflict, the method-level value overrides the class-level.

See weblogic.jws.Transactional for information about additional attributes.

Getting the HttpServletRequest/Response Object

If your Web Service uses HTTP as its transport protocol, you can use the weblogic.wsee.connection.transport.servlet.HttpTransportUtils API to get the javax.servlet.http.HttpServletRequest and javax.servlet.http.HttpServletResponse objects from the JAX-RPC ServletEndpointContext object, as shown in the following example (relevant code shown in bold and explained after the example):

package examples.webservices.http_transport_utils;

import javax.xml.rpc.server.ServiceLifecycle;
import javax.xml.rpc.server.ServletEndpointContext;
import javax.xml.rpc.ServiceException;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import javax.jws.WebMethod;
import javax.jws.WebService;

import weblogic.jws.WLHttpTransport;

import weblogic.wsee.connection.transport.servlet.HttpTransportUtils;

@WebService(name="HttpTransportUtilsPortType",
            serviceName="HttpTransportUtilsService",
            targetNamespace="http://example.org")

@WLHttpTransport(contextPath="servlet", serviceUri="HttpTransportUtils",
                 portName="HttpTransportUtilsPort")

public class HttpTransportUtilsImpl implements ServiceLifecycle {

  private ServletEndpointContext wsctx = null;

  public void init(Object context) throws ServiceException {
    System.out.println("ServletEndpointContext inited...");
    wsctx = (ServletEndpointContext)context;
  }

  public void destroy() {
    System.out.println("ServletEndpointContext destroyed...");
    wsctx = null;
  }

  @WebMethod()
  public String getServletRequestAndResponse() {

    HttpServletRequest request =
       HttpTransportUtils.getHttpServletRequest(wsctx.getMessageContext());
    HttpServletResponse response =
       HttpTransportUtils.getHttpServletResponse(wsctx.getMessageContext());

    System.out.println("HttpTransportUtils API used successfully.");
    return "HttpTransportUtils API used successfully";

  }

}

The important parts of the preceding example are as follows:

JWS Programming Best Practices

The following list provides some best practices when programming the JWS file: