1. WebLogic Web Services Reference for Oracle WebLogic Server
  2. JWS Annotation Reference

3 JWS Annotation Reference

The WebLogic web services programming model uses the JDK metadata annotations feature, specified by JSR-175: A Metadata Facility for the JavaTM Programming Language, to provide a set of WebLogic-specific JWS annotations.

This chapter includes the following sections:

  • Overview of JWS Annotation Tags
    In the metadata annotations programming model, 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.
  • Web Services Metadata Annotations (JSR-181)
    Understand the standard JSR-181 annotations that you can use in your JWS file to specify the shape and behavior of your web service.
  • JAX-WS Annotations (JSR-224)
    Understand the JAX-WS (JSR-224) annotations that you can use in your JWS file to specify the shape and behavior of your web service.
  • JAXB Annotations (JSR-222)
    Understand the JAXB (JSR-222) annotations that you can use in your JWS file to specify the shape and behavior of your web service.
  • Jakarta Annotations (JSR-250)
    Understand the Jakarta Annotations for the Java Platform (JSR-250) that you can use in your JWS file to specify the shape and behavior of your web service.
  • WebLogic-Specific Annotations
    WebLogic web services define a set of JWS annotations that you can use to specify behavior and features in addition to the standard JSR-181 JWS annotations.

Overview of JWS Annotation Tags

In the metadata annotations programming model, 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 annotations to specify the shape and characteristics of the Web Service.

The JWS annotations that are supported vary based on the Web Service. The Web Service annotation support for JAX-WS are as follows:

You can target a JWS annotation at either the class-, method- or parameter-level in a JWS file. Some annotations can be targeted at more than one level, such as @SecurityRoles that can be targeted at both the class and method level.

The following example shows a simple JWS file that uses standard JSR-181, shown in bold: 

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 BasicStruct JavaBean
import examples.webservices.complex.BasicStruct;
// Standard JWS annotation that specifies that the portType name of the Web
// Service is "ComplexPortType", its public service name is "ComplexService",
// and the targetNamespace used in the generated WSDL is "http://example.org"
@WebService(serviceName="ComplexService", name="ComplexPortType",
            targetNamespace="http://example.org")
// Standard JWS annotation that specifies this is a document-literal-wrapped
// Web Service
@SOAPBinding(style=SOAPBinding.Style.DOCUMENT,
             use=SOAPBinding.Use.LITERAL,
             parameterStyle=SOAPBinding.ParameterStyle.WRAPPED)
/**
 * This JWS file forms the basis of a WebLogic Web Service.  The Web Services
 * has two public operations:
 *
 *  - echoInt(int)
 *  - echoComplexType(BasicStruct)
 *
 * The Web Service is defined as a "document-literal" service, which means
 * that the SOAP messages have a single part referencing an XML Schema element
 * that defines the entire body.
 *
*/
public class ComplexImpl {
  // 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: echoInt.
  //
  // The WebResult annotation specifies that the name of the result of the
  // operation in the generated WSDL is "IntegerOutput", rather than the
  // default name "return".   The WebParam annotation specifies that the input
  // parameter name in the WSDL file is "IntegerInput" rather than the Java
  // name of the parameter, "input".
  @WebMethod()
  @WebResult(name="IntegerOutput",
             targetNamespace="http://example.org/complex")
  public int echoInt(
      @WebParam(name="IntegerInput",
                targetNamespace="http://example.org/complex")
      int input)
  {
    System.out.println("echoInt '" + input + "' to you too!");
    return input;
  }
  // Standard JWS annotation to expose method "echoStruct" as a public operation
  // called "echoComplexType"
  // The WebResult annotation specifies that the name of the result of the
  // operation in the generated WSDL is "EchoStructReturnMessage",
  // rather than the default name "return".
  @WebMethod(operationName="echoComplexType")
  @WebResult(name="EchoStructReturnMessage",
             targetNamespace="http://example.org/complex")
  public BasicStruct echoStruct(BasicStruct struct)
  {
    System.out.println("echoComplexType called");
    return struct;
  }
}

The following sections describe the JWS annotations that are supported.

Parent topic: JWS Annotation Reference

Web Services Metadata Annotations (JSR-181)

Understand the standard JSR-181 annotations that you can use in your JWS file to specify the shape and behavior of your web service.

The following table lists these annotations, which are available with the javax.jws at https://jakarta.ee/specifications/web-services-metadata/2.1/apidocs/javax/jws/package-summary or javax.jws.soap package at https://jakarta.ee/specifications/web-services-metadata/2.1/apidocs/javax/jws/soap/package-summary and are described in more detail in the Jakarta Web Services Metadata (JSR-181) specification at http://www.jcp.org/en/jsr/detail?id=181.

Table 3-1 Standard JSR-181 JWS Annotations

This annotation . . . Specifies . . .

javax.jws.WebService

At the class level that the JWS file implements a Web Service. For more information, see Specifying that the JWS File Implements a Web Service (@WebService Annotation) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.jws.WebMethod

That a method of the JWS file should be exposed as a public operation of the Web Service. For more information, see Specifying That a JWS Method Be Exposed as a Public Operation (@WebMethod and @OneWay Annotations) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.jws.OneWay

That an operation not return a value to the calling application. For more information, see Specifying That a JWS Method Be Exposed as a Public Operation (@WebMethod and @OneWay Annotations) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.jws.WebParam

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. For more information, see Customizing the Mapping Between Operation Parameters and WSDL Elements (@WebParam Annotation) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.jws.WebResult

The mapping between the Web Service operation return value and the corresponding element of the generated WSDL file. For more information, see Customizing the Mapping Between the Operation Return Value and a WSDL Element (@WebResult Annotation) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.jws.HandlerChain

An external handler chain. For more information, see Creating and Using SOAP Message Handlers in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.jws.SOAPBinding

At the class level the SOAP bindings of the Web Service (such as, document-encoded or document-literal-wrapped). For more information, see Specifying the Mapping of the Web Service to the SOAP Message Protocol (@SOAPBinding Annotation) in Developing JAX-WS Web Services for Oracle WebLogic Server.

Parent topic: JWS Annotation Reference

JAX-WS Annotations (JSR-224)

Understand the JAX-WS (JSR-224) annotations that you can use in your JWS file to specify the shape and behavior of your web service.The following table summarizes these JAX-WS annotations, which are available with the javax.xml.ws package at https://javaee.github.io/metro-jax-ws/ and are described in more detail in JSR 224 (JAX-WS) Annotations at https://javaee.github.io/metro-jax-ws/doc/user-guide/ch03.html#jsr-224-jax-ws-annotations-outline.

Note:

The JAX-WS JWS annotations are relevant to JAX-WS web services only.

Table 3-2 JAX-WS (JSR-224) Annotations

This annotation . . . Specifies . . .

javax.xml.ws.Action

Whether to allow an explicit association of a WS-Addressing Action message addressing property with input, output, and fault messages of the mapped WSDL operation.

javax.xml.ws.BindingType

The binding to use for a Web Service implementation class. See Specifying the Binding Type to Use for an Endpoint (@BindingType Annotation) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.xml.ws.FaultAction

Whether to allow an explicit association of a WS-Addressing Action message addressing property with the fault messages of the WSDL operation mapped from the exception class. The @FaultAction annotation is used inside an @Action annotation.

javax.xml.ws.RequestWrapper

The request wrapper bean to be used at runtime for the methods in the endpoint interface.

javax.xml.ws.ResponseWrapper

The response wrapper bean to be used at runtime for the methods in the endpoint interface.

javax.xml.ws.ServiceMode

Whether a provider implementation works with the entire protocol message or with the payload only.

javax.xml.ws.WebEndpoint

The getPortName() methods of a generated service interface.

javax.xml.ws.WebFault

Service-specific exception classes to customize to the local and namespace name of the fault element and the name of the fault bean.

javax.xml.ws.WebServiceClient

A generated service interface.

javax.xml.ws.WebServiceProvider

A provider implementation class.

javax.xml.ws.WebServiceRef

A reference to a Web Service. See Defining a Web Service Reference Using the @WebServiceRef Annotation in Developing JAX-WS Web Services for Oracle WebLogic Server.

Parent topic: JWS Annotation Reference

JAXB Annotations (JSR-222)

Understand the JAXB (JSR-222) annotations that you can use in your JWS file to specify the shape and behavior of your web service.

The following table summarizes these JAXB annotations, which are available with the javax.xml.bind.annotation package at https://jakarta.ee/specifications/xml-binding/3.0/apidocs/jakarta.xml.bind/jakarta/xml/bind/annotation/package-summary. They are described in more detail in Customizing Java-to-XML Schema Mapping Using JAXB Annotations in Developing JAX-WS Web Services for Oracle WebLogic Server or in the JAXB (JSR-222) specification at http://jcp.org/en/jsr/detail?id=222).

Note:

The JAXB JWS annotations are relevant to JAX-WS Web Services only.

Table 3-3 JAXB Mapping Annotations (JSR-222)

This annotation . . . Specifies . . .

javax.xml.bind.annotation.XmlAccessorType

Whether fields or properties are serialized by default. See Specifying Default Serialization of Fields and Properties (@XmlAccessorType) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.xml.bind.annotation.XmlElement

That a property contained in a class be mapped to a local element in the XML schema complex type to which the containing class is mapped. See Mapping Properties to Local Elements (@XmlElement) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.xml.bind.annotation.XmlRootElement

That a top-level class be mapped to a global element in the XML schema that is used by the WSDL of the Web Service. See Mapping a Top-level Class to a Global Element (@XmlRootElement) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.xml.bind.annotation.XmlSeeAlso

The other classes to bind when binding the current class. See Binding a Set of Classes (@XmlSeeAlso) in Developing JAX-WS Web Services for Oracle WebLogic Server.

javax.xml.bind.annotation.XmlType

That a class or enum type be mapped to an XML Schema type. See Mapping a Value Class to a Schema Type (@XmlType) in Developing JAX-WS Web Services for Oracle WebLogic Server.

Parent topic: JWS Annotation Reference

Jakarta Annotations (JSR-250)

Understand the Jakarta Annotations for the Java Platform (JSR-250) that you can use in your JWS file to specify the shape and behavior of your web service. Each of these annotations are available with the javax.annotation package at https://jakarta.ee/specifications/annotations/1.3/apidocs/ and are described in more detail in the Jakarta Annotations for the Java Platform (JSR-250) specification at http://jcp.org/en/jsr/detail?id=250.

Table 3-4 Jakarta Annotations (JSR-250)

This annotation . . . Specifies . . .

javax.annotation.Resource

A resource that is needed by the application. This annotation may be applied to an application component class or to fields or methods of the component class.

javax.annotation.PostConstruct

A method that needs to be executed after dependency injection is done to perform initialization.

javax.annotation.PreDestroy

A callback notification om a method to signal that the instance is in the process of being removed by the container.

Parent topic: JWS Annotation Reference

WebLogic-Specific Annotations

WebLogic web services define a set of JWS annotations that you can use to specify behavior and features in addition to the standard JSR-181 JWS annotations. The following table summarizes the WebLogic-specific annotations supported for JAX-WS. Each annotation is described in more detail in the sections that follow.

Table 3-5 WebLogic-specific Annotations

This annotation . . . Specifies . .

com.oracle.webservices.api.jms.JMSTransportClient

That the web service client supports SOAP over JMS transport connection protocol.

com.oracle.webservices.api.jms.JMSTransportService

That the web service supports SOAP over JMS transport connection protocol.

weblogic.jws.Policies

An array of @weblogic.jws.Policy annotations.

weblogic.jws.Policy

That a WS-Policy file, which contains information about digital signatures, encryption, or Web Service reliable messaging, should be applied to the request or response SOAP messages.

weblogic.jws.security.WssConfiguration

The name of the Web Service security configuration you want the Web Service to use.

weblogic.wsee.jws.jaxws.owsm.Property

A policy configuration property override.

Use this annotation with the weblogic.wsee.jws.jaxws.owsm.SecurityPolicy annotation to override a configuration property when attaching a policy to a web service client.

weblogic.wsee.jws.jaxws.owsm.SecurityPolicies

An array of @weblogic.wsee.jws.jaxws.owsm.SecurityPolicies annotations.

weblogic.wsee.jws.jaxws.owsm.SecurityPolicy

That an Oracle Web Services Manager (OWSM) security policy be attached to the web service or client.

weblogic.wsee.jws.jaxws.owsm.SecurityPolicies

An array of @weblogic.jws.SecurityPolicy annotations.

weblogic.wsee.jws.jaxws.owsm.SecurityPolicy

That an Oracle Web Services Manager (Oracle WSM) WS-Policy file, which contains information about digital signatures or encryption, should be applied to the request or response SOAP messages.

weblogic.wsee.wstx.wsat.Transactional

Whether the annotated class or method runs inside of a web service atomic transaction.

Parent topic: JWS Annotation Reference

com.oracle.webservices.api.jms.JMSTransportClient

Target: Class

Enables and configures SOAP over JMS transport for JAX-WS web service clients.

Using SOAP over JMS transport, web services and clients communicate using JMS destinations instead of HTTP connections, offering the following benefits:

  • Reliability

  • Scalability

  • Quality of service

For more information about using SOAP over JMS transport, see Using SOAP Over JMS Transport as the Connection Protocol in Developing JAX-WS Web Services for Oracle WebLogic Server.

Attributes

Optionally, you can configure the following JMS transport properties using the @JMSTransportClient annotation. For a description of the properties, see Configuring JMS Transport Properties in Developing JAX-WS Web Services for Oracle WebLogic Server.

  • destinationName

  • destinationType

  • enabled

  • jmsHeaderProperty

  • jmsMessageProperty

  • jndiConnectionFactoryName

  • jndiContextParameters

  • jndiInitialContextFactory

  • jndiURL

  • messageType

  • priority

  • replyToName

  • targetService

  • timeToLive

Note:

You cannot use SOAP over JMS transport in conjunction with web services reliable messaging or streaming SOAP attachments, as described in Developing JAX-WS Web Services for Oracle WebLogic Server.

Example

The following sample snippet shows how to use the @JMSTransportClient annotation in a client file to enable SOAP over JMS transport. 

...
import javax.xml.ws.WebServiceClient;
import com.oracle.webservices.api.jms.JMSTransportClient;
...
@WebServiceClient(name = "WarehouseService", targetNamespace = "http://oracle.com/samples/", 
                  wsdlLocation="WarehouseService.wsdl")
@JMSTransportClient (
    destinationName="myQueue", 
    replyToName="myReplyToQueue",
    jndiURL="t3://localhost:7001",
    jndiInitialContextFactory="weblogic.jndi.WLInitialContextFactory" , 
    jndiConnectionFactoryName="weblogic.jms.ConnectionFactory" , 
    deliveryMode="PERSISTENT", timeToLive="1000", priority="1", 
    messageType="TEXT" 
)

public class WarehouseService  extends Service { ... }

Parent topic: WebLogic-Specific Annotations

com.oracle.webservices.api.jms.JMSTransportService

Target: Class

Enables and configures SOAP over JMS transport for JAX-WS web services.

Using SOAP over JMS transport, web services and clients communicate using JMS destinations instead of HTTP connections, offering the following benefits:

  • Reliability

  • Scalability

  • Quality of service

For more information about using SOAP over JMS transport, see Using SOAP Over JMS Transport as the Connection Protocol in Developing JAX-WS Web Services for Oracle WebLogic Server.

Note:

SOAP over JMS transport is not compatible with the following web service features: reliable messaging and HTTP transport-specific security.

Attributes

Optionally, you can configure JMS transport properties using the @JMSTransportService annotation. For a description of the properties, see Configuring JMS Transport Properties in Developing JAX-WS Web Services for Oracle WebLogic Server.

Example

The following sample snippet shows how to use the @JMSTransportService annotation in a JWS file to enable SOAP over JMS transport. The @ActivationConfigProperty is used to set service-side MDB configuration properties. 

import javax.jws.WebService;
import com.oracle.webservices.api.jms.JMSTransportService;
import com.sun.xml.ws.binding.SOAPBindingImpl;
import javax.ejb.ActivationConfigProperty;
@WebService(name="NotifyServicePortType", serviceName="NotifyService", 
   targetNamespace="http://examples.org/")
@JMSTransportService(destinationName="myQueue", 
   activationConfig = { 
      @ActivationConfigProperty(
         propertyName  = "destinationType", 
         propertyValue = "javax.jms.Topic"),
      @ActivationConfigProperty(
         propertyName  = "subscriptionDurability",
         propertyValue = "Durable"),
      @ActivationConfigProperty(propertyName  = "topicMessagesDistributionMode",
         propertyValue = "One-Copy-Per-Application")})
@BindingType(SOAPBindingImpl.SOAP11_JMS_BINDING)
public class NotifyServiceImpl {..}

Parent topic: WebLogic-Specific Annotations

weblogic.jws.Policies

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class, Method

Specifies an array of @weblogic.jws.Policy annotations.

Use this annotation if you want to attach more than one WS-Policy files to a class or method of a JWS file. If you want to attach just one WS-Policy file, you can use the @weblogic.jws.Policy on its own.

This JWS annotation does not have any attributes.

Parent topic: weblogic.jws.Policies

Example
@Policies({
    @Policy(uri="policy:firstPolicy.xml"),
    @Policy(uri="policy:secondPolicy.xml")
  })

Parent topic: weblogic.jws.Policies

weblogic.jws.Policy

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class, Method

Specifies that a WS-Policy file, which contains information about digital signatures, encryption, or Web Service reliable messaging, should be applied to the request or response SOAP messages.

This annotation can be used on its own to apply a single WS-Policy file to a class or method. If you want to apply more than one WS-Policy file to a class or method, use the @weblogic.jws.Policies annotation to group them together.

If this annotation is specified at the class level, the indicated WS-Policy file or files are applied to every public operation of the Web Service. If the annotation is specified at the method level, then only the corresponding operation will have the WS-Policy file applied.

By default, WS-Policy files are applied to both the request (inbound) and response (outbound) SOAP messages. You can change this default behavior with the direction attribute.

Also by default, the specified WS-Policy file is attached to the generated and published WSDL file of the Web Service so that consumers can view all the WS-Policy requirements of the Web Service. Use the attachToWsdl attribute to change this default behavior.

Parent topic: weblogic.jws.Policy

Attributes

Table 3-6 Attributes of the weblogic.jws.Policy JWS Annotation Tag

Name Description Data Type Required?

uri

Specifies the location from which to retrieve the WS-Policy file.

Use the http: prefix to specify the URL of a WS-Policy file on the Web.

Use the policy: prefix to specify that the WS-Policy file is packaged in the Web Service archive file or in a shareable Jakarta EE library of WebLogic Server, as shown in the following example:

@Policy(uri="policy:MyPolicyFile.xml")

If you are going to publish the WS-Policy file in the Web Service archive, the WS-Policy XML file must be located in either the META-INF/policies or WEB-INF/policies directory of the EJB JAR file (for EJB implemented Web Services) or WAR file (for Java class implemented Web Services), respectively.

For information on publishing the WS-Policy file in a library, see Creating Shared Jakarta EE Libraries and Optional Packages in Developing Applications for Oracle WebLogic Server.

String

Yes

direction

Specifies when to apply the policy: on the inbound request SOAP message, the outbound response SOAP message, or both (default).

Valid values for this attribute are:

  • Policy.Direction.both

  • Policy.Direction.inbound

  • Policy.Direction.outbound

The default value is Policy.Direction.both.

enum

No

attachToWsdl

Specifies whether the WS-Policy file should be attached to the WSDL that describes the Web Service.

Valid values are true and false. Default value is false.

boolean

No

Parent topic: weblogic.jws.Policy

Example
  @Policy(uri="policy:myPolicy.xml", 
          attachToWsdl=true, 
          direction=Policy.Direction.outbound)

Parent topic: weblogic.jws.Policy

weblogic.jws.security.WssConfiguration

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class

Specifies the name of the Web Service security configuration you want the Web Service to use. If you do not specify this annotation in your JWS file, the Web Service is associated with the default security configuration (called default_wss) if it exists in your domain.

The @WssConfiguration annotation only makes sense if your Web Service is configured for message-level security (encryption and digital signatures). The security configuration, associated to the Web Service using this annotation, specifies information such as whether to use an X.509 certificate for identity, whether to use password digests, the keystore to be used for encryption and digital signatures, and so on.

WebLogic Web Services are not required to be associated with a security configuration; if the default behavior of the Web Services security runtime is adequate then no additional configuration is needed. If, however, a Web Service requires different behavior from the default (such as using an X.509 certificate for identity, rather than the default user name/password token), then the Web Service must be associated with a security configuration.

For general information about message-level security, see Configuring Message-Level Security in Securing WebLogic Web Services for Oracle WebLogic Server.

Note:

All WebLogic Web Services packaged in a single Web Application must be associated with the same security configuration when using the @WssConfiguration annotation. This means, for example, that if a @WssConfiguration annotation exists in all the JWS files that implement the Web Services contained in a given Web Application, then the value attribute of each @WssConfiguration must be the same.

To specify that more than one Web Service be contained in a single Web Application when using the jwsc Ant task to compile the JWS files into Web Services, group the corresponding <jws> elements under a single <module> element.

Attributes

Table 3-7 Attributes of the weblogic.jws.security.WssConfiguration JWS Annotation Tag

Name Description Data Type Required?

value

Specifies the name of the Web Service security configuration that is associated with this Web Service. The default configuration is called default_wss.

String

Yes
Example

The following example shows how to specify that a Web Service is associated with the my_security_configuration security configuration; only the relevant Java code is shown: 

package examples.webservices.wss_configuration;
import javax.jws.WebService;
...
import weblogic.jws.security.WssConfiguration;
@WebService(...
...
@WssConfiguration(value="my_security_configuration")
public class WssConfigurationImpl {
...

weblogic.wsee.jws.jaxws.owsm.Property

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class

Specifies a policy configuration property override.

Use this annotation with the weblogic.wsee.jws.jaxws.owsm.SecurityPolicy annotation to override a configuration property when attaching a policy to a web service client.

Note:

This annotation can be used for web service clients only. It is not supported for web service (server-side) policy attachment.

See Attaching Policies to Java EE Web Services and Clients Using Annotations in Securing Web Services and Managing Policies with Oracle Web Services Manager for detailed information and examples of using this annotation.

This JWS annotation does not have any attributes.

Example
@SecurityPolicy(uri="policy:oracle/wss10_message_protection_client_policy", 
          properties = { 
             @Property(name="keystore.recipient.alias", value="mykey")
          })

weblogic.wsee.jws.jaxws.owsm.SecurityPolicies

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class

Specifies an array of @weblogic.wsee.jws.jaxws.owsm.SecurityPolicies annotations.

Use this annotation if you want to attach more than one OWSM security policy to the class of a JWS file. If you want to attach just one OWSM security policy, you can use the @weblogic.wsee.jws.jaxws.owsm.SecurityPolicy annotation.

See Attaching Policies to Java EE Web Services and Clients Using Annotations in Securing Web Services and Managing Policies with Oracle Web Services Manager for detailed information and examples of using this annotation.

This JWS annotation does not have any attributes.

Example
@SecurityPolicies({
    @SecurityPolicy(uri="oracle/wss_saml20_token_over_sll_service_policy"),
    @SecurityPolicy(uri="oracle/binding_authorization_permitall_policy")
  })

weblogic.wsee.jws.jaxws.owsm.SecurityPolicy

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class

Attaches an OWSM security policy file to the web service or client.

This annotation can be used on its own to apply a single OWSM security policy to a class. If you want to attach more than one OWSM security policy to a class, use the @weblogic.wsee.jws.jaxws.owsm.SecurityPolicies annotation to group them together.

See Attaching Policies to Java EE Web Services and Clients Using Annotations in Securing Web Services and Managing Policies with Oracle Web Services Manager for detailed information and examples of using this annotation.

Attributes

Table 3-8 Attributes of the weblogic.wsee.jws.jaxws.owsm.SecurityPolicy JWS Annotation Tag

Name Description Data Type Required?

uri

Specifies the name of the OWSM security policy.

Use the policy: prefix to specify that the OWSM policy is packaged in the OWSM policy repository, as shown in the following example:

@SecurityPolicy(uri="policy:oracle/wss_saml20_token_over_ssl_service_policy")

For more information about the OWSM repository, see Managing the OWSM Repository in Securing Web Services and Managing Policies with Oracle Web Services Manager.

String

Yes

properties

Note: This attribute can be specified for web service clients only. This attribute is not supported for web service (server-side) policy attachment.

Specifies policy configuration override information. You specify one or more configuration property values using the weblogic.wsee.jws.jaxws.owsm.Property annotation, as described in weblogic.wsee.jws.jaxws.owsm.Property.

String

No

enabled

Specifies whether the OWSM policy file is enabled.

Valid values are true and false. Default value is true.

boolean

No
Examples

The following example shows how to attach the wss_saml20_token_over_ssl_service_policy to a web service. 

@SecurityPolicy(uri="policy:oracle/wss_saml20_token_over_ssl_service_policy", 
          enabled=true)

The following example shows how to attach the wss10_message_protection_client_policy to a web service client and override the keystore.recipient.alias configuration property. 

@SecurityPolicy(uri="policy:oracle/wss10_message_protection_client_policy", 
          properties = { 
             @Property(name="keystore.recipient.alias", value="mykey")
          },
          enabled=true)

weblogic.wsee.jws.jaxws.owsm.SecurityPolicies

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class, Method

Specifies an array of @weblogic.wsee.jws.jaxws.owsm.SecurityPolicy annotations.

Use this annotation if you want to attach more than one Oracle Web Services Manager (Oracle WSM) WS-Policy files to a class or method of a JWS file. If you want to attach just one Oracle WSM WS-Policy file, you can use the @weblogic.wsee.jws.jaxws.owsm.SecurityPolicy on its own.

See Using Oracle Web Service Security Policies in Securing WebLogic Web Services for Oracle WebLogic Server for detailed information and examples of using this annotation.

This JWS annotation does not have any attributes.

Example
@SecurityPolicies({
    @SecurityPolicy(uri="policy:firstPolicy.xml"),
    @SecurityPolicy(uri="policy:secondPolicy.xml")
  })

weblogic.wsee.jws.jaxws.owsm.SecurityPolicy

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class, Method

Specifies that an Oracle Web Services Manager (Oracle WSM) WS-Policy file, which contains information about digital signatures or encryption, should be applied to the request or response SOAP messages.

This annotation can be used on its own to apply a single Oracle WSM WS-Policy file to a class or method. If you want to apply more than one Oracle WSM WS-Policy file to a class or method, use the @weblogic.wsee.jws.jaxws.owms.SecurityPolicies annotation to group them together.

This annotation can be applied at the class level only, indicating that the Oracle WSM WS-Policy file or files are applied to every public operation of the Web Service.

The Oracle WSM WS-Security policies are not advertised in the WSDL of a WebLogic Server JAX-WS Web service. (Typically, the policy file associated with a Web service is attached to its WSDL, which the Web services client runtime reads to determine whether and how to digitally sign and encrypt the SOAP message request from an operation invoke from the client application.)

See Using Oracle Web Service Security Policies in Securing WebLogic Web Services for Oracle WebLogic Server for detailed information and examples of using this annotation.

Attribute

Table 3-9 Attribute of the weblogic.jws.SecurityPolicy JWS Annotation Tag

Name Description Data Type Required?
uri

Specifies the location from which to retrieve the Oracle WSM WS-Policy file.

Use the http: prefix to specify the URL of an Oracle WSM WS-Policy file on the Web.

Use the policy: prefix to specify that the Oracle WSM WS-Policy file is packaged in the Web Service archive file or in a shareable Jakarta EE library of WebLogic Server, as shown in the following example:

@SecurityPolicy(uri= "policy:oracle/wss10_username_token_with_message_protection_server_policy")

String

Yes
Example
@SecurityPolicy(uri=
"policy:oracle/wss10_username_token_with_message_protection_server_policy")

weblogic.wsee.wstx.wsat.Transactional

The following sections describe the annotation in detail.

Parent topic: WebLogic-Specific Annotations

Description

Target: Class, Method

Specifies whether the annotated class or method runs inside of a web service atomic transaction.

If you specify the @Transactional annotation at the web service class level, the settings apply to all two-way synchronous methods defined by the service endpoint interface. You can override the flow type value at the method level; however, the version must be consistent across the entire transaction.

WebLogic web services enable interoperability with other external transaction processing systems, such as WebSphere, JBoss, Microsoft .NET, and so on, through the support of the following specifications:

Attributes

Table 3-10 Attribute of the weblogic.wsee.wstx.wsat.Transactional Annotation

Name Description Data Type Required?

version

Version of the web services atomic transaction coordination context that is used for web services and clients. For clients, it specifies the version used for outbound messages only. The value specified must be consistent across the entire transaction.

Valid values include WSAT10, WSAT11, WSAT12, and DEFAULT. The DEFAULT value for web services is all three versions (driven by the inbound request); the DEFAULT value for web service clients is WSAT10.

For example:

@Transactional(version=Transactional.Version.WSAT10])

String

No

value

Whether the web service atomic transaction coordination context is passed with the transaction flow. For valid values, see Table 3-11.

String

No

The following table summarizes the valid values for flow type and their meaning on the web service and client. The table also summarizes the valid value combinations when configuring web service atomic transactions for an EJB-style web service that uses the @TransactionAttribute annotation.

Table 3-11 Flow Types Values

Value Web Service Client Web Service Valid EJB @TransactionAttribute Values

NEVER

Do not export transaction coordination context.

Do not import transaction coordination context.

NEVER, NOT_SUPPORTED, REQUIRED, REQUIRES_NEW, SUPPORTS

SUPPORTS (Default)

Export transaction coordination context if transaction is available.

Import transaction coordination context if available in the message.

REQUIRED, SUPPORTS

MANDATORY

Export transaction coordination context. An exception is thrown if there is no active transaction.

Import transaction coordination context. An exception is thrown if there is no active transaction.

MANDATORY, REQUIRED, SUPPORTS
Example
@Transactional(value = Transactional.TransactionFlowType.SUPPORTS,
     version="Transactional.Versino.WSAT12