When using the javax.annotation.Resource annotation to inject a Web Services context, specify the javax.annotation.Resource annotation in the following fields or methods of Web Services Implementation Class or Provider Implementation Class (including the parent Implementation Class). The operation is not guaranteed if you specify the javax.annotation.Resource annotation in the following fields or methods. Also, you can specify the annotation either in the following fields or in the setter method corresponding to these fields.

• javax.xml.ws.WebServiceContext type fields (excluding the static or final fields)
• The setter methods^# that use the javax.xml.ws.WebServiceContext type fields as arguments, and that are not to be published (excluding the static or final fields)
  

  #

  A non-public setter method or the javax.jws.WebMethod annotation for which the exclude element is true.

Further, when using the javax.annotation.Resource annotation to inject a Web Services context, you cannot specify any elements in the javax.annotation.Resource annotation. If you specify any element, the operation is not guaranteed.

The specification example of the javax.annotation.Resource annotation is as follows:

• Specifying the annotation in a field
  

  import javax.annotation.Resource; import javax.jws.WebService; import javax.servlet.ServletContext; import javax.xml.ws.handler.MessageContext; import javax.xml.ws.WebServiceContext; @WebService public class AddNumbersImpl { // Inject the information about the request that is currently being processed in the wsContext field @Resource private WebServiceContext wsContext; public int add(int number1, int number2) throws AddNumbersFault { // Acquire the message context MessageContext mContext = wsContext.getMessageContext(); // Acquire the properties ServletContext sContext = (ServletContext)mContext.get(MessageContext.SERVLET_CONTEXT); ... } ... }

• Specifying the annotation in the setter method
  

  import javax.annotation.Resource; import javax.jws.WebService; import javax.xml.ws.handler.MessageContext; import javax.xml.ws.WebServiceContext; @WebService public class AddNumbersImpl { // Inject the information about the request that is currently being processed in the wsContext field corresponding to the setter method private WebServiceContext wsContext; @Resource private void setWebServiceContext(WebServiceContext wsContext) { this.wsContext = wsContext; } public int add(int number1, int number2) throws AddNumbersFault { // Acquire the message context MessageContext mContext = wsContext.getMessageContext(); // Set the properties mContext.put("userPropKey", "userPropValue"); ... } ... }

This subsection describes the notes when adding a user-defined message context property:

(a) Adding a property in the service-side handler when inbounding

You can add the user-defined message context properties by using the service-side handler for inbounding. When referencing these properties from Web Services Implementation Class or Provider Implementation Class, you must first set the user- defined message context properties in the service-side handler and then use the setScope(java.lang.String name, MessageContext.Scope scope)method, which is an API of the javax.xml.ws.handler.MessageContext interface, for setting the user-defined properties as the APPLICATION scope.

For referencing the user-defined message context properties (added in the service-side handler) from the service-side handler when outbounding, set only the user-defined message context properties in the service-side handler. You need not set the scope by using the setScope(java.lang.String name, MessageContext.Scope scope)method. For the setScope(java.lang.String name, MessageContext.Scope scope)method, see 19.2.4(8) javax.xml.ws.handler.MessageContext interface.

The following example shows how to add the user-defined properties in the service-side handler when inbounding:

import javax.xml.ws.handler.MessageContext;
import javax.xml.ws.handler.soap.SOAPHandler;
import javax.xml.ws.handler.soap.SOAPMessageContext;
 
public class ServiceSOAPHandlerImpl implements SOAPHandler<SOAPMessageContext> {
 
    public boolean handleMessage(SOAPMessageContext smContext) {
        // Acquire the message direction
        boolean outbound = (boolean)smContext.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);
        if(outbound) {
           // Outbounding processes
           ...
        } else {
           // Inbounding processes
 
           // Specify the property key in ("userPropKey")
           // and a value in ("userPropValue")
           smContext.put("userPropKey", "userPropValue");
           // Set the property scope as the APPLICATION scope
           smContext.setScope("userPropKey", MessageContext.Scope.APPLICATION);
           ...
        }
        ...
    }
    ...
}

(b) Adding a property in Web Services Implementation Class or Provider Implementation Class

For referencing the user-defined message context properties that are added in Web Services Implementation Class or Provider Implementation Class from the service-side handler when outbounding, set only the user-defined message context properties in Web Services Implementation Class or Provider Implementation Class. Do not set the scope by using the setScope(java.lang.String name, MessageContext.Scope scope)method. The operation is not guaranteed if you use the setScope(java.lang.String name, MessageContext.Scope scope)method.