Fusion Middleware Documentation
Advanced Search


Securing Web Services and Managing Policies with Oracle Web Services Manager
Close Window

Table of Contents

Show All | Collapse

A Security and Policy Annotation Reference

This appendix describes the Web service security and policy annotations that are available to secure and enable advanced features on Oracle Web services.

The Web Services programming model uses the JDK metadata annotations at http://docs.oracle.com/javase/7/docs/technotes/guides/language/annotations.html feature (specified by JSR-175 at http://www.jcp.org/en/jsr/detail?id=175). In this programming model, you create an annotated Java file to specify the shape and characteristics of the Web service. For more information about the annotations available, see Java API Reference for Oracle Infrastructure Web Services. For more information about the OWSM predefined policies, see Chapter 18, "Predefined Policies".

Table A-1 summarizes the Web service security and policy annotations described in this appendix. This table also lists the corresponding Web service Feature class that can be used to attach policies to a subset of Web service clients, as described in "Attaching Policies to Web Services and Clients at Design Time".

Table A-1 Security and Policy Annotations for Oracle Web Services

Annotation Description

@Addressing

Specifies the use of WS-Addressing with either the SOAP 1.1/HTTP or SOAP 1.2/HTTP binding.

@AtomicTransaction

Enables Web services atomic transactions.

@CacheBinaryContent

Enables and configures binary caching of content.

@CallbackManagementPolicy

Attaches a management policy when sending the asynchronous response to the client callback service.

@CallbackMtomPolicy

Attaches an MTOM policy when sending the asynchronous response to the client callback service.

@CallbackPolicySet

Attaches one or more policy sets to the callback client of the asynchronous Web service that will connect to the callback service.

@CallbackSecurityPolicy

Attaches a security policy when sending the asynchronous response to the client callback service.

@FastInfosetCallbackClient

Enables and configures Fast Infoset on callback client of the asynchronous Web service that will connect to the callback service.

@FastInfosetService

Enables Fast Infoset on a Web service.

@JMSTransportClient

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

@JMSTransportService

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

@ManagementPolicy

Attaches a management policy to the Web service.

@MaxRequestSize

Configures the maximum size, in bytes, of the request message that can be sent to the Web service.

@MEXRequestProcessingService

Enables the exchange of metadata.

@MTOM

Enables the use of Message Transmission Optimization Mechanism (MTOM) on the Web service.

@MTOMEncodeFaultService

Enables the creation of MTOM-enabled SOAP fault messages when MTOM is enabled.

@MtomPolicy

Attaches an MTOM policy to the Web service.

@Persistence

Configures the secure conversation session persistence mechanism for the Web service.

@PolicyReference

Attaches a single policy to a subject, and optionally overrides configuration property values.

@PolicySet

Defines a set of policy references, and optionally overrides unscoped configuration property values.

@POXHttpBindingService

Enables an endpoint to receive non-SOAP XML messages that are processed by a user defined javax.xml.ws.Provider<T>.invoke method.

@Property

Specifies a single property that can be used to override the configuration of one or more policies.

@ReliabilityPolicy

Attaches the oracle/wsrm10_policy or oracle/wsrm10_policy reliable messaging policies to the Web service.

@ReliableMessaging

Attaches the oracle/reliable_messaging_policy policy to the Web service

@RequestProcessingService

Enables the Web service endpoint.

@SchemaValidation

Enables validation of request messages against the schema.

@SecurityPolicies (Oracle Infrastructure Web Services)

Specifies an array of oracle.webservices.annotations.SecurityPolicy annotations.

@SecurityPolicies (Java EE Web Services)

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

@SecurityPolicy (Oracle Infrastructure Web Services)

Attaches a security policy to the request or response SOAP message.

@SecurityPolicy (Java EE Web Services)

Attaches a security policy to the request or response SOAP message.

@SOAPRequestProcessingService

Enables the processing of SOAP requests on a Web service endpoint.

@TestPageProcessingService

Enables the Web Service Test Client.

@WSDLRequestProcessingService

Enables the WSDL for the Web service.

@WSLoggingLevel

Sets the logging level for diagnostic logs for the Web service endpoint.


A.1 @Addressing

The javax.xml.ws.soap.Addressing annotation specifies the use of WS-Addressing with either the SOAP 1.1/HTTP or SOAP 1.2/HTTP binding.

Attributes

The following table defines the attributes that can be passed to the javax.xml.ws.soap.Addressing annotation.

Table A-2 Attributes for javax.xml.ws.soap.Addressing Annotation

Attribute Description Default

enabled

Boolean value that specifies whether the endpoint supports WS-Addressing.

true

required

Boolean value that specifies whether WS-Addressing headers are required to be present on the incoming message.

false

responses

Value that specifies whether the endpoint requires the use of anonymous, non-anonymous, or all types of responses. Valid values, defined by javax.xml.ws.soap.AddressingFeature.Responses, include:

  • ALL

  • ANONYMOUS

  • NON_ANONYMOUS

ALL


Example

@Addressing(
    enabled = true,
    required = true,
    responses = AddressingFeature.Responses.ALL
)

A.2 @AtomicTransaction

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.tx.at.AtomicTransaction annotation enables Web services atomic transactions. For more information, see "Using Web Services Atomic Transactions" in Developing Oracle Infrastructure Web Services.

Attributes

The following table defines the attributes that can be passed to the com.oracle.webservices.api.tx.at.AtomicTransaction annotation.

Table A-3 Attributes for com.oracle.webservices.api.tx.at.AtomicTransaction Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the feature is enabled.

true

flowType

Whether the Web services atomic transaction coordination context is passed with the transaction flow.

Valid values, defined by com.oracle.webservices.api.tx.at.AtomicTransactionFlowType, include:

  • MANDATORY

  • NEVER

  • SUPPORTS

For more information about the valid values, see "Configuring Web Service Atomic Transactions" in Developing Oracle Infrastructure Web Services.

SUPPORTS

version

Version of the Web services atomic transaction coordination context that is supported for the SOA service or reference. For SOA references, it specifies the version used for outbound messages only. The value specified must be consistent across the entire transaction.

Valid values, defined by com.oracle.webservices.api.tx.at.AtomicTransactionVersion, include:

  • DEFAULT

  • WSAT10

  • WSAT11

  • WSAT12

For more information about the valid values, see "Configuring Web Service Atomic Transactions" in Developing Oracle Infrastructure Web Services.

DEFAULT


Example

@AtomicTransaction(
    enabled=true,
    flowType = AtomicTransactionFlowType.MANDATORY,
    version= AtomicTransactionVersion.DEFAULT)

A.3 @CacheBinaryContent

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.CacheBinaryContent annotation enables and configures binary caching of content.

Attributes

The following table defines the attributes that can be passed to the com.oracle.webservices.api.CacheBinaryContent annotation.

Table A-4 Attributes for com.oracle.webservices.api.CacheBinaryContent Annotation

Attribute Description Default

arg1

Boolean value that defines one of the following values:

  • If mode is set to BINARY, this argument is not required.

  • If mode is set to FILE, specifies the directory in which to store the temporary files as arg1.

  • If mode is set to BLOB, specifies the URL of the DBMS connection.

"java.io.tmpdir"

enabled

Boolean value that specifies whether or not the feature is enabled.

true

mode

Value that specifies the runtime requirements of XTI scalable DOM in OraSAAJ. Valid values, defined by com.oracle.webservcies.api.CacheBinaryContentMode, include:

  • BINARY—Fastest method, but most memory intensive. Not recommended for production.

  • FILE—Recommended method. Specifies one temporary file per document. Need to specify the directory in which to store the temporary files as arg1.

  • BLOB—Slowest method. Need to specify the URL of the DBMS connection as arg1.

BINARY


Example

@CacheBinaryContent(
    enabled=true,
    mode= CacheBinaryContentMode.FILE,
    arg1="/mytempdir")

A.4 @CallbackManagementPolicy

Note:

This annotation has been deprecated. Oracle recommends that you use the oracle.wsm.metadata.annotation.CallbackPolicySet annotation, as described in "@CallbackPolicySet".

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.CallbackManagementPolicy annotation attaches a management policy when sending the asynchronous response to the client callback service.

This annotation is applicable to asynchronous Web service implementation classes that are annotated with the oracle.webservices.annotations.async.AsyncWebService annotation, as described in "Developing an Asynchronous Web Service" in Developing Oracle Infrastructure Web Services.

Attributes

The following table defines the attributes that can be passed to the oracle.webservices.annotations.async.CallbackManagementPolicy annotation.

Table A-5 Attributes for oracle.webservices.annotations.async.CallbackManagementPolicy Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

value

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 policy repository.

""


Example

@CallbackManagementPolicy(
    value="oracle/log_policy",
    enabled = true
)

A.5 @CallbackMtomPolicy

Note:

This annotation has been deprecated. Oracle recommends that you use the oracle.wsm.metadata.annotation.CallbackPolicySet annotation, as described in "@CallbackPolicySet".

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.async.CallbackMtomPolicy annotation attaches an MTOM policy when sending the asynchronous response to the client callback service.

This annotation is applicable to asynchronous Web service implementation classes that are annotated with the oracle.webservices.annotations.async.AsyncWebService annotation, as described in "Developing an Asynchronous Web Service" in Developing Oracle Infrastructure Web Services.

Attributes

The following table defines the attributes that can be passed to the oracle.webservices.annotations.async.CallbackMtomPolicy annotation.

Table A-6 Attributes for oracle.webservices.annotations.async.CallbackMtomPolicy Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

value

Location from which to retrieve the MTOM policy file. Use the http: prefix to specify the URL of a MTOM policy file on the Web. Use the policy: prefix to specify that the MTOM policy file is packaged in the policy repository.

""


Example

@CallbackMtomPolicy(
    value="oracle/wsmtom_policy",
    enabled = true
)

A.6 @CallbackPolicySet

Note:

This annotation applies to Oracle Infrastructure Web services only.

The oracle.wsm.metadata.annotation.CallbackPolicySet annotation defines a set of policy references for the callback service, and optionally overrides unscoped configuration property values.

Attributes

The following table defines the attributes that can be passed to the oracle.wsm.metadata.annotation.CallbackPolicySet annotation.

Table A-7 Attributes for oracle.wsm.metadata.annotation.CallbackPolicySet Annotation

Attribute Description Default

properties

List of oracle.wsm.metadata.annotation.Property annotations that define configuration override property values.

""

references

List of oracle.wsm.metadata.annotation.PolicyReference annotations that define policies to attach to the subject.

""


Example

@CallbackPolicySet(references = { 
   @PolicyReference("oracle/wss_http_token_service_policy")
}

A.7 @CallbackSecurityPolicy

Note:

This annotation has been deprecated. Oracle recommends that you use the oracle.wsm.metadata.annotation.CallbackPolicySet annotation, as described in "@CallbackPolicySet".

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.async.CallbackSecurityPolicy annotation attaches a security policy when sending the asynchronous response to the client callback service.

This annotation is applicable to asynchronous Web service implementation classes that are annotated with the oracle.webservices.annotations.async.AsyncWebService annotation, as described in "Developing an Asynchronous Web Service" in Developing Oracle Infrastructure Web Services.

Attributes

The following table summarizes the attributes that you can pass to the oracle.webservices.annotations.async.CallbackSecurityPolicy annotation.

Table A-8 Attributes for oracle.webservices.annotations.async.CallbackSecurityPolicy Annotation

Attribute Description Default

enabled

Optional. Boolean value that specifies whether the policy is enabled.

true

Properties

Optional. Array of property value-name pairs.

""

value

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 policy repository.

""


Example

@CallbackSecurityPolicy(value=
    "policy:oracle/wss10_username_token_with_message_protection_server_policy"),

A.8 @FastInfosetCallbackClient

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.FastInfosetCallbackClient annotation enables and configures Fast Infoset on the callback client of the asynchronous Web service that will connect to the callback service.

For more information about developing asynchronous Web services and callback clients, see "Developing Asynchronous Web Services" in Developing Oracle Infrastructure Web Services. For more information about Fast Infoset, see "Optimizing XML Transmission Using Fast Infoset" in Developing Oracle Infrastructure Web Services.

Attributes

The following table defines the attributes that can be passed to the com.oracle.webservices.api.FastInfosetCallbackClient annotation.

Table A-9 Attributes for com.oracle.webservices.api.FastInfosetCallbackClient Annotation

Attribute Description Default
fastInfosetContentNegotiation

Content negotiation strategy. Valid values, defined by com.oracle.webservices.api.FastInfosetContentNegotiationStrategy, include:

  • OPTIMISTIC—Assumes that Fast Infoset is enabled on the service. All requests will be sent using Fast Infoset.

  • PESSIMISTIC—Initial request from client is sent without Fast Infoset enabled, but with an HTTP Accept header that indicates that the client supports the Fast Infoset capability. If the service response is in Fast Infoset format, confirming that Fast Infoset is enabled on the service, then subsequent requests from the client will be sent in Fast Infoset format.

  • NONE—Client requests will not use Fast Infoset.

For more information, see:

NONE

enabled

Boolean value that specifies whether or not the feature is enabled.

true


Example

@FastInfosetCallbackClient(
    enable=true,
    fastInfosetContentNegotiation=FastInfosetContentNegotiationType.OPTIMISTIC
)

A.9 @FastInfosetService

The com.oracle.webservices.api.FastInfosetService annotation enables Fast Infoset on the Web service.

For more information about Fast Infoset, see:

Attribute

The following table defines the attribute that can be passed to the com.oracle.webservices.api.FastInfosetService annotation.

Table A-10 Attribute for com.oracle.webservices.api.FastInfosetService Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the feature is enabled.

true


Example

@FastInfosetService(
    enable=true
)

A.10 @JMSTransportClient

The com.oracle.webservices.api.jms.JMSTransportClient annotation enables and configures SOAP over JMS transport for Oracle Infrastructure and JAX-WS (Java EE) 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" 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.

For Oracle Infrastructure Web services, SOAP over JMS transport is not compatible with asynchronous Web services.

Attributes

For information about the attributes that you can configure using the @JMSTransportClient annotation, see "Configuring JMS Transport Properties" in Developing JAX-WS Web Services for Oracle WebLogic Server.

Example

@JMSTransportClient (
    destinationName="myQueue", 
    replyToName="myReplyToQueue",
    jndiURL="t3://localhost:7001",
    jndiInitialContextFactory="weblogic.jndi.WLInitialContextFactory", 
    jndiConnectionFactoryName="weblogic.jms.ConnectionFactory", 
    timeToLive=1000, priority=1, 
    messageType=TEXT 
)

A.11 @JMSTransportService

The com.oracle.webservices.api.jms.JMSTransportService annotation enables and configures SOAP over JMS transport for Oracle Infrastructure and JAX-WS (Java EE) 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" 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.

For Oracle Infrastructure Web services, SOAP over JMS transport is not compatible with asynchronous Web services.

Attributes

For information about the attributes that you can configure using the @JMSTransportService annotation, see "Configuring JMS Transport Properties" in Developing JAX-WS Web Services for Oracle WebLogic Server.

Example

@JMSTransportService(destinationName="myQueue", 
   activationConfig = { 
      @ActivationConfigProperty(
         propertyName  = "destinationType", 
         propertyValue = "TOPIC"),
      @ActivationConfigProperty(
         propertyName  = "subscriptionDurability",
         propertyValue = "Durable"),
      @ActivationConfigProperty(propertyName  = "topicMessagesDistributionMode",
         propertyValue = "One-Copy-Per-Application")})

A.12 @ManagementPolicy

Note:

This annotation has been deprecated. Oracle recommends that you use the oracle.wsm.metadata.annotation.PolicyReference annotation, as described in "@PolicyReference".

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.ManagementPolicy annotation attaches a management policy to the Web service.

Attributes

The following table defines the attributes that can be passed to the oracle.webservices.annotations.ManagementPolicy annotation.

Table A-11 Attributes for oracle.webservices.annotations.ManagementPolicy Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

value

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 policy repository.

""


Example

@ManagementPolicy(
    value="oracle/log_policy",
    enabled = true
)

A.13 @MaxRequestSize

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.MaxRequestSize annotation enables you to configure the maximum size, in bytes, of the request message that can be sent to the Web service.

Attributes

The following table defines the attributes that can be passed to the com.oracle.webservices.api.MaxRequestSize annotation.

Table A-12 Attributes for com.oracle.webservices.api.MaxRequestSize Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

maxRequestSize

Maximum size of the request message, in bytes. -1 indicates that there is no limit to the size of the message.

-1


Example

@MaxRequestSize(
    maxRequestSize=-1,
    enabled = true
)

A.14 @MEXRequestProcessingService

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.MEXRequestProcessingService annotation enables the exchange of Web service metadata.

Attribute

The following table defines the attribute that can be passed to the com.oracle.webservices.api.MEXRequestProcessingService annotation.

Table A-13 Attribute for com.oracle.webservices.api.MEXRequestProcessingService Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true


Example

@MEXRequestProcessingService(
    enabled = true
)

A.15 @MTOM

The javax.xml.ws.soap.MTOM annotation enables the use of Message Transmission Optimization Mechanism (MTOM) on the Web service. MTOM defines a method for optimizing the transmission of XML data of type xs:base64Binary or xs:hexBinary in SOAP messages.

For more information, see:

Attribute

The following table defines the attribute that can be passed to the javax.xml.ws.soap.MTOM annotation.

Table A-14 Attribute for javax.xml.ws.soap.MTOM Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not MTOM is enabled.

true


Example

@MTOM(
    enabled = true
)

A.16 @MTOMEncodeFaultService

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.MTOMEncodeFaultService annotation enables the creation of MTOM-enabled SOAP fault messages when MTOM is enabled.

Attribute

The following table defines the attribute that can be passed to the com.oracle.webservices.api.MTOMEncodeFaultService annotation.

Table A-15 Attribute for com.oracle.webservcies.api.MTOMEncodeFaultService Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not MTOM is enabled.

true


Example

@MTOMEncodeFaultService(
    enabled = true
)

A.17 @MtomPolicy

Note:

This annotation has been deprecated. Oracle recommends that you use the oracle.wsm.metadata.annotation.PolicyReference annotation, as described in "@PolicyReference".

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.MtomPolicy annotation attaches an MTOM policy to the Web service.

Attributes

The following table defines the attributes that can be passed to the oracle.webservices.annotations.MtomPolicy annotation.

Table A-16 Attributes for oracle.webservices.annotations.MtomPolicy Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

value

Location from which to retrieve the MTOM policy file. Use the http: prefix to specify the URL of a MTOM policy file on the Web. Use the policy: prefix to specify that the MTOM policy file is packaged in the policy repository.

""


Example

@MtomPolicy(
    value="oracle/wsmtom_policy",
    enabled = true
)

A.18 @Persistence

Note:

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.Persistence annotation configures the secure conversation session persistence mechanism for the Web service.

Attributes

The following table defines the attributes that can be passed to the oracle.webservices.annotations.Persistence annotation.

Table A-17 Attributes for oracle.webservices.annotations.Persistence Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

providerName

Identifies the persistence provider registered in the system. Possible values are:

  • oracle:jrf:Memory is the in-memory-based persistence provider.

  • oracle:jrf:Coherence is the integrated Coherence provider.

oracle:jrf:Coherence when the consumer of the policy (Web service or client) is running in a WebLogic Server environment

oracle:jrf:Memory when the consumer of the policy is running in a standalone JVM environment


Example

@PortableWebService
@SecurityPolicy("oracle/wss11_username_token_with_message_protection_wssc_service_policy") 
@Persistence(providerName="oracle:jrf:Coherence") 
 
public class TestService {
 ...... 
}

A.19 @PolicyReference

Note:

This annotation applies to Oracle Infrastructure Web services only.

The oracle.wsm.metadata.annotation.PolicyReference annotation attaches a single policy to a subject, and optionally overrides configuration property values.

Attributes

The following table defines the attributes that can be passed to the oracle.wsm.metadata.annotation.PolicyReference annotation.

Table A-18 Attributes for oracle.wsm.metadata.annotation.PolicyReference Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

properties

List of oracle.wsm.metadata.annotation.Property annotations that define configuration override property values.

""

value

Location from which to retrieve the MTOM policy file. Use the http: prefix to specify the URL of a MTOM policy file on the Web. Use the policy: prefix to specify that the MTOM policy file is packaged in the policy repository.

""


Example

@PolicyReference(
    value = "oracle/binding_permission_authorization_policy",
    properties = { 
        @Property(
            name="resource",
            value="com.sun.jersey.samples.helloworld.resources.MyApplication"),
        @Property(
            name="action",
            value="")
    }
)

A.20 @PolicySet

Note:

This annotation applies to Oracle Infrastructure Web services only.

The oracle.wsm.metadata.annotation.PolicySet annotation defines a set of policy references for the Web service, and optionally overrides unscoped configuration property values.

Attributes

The following table defines the attributes that can be passed to the oracle.wsm.metadata.annotation.PolicySet annotation.

Table A-19 Attributes for oracle.wsm.metadata.annotation.PolicySet Annotation

Attribute Description Default

properties

List of oracle.wsm.metadata.annotation.Property annotations that define configuration override property values.

""

references

List of oracle.wsm.metadata.annotation.PolicyReference annotations that define policies to attach to the subject.

""


Example

@PolicySet(references = { 
   @PolicyReference("oracle/wss_http_token_service_policy")
}

A.21 @POXHttpBindingService

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.POXHttpBindingService annotation enables an endpoint to receive non-SOAP XML messages that are processed by a user defined javax.xml.ws.Provider<T>.invoke method.

Attribute

The following table defines the attribute that can be passed to the com.oracle.webservices.api.POXHttpBindingService annotation.

Table A-20 Attribute for com.oracle.webservcies.api.POXHttpBindingService Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not MTOM is enabled.

true


Example

@MTOMEncodeFaultService(
    enabled = true
)

A.22 @Property

Note:

This annotation applies to Oracle Infrastructure Web services only.

The oracle.wsm.metadata.annotation.Property annotation defines a single property that can be used to override the configuration of one or more policies.

Attributes

The following table defines the attributes that can be passed to the oracle.wsm.metadata.annotation.Property annotation.

Table A-21 Attributes for oracle.wsm.metadata.annotation.Property Annotation

Attribute Description Default

properties

List of oracle.wsm.metadata.annotation.Property annotations that define unscoped configuration override property values.

""

references

List of oracle.wsm.metadata.annotation.PolicyReference annotations that define policies to attach to the subject.

""


Example

@PolicyReference(
    value = "oracle/binding_permission_authorization_policy",
    properties = { 
        @Property(
            name="resource",
            value="com.sun.jersey.samples.helloworld.resources.MyApplication"),
        @Property(
            name="action",
            value="")
    }
)

A.23 @ReliabilityPolicy

Note:

This annotation has been deprecated. Oracle recommends that you use the com.oracle.webservices.api.rm.ReliableMessaging annotation, as described in "@ReliableMessaging".

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.ReliabilityPolicy annotation attaches the oracle/wsrm10_policy or oracle/wsrm10_policy reliable messaging policies to the Web service.

Attributes

The following table defines the attributes that can be passed to the oracle.webservices.annotations.ReliabilityPolicy annotation.

Table A-22 Attributes for oracle.webservices.annotations.ReliabilityPolicy Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

value

Location from which to retrieve the reliable messaging policy file. Use the http: prefix to specify the URL of a reliable messaging policy file on the Web. Use the policy: prefix to specify that the reliable messaging policy file is packaged in the policy repository.

""


Example

@ReliabilityPolicy(
       value="oracle/wsrm11_policy",
       enabled = true)

A.24 @ReliableMessaging

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.rm.ReliableMessaging annotation attaches the oracle/reliable_messaging_policy policy to the Web service.

Attributes

The following table defines the attributes that can be passed to the oracle.webservices.annotations.ReliableMessaging annotation.

Table A-23 Attributes for oracle.webservices.annotations.ReliableMessaging Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

value

Location from which to retrieve the reliable messaging policy file. Use the http: prefix to specify the URL of a reliable messaging policy file on the Web. Use the policy: prefix to specify that the reliable messaging policy file is packaged in the policy repository.

""


Example

@ReliableMessaging(
       value="oracle/reliable_messaging_policy",
       enabled = true)

A.25 @RequestProcessingService

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.RequestProcessingService annotation enables the Web service endpoint to process incoming requests.

Attribute

The following table defines the attribute that can be passed to the oracle.webservices.annotations.RequestProcessingService annotation.

Table A-24 Attribute for oracle.webservices.annotations.RequestProcessingService Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true


Example

@RequestProcessingService(
       enabled = true)

A.26 @SchemaValidation

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.SchemaValidation annotation enables the validation of request messages against the schema.

Attribute

The following table defines the attributes that can be passed to the oracle.webservices.annotations.SchemaValidation annotation.

Table A-25 Attribute for oracle.webservices.annotations.SchemaValidation Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true


Example

@SchemaValidation(
       enabled = true)

A.27 @SecurityPolicies (Oracle Infrastructure Web Services)

Note:

This annotation has been deprecated. Oracle recommends that you use the oracle.wsm.metadata.annotation.PolicySet annotation, as described in "@PolicySet".

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.SecurityPolicies annotation specifies an array of oracle.webservices.annotations.SecurityPolicy annotations. Use this annotation if you want to attach more than one WS-Policy files to a class.

For example:

@SecurityPolicies({
   @SecurityPolicy(uri=
    "policy:oracle/wss10_username_token_with_message_protection_server_policy"),
   @SecurityPolicy(uri="policy:oracle/authorization_policy")

A.28 @SecurityPolicies (Java EE Web Services)

Note:

This annotation applies to Java EE Web services only.

The weblogic.wsee.jws.jaxws.owsm.SecurityPolicies annotation specifies an array of weblogic.wsee.jws.jaxws.owsm.SecurityPolicy annotations. Use this annotation if you want to attach more than one WS-Policy files to a class.

Example

@SecurityPolicies({
   @SecurityPolicy(uri=
    "policy:oracle/wss10_username_token_with_message_protection_server_policy"),
   @SecurityPolicy(uri="policy:oracle/authorization_policy")

A.29 @SecurityPolicy (Oracle Infrastructure Web Services)

Note:

This annotation has been deprecated. Oracle recommends that you use the oracle.wsm.metadata.annotation.PolicyReference annotation, as described in "@PolicyReference".

This annotation applies to Oracle Infrastructure Web services only.

The oracle.webservices.annotations.SecurityPolicy annotation attaches a security policy to the request or response SOAP message. This annotation can be used on its own to apply a single WS-Policy file to a class. If you want to apply more than one WS-Policy file to a class, use the @SecurityPolicies annotation to group them together.

Attributes

The following table summarizes the attributes that you can pass to the oracle.webservices.annotations.SecurityPolicy annotation.

Table A-26 Attributes for oracle.webservices.annotations.SecurityPolicy Annotation

Attribute Description Default

enabled

Optional. Boolean value that specifies whether the policy is enabled.

true

Properties

Optional. Array of property value-name pairs.

""

value

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 policy repository.

""


Example

@SecurityPolicy(value=
    "policy:oracle/wss10_username_token_with_message_protection_server_policy"),

A.30 @SecurityPolicy (Java EE Web Services)

Note:

This annotation applies to Java EE Web services only.

The weblogic.wsee.jws.jaxws.owsm.SecurityPolicy annotation attaches a security policy to the request or response SOAP message. This annotation can be used on its own to apply a single WS-Policy file to a class. If you want to apply more than one WS-Policy file to a class, use the @SecurityPolicies annotation to group them together.

Attributes

The following table summarizes the attributes that you can pass to the weblogic.wsee.jws.jaxws.owsm.SecurityPolicy annotation.

Table A-27 Attributes for weblogic.wsee.jws.jaxws.owsm.SecurityPolicy Annotation

Attribute Description Default

enabled

Optional. Boolean value that specifies whether the policy is enabled.

true

uri

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 policy repository.

""


Example

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

A.31 @SOAPRequestProcessingService

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.SOAPRequestProcessingService annotation enables the processing of SOAP requests on a Web service endpoint.

Attribute

The following table defines the attribute that can be passed to the oracle.webservices.annotations.SOAPRequestProcessingService annotation.

Table A-28 Attribute for oracle.webservices.annotations.SOAPRequestProcessingService Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true


Example

@SOAPRequestProcessingService(
       enabled = true)

A.32 @TestPageProcessingService

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.TestPageProcessingService annotation enables the Web Service Test Client, as described in "Using the Web Services Test Client" in Administering Web Services.

Note:

The procedures described in this section do not impact the availability of the Web Services Test link on the Web Service Endpoint page, which enables you to access the Fusion Middleware Control Test Web Service page. For more information, see "Using the Test Web Service Page in Fusion Middleware Control" in Administering Web Services.

Attribute

The following table defines the attribute that can be passed to the oracle.webservices.annotations.TestPageProcessingService annotation.

Table A-29 Attribute for oracle.webservices.annotations.TestPageProcessingService Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true


Example

@TestPageProcessingService(
       enabled = true)

A.33 @WSDLRequestProcessingService

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.WSDLRequestProcessingService annotation enables access to the WSDL for the Web service.

Attribute

The following table defines the attribute that can be passed to the oracle.webservices.annotations.WSDLRequestProcessingService annotation.

Table A-30 Attribute for oracle.webservices.annotations.WSDLRequestProcessingService Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true


Example

@WSDLRequestProcessingService(
       enabled = true)

A.34 @WSLoggingLevel

Note:

This annotation applies to Oracle Infrastructure Web services only.

The com.oracle.webservices.api.WSLoggingLevel annotation sets the logging level for diagnostic logs for the Web service endpoint.

Attributes

The following table defines the attributes that can be passed to the oracle.webservices.annotations.WSLoggingLevel annotation.

Table A-31 Attribute for oracle.webservices.annotations.WSLoggingLevel Annotation

Attribute Description Default

enabled

Boolean value that specifies whether or not the policy is enabled.

true

loggingLevel

Defines the logging level. Valid values include: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, or NULL.

""


Example

@WSLoggingLevel(
       enabled = true,
       loggingLevel=INFO
)