1. WebLogic Web Services Reference for Oracle WebLogic Server
  2. WebLogic Web Service Deployment Descriptor Schema Reference

7 WebLogic Web Service Deployment Descriptor Schema Reference

The WebLogic equivalent to the standard Java EE webservices.xml deployment descriptor file is called weblogic-webservices.xml. This file contains WebLogic-specific information about a WebLogic web service, such as the URL used to invoke the deployed web service, configuration settings such as timeout values, and so on.

Overview of weblogic-webservices.xml

The standard Java EE deployment descriptor for web services is called webservices.xml. This file specifies the set of web services that are to be deployed to WebLogic Server and the dependencies they have on container resources and other services. See the web services XML Schema at http://java.sun.com/xml/ns/j2ee/j2ee_web_services_1_1.xsd for a full description of this file.

For the XML Schema file that describes the weblogic-webservices.xml deployment descriptor, see http://xmlns.oracle.com/weblogic/weblogic-webservices/1.1/weblogic-webservices.xsd.

Both deployment descriptor files are located in the same location on the Java EE archive that contains the web service. In particular:

  • For Java class-implemented web services, the web service is packaged as a Web application WAR file and the deployment descriptors are located in the WEB-INF directory.

  • For stateless session EJB-implemented web services, the web service is packaged as an EJB JAR file and the deployment descriptors are located in the META-INF directory.

The structure of the weblogic-webservices.xml file is similar to the structure of the Java EE webservices.xml file in how it lists and identifies the web services that are contained within the archive. For example, for each web service in the archive, both files have a <webservice-description> child element of the appropriate root element (<webservices> for the Java EE webservices.xml file and <weblogic-webservices> for the weblogic-webservices.xml file)

This section is published for informational purposes only. Typically, configuration updates are made using the WebLogic Server Administration Console or using JWS annotations and you will not need to edit either of the deployment descriptor files directly.

Note:

The data type definitions of two elements in the weblogic-webservices.xml file (login-config and transport-guarantee) are imported from the Java EE Schema for the web.xml file. See the Servlet Deployment Descriptor Schema at http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd for details about these elements and data types.

Example of a weblogic-webservices.xml Deployment Descriptor File

Learn about the deployment elements that are contained within the weblogic-webservices.xml deployment descriptor. 

<?xml version='1.0' encoding='UTF-8'?>
<weblogic-webservices
   xmlns="http://xmlns.oracle.com/weblogic/weblogic-webservices">
  <webservice-description>
   <webservice-description-name>MyService</webservice-description-name>
    <port-component>
      <port-component-name>MyServiceServicePort</port-component-name>
      <service-endpoint-address>
        <webservice-contextpath>/MyService</webservice-contextpath>
        <webservice-serviceuri>/MyService</webservice-serviceuri>
      </service-endpoint-address>
      <wsat-config>
        <version>WSAT10</version>
        <flowType>SUPPORTS</flowType>
      </wsat-config>
      <reliability-config>
        <inactivity-timeout>P0DT600S</inactivity-timeout>
        <base-retransmission-interval>P0DT3S</base-retransmission-interval>
        <retransmission-exponential-backoff>true
        </retransmission-exponential-backoff>
        <acknowledgement-interval>P0DT3S</acknowledgement-interval>
        <sequence-expiration>P1D</sequence-expiration>
        <buffer-retry-count>3</buffer-retry-count>
        <buffer-retry-delay>P0DT5S</buffer-retry-delay>
      </reliability-config>
    </port-component>
  </webservice-description>
</weblogic-webservices>

Element Descriptions

The configuration elements specified in the weblogic-webservices.xml deployment descriptor are arranged in a specific hierarchy. The hierarchy is shown below. The number of occurrences allowed of each element is identified within braces after the element name. Each element is described in detail in the sections that follow. 
<weblogic-webservices> {1}
   <webservice-description> {1 or more}
      <webservice-description-name> {1 or more}
      <webservice-type> {0 or 1}
      <wsdl-publish-file {0 or 1}
      <port-component> {0 or more}
         <port-component-name> {1}
         <service-endpoint-address> {0 or 1}
            <webservice-contextpath> {1}
            <webservice-serviceuri> {1}
         <auth-constraint> {0 or 1}
         <login-config> {0 or 1}
         <transport-guarantee> {0 or 1}
         <deployment-listener-list> {0 or 1}
            <deployment-listener> {1 or more}
         <wsdl> {0 or 1}
            <exposed> {1}
         <transaction-timeout> {0 or 1}
         <callback-protocol> {1}
         <stream-attachments> {0 or 1}
         <validate-request> {0 or 1}
         <http-flush-response> {0 or 1}
         <http-response-buffersize> {0 or 1}
         <reliability-config> {0 or 1}
            <customized> {0 or 1}
            <inactivity-timeout> {0 or 1}
            <base-retransmission-interval> {0 or 1}
            <retransmission-exponential-backoff> {0 or 1}
            <non-buffered-source> {0 or 1}
            <acknowledgement-interval> {0 or 1}
            <sequence-expiration> {0 or 1}
            <buffer-retry-count> {0 or 1}
            <buffer-retry-delay> {0 or 1}
            <non-buffered-destination> {0 or 1}
            <messaging-queue-jndi-name> {0 or 1}
            <messaging-queue-mdb-run-as-principal-name> {0 or 1}
         <persistence-config> {0 or 1}
            <customized> {0 or 1}
            <default-logical-store-name> {0 or 1}
         <buffering-config> {0 or 1}
            <customized> {0 or 1}
            <request-queue> {0 or 1}
               <name> {0 or 1}
               <enabled> {0 or 1}
               <connection-factory-jndi-name> {0 or 1}
               <transaction-enabled> {0 or 1}
            <response-queue> {0 or 1}
               <name> {0 or 1}
               <enabled> {0 or 1}
               <connection-factory-jndi-name> {0 or 1}
               <transaction-enabled> {0 or 1}
            <retry-count> {0 or 1}
            <retry-delay> {0 or 1}
         <wsat-config> {0 or 1}
            <version> {0 or 1}
            <flowType> {0 or 1}
         <operation> {0 or more}
            <name> {0 or 1}
            <wsat-config> {0 or 1}
               <version> {0 or 1}
               <flowType> {0 or 1}
         <soapjms-service-endpoint-address> {0 or 1}
            <lookup-variant> {0 or 1}
            <destination-name> {0 or 1}
            <destination-type> {0 or 1}
            <jndi-connection-factory-name> {0 or 1}
            <jndi-initial-context-factory> {0 or 1}
            <jndi-url> {0 or 1}
            <jndi-context-parameter> {0 or 1}
            <time-to-live> {0 or 1}
            <priority> {0 or 1}
            <delivery-mode> {0 or 1}
            <reply-to-name> {0 or 1}
            <target-service> {0 or 1}
            <binding-version> {0 or 1}
            <message-type> {0 or 1}
            <enable-http-wsdl-access> {0 or 1}
            <run-as-principal> {0 or 1}
            <run-as-role> {0 or 1}
            <mdb-per-destination> {0 or 1}
            <activation-config> {0 or 1}
      <fastinfoset> {0 or 1}
      <logging-level> {0 or 1}
   <webservice-security> {0 or 1}
      <mbean-name> {1}

acknowledgement-interval

The <acknowledgement-interval> child element of the <reliability-config> element specifies the maximum interval during which the destination endpoint must transmit a stand-alone acknowledgement.

This value must be a positive value and conform to the XML schema duration lexical format, as follows:

PnYnMnDTnHnMS

Table 7-1 describes the duration format fields. This value defaults to P0DT3S (3 seconds).

Table 7-1 Duration Format Description

Field Description

nY

Number of years (n).

nM

Number of months (n).

nD

Number of days (n).

T

Date and time separator.

nH

Number of hours (n).

nM

Number of minutes (n).

nS

Number of seconds (n).

See Configuring the Acknowledgement Interval in Developing JAX-WS Web Services for Oracle WebLogic Server.

activation-config

The <activation-config> child element of the <soapjms-service-endpoint-address> element specifies activation configuration properties passed to the JMS provider. Each property is specified using name-value pairs, separated by semicolons (;). For example: name1=value1;...;nameN=valueN

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server. For a list of valid activation properties, see Configuring JMS Transport Properties in Developing JAX-WS Web Services for Oracle WebLogic Server.

auth-constraint

The <auth-constraint> element defines the user roles that are permitted access to this resource collection.

The XML Schema data type of the <j2ee:auth-constraint> element is <j2ee:auth-constraintType>, and is defined in the Java EE Schema that describes the standard web.xml deployment descriptor. For the full reference information, see http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd.

base-retransmission-interval

The <base-retransmission-interval> child element of the <reliability-config> element specifies the interval of time that must pass before a message is retransmitted to the RM destination. This element can be used in conjunction with the <retransmission-exponential-backoff> element to specify the algorithm that is used to adjust the retransmission interval.

If a destination endpoint does not acknowledge a sequence of messages for the time interval specified by <base-retransmission-interval>, the exponential backoff algorithm is used for timing successive retransmissions by the source endpoint, should the message continue to go unacknowledged.

This value must be a positive value and conform to the XML schema duration lexical format, as follows:

PnYnMnDTnHnMS

Table 7-1 describes the duration format fields. This value defaults to P0DT3S (3 seconds).

See Configuring the Base Retransmission Interval in Developing JAX-WS Web Services for Oracle WebLogic Server.

binding-version

The <binding-version> child element of the <soapjms-service-endpoint-address> element defines the version of the SOAP JMS binding. This value must be set to 1.0 for this release, which equates to org.jvnet.ws.jms.JMSBindingVersion.SOAP_JMS_1_0. This value maps to the SOAPJMS_bindingVersion JMS message property.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

buffer-retry-count

The <buffer-retry-count> child element of the <reliability-config> element specifies the number of times that the JMS queue on the destination WebLogic Server instance attempts to deliver the message from a client that invokes the reliable operation to the web service implementation. This value defaults to 3.

See Using Web Services Reliable Messaging in Developing JAX-WS Web Services for Oracle WebLogic Server.

buffer-retry-delay

The <buffer-retry-delay> child element of the <reliability-config> element specifies the amount of time that elapses between message delivery retry attempts. The retry attempts are between the client's request message on the JMS queue and delivery of the message to the web service implementation.

This value must be a positive value and conform to the XML schema duration lexical format, as follows:

PnYnMnDTnHnMS

Table 7-1 describes the duration format fields.This value defaults to P0DT5S (5 seconds).

See Using Web Services Reliable Messaging in Developing JAX-WS Web Services for Oracle WebLogic Server.

buffering-config

The <buffering-config> element groups together the buffering configuration elements. The child elements of the <buffering-config> element specify runtime configuration values such as retry counts and delays.

See Configuring Message Buffering for Web Services in Developing JAX-WS Web Services for Oracle WebLogic Server.

callback-protocol

The <callback-protocol> child element of the <port-component> element specifies the protocol used for callbacks to notify clients of an event. Valid values include: http, https, or jms.

connection-factory-jndi-name

The <connection-factory-jndi-name> child element of the <request-queue> and <response-queue> elements specifies the JNDI name of the connection factory to use for request and response message buffering, respectively.

See Configuring Message Buffering for Web Services in Developing JAX-WS Web Services for Oracle WebLogic Server.

customized

The <customized> child element of the <reliability-config>, <persistence-config>, and <buffering-config> is a Boolean flag that specifies whether the configuration has been customized.

default-logical-store-name

The <default-logical-store-name> child element of the <persistence-config> element defines the name of the default logical store.

See Managing Web Service Persistence in Developing JAX-WS Web Services for Oracle WebLogic Server.

delivery-mode

The <delivery-mode> child element of the <soapjms-service-endpoint-address> element specifies the delivery mode indicating whether the request message is persistent. Valid values are org.jvnet.ws.jms.DeliveryMode.PERSISTENT and org.jvnet.ws.jms.DeliveryMode.NON_PERSISTENT. This value defaults to PERSISTENT.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

deployment-listener-list

For internal use only.

deployment-listener

For internal use only.

destination-name

The <destination-name> child element of the <soapjms-service-endpoint-address> element defines the name of the destination queue or topic. This value defaults to com.oracle.webservices.jms.RequestQueue.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

destination-type

The <destination-type> child element of the <soapjms-service-endpoint-address> element defines the destination type. Valid values are org.jvnet.ws.jms.JMSDestinationType.QUEUE or org.jvnet.ws.jms.JMSDestinationType.TOPIC. This value defaults to QUEUE.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

enable-http-wsdl-access

The <enable-http-wsdl-access> child element of the <soapjms-service-endpoint-address> element is a Boolean value that specifies whether to publish the WSDL through HTTP.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

enabled

The <enabled> child element of the <request-queue> and <response-queue> elements specifies whether request and response message buffering is enabled, respectively.

See Configuring Message Buffering for Web Services in Developing JAX-WS Web Services for Oracle WebLogic Server.

exposed

The <exposed> child element of the <wsdl> element is a boolean attribute indicating whether the WSDL should be exposed to the public when the web service is deployed.

fastinfoset

The <fastinfoset> child element of the <port-component> element is a Boolean flag that specifies whether Fast Infoset is supported for the web service port component.

See Using Fast Infoset in Developing JAX-WS Web Services for Oracle WebLogic Server.

flowType

The <flowtype> child element of the <wsat-config> element specifies Whether the web service atomic transaction coordination context is passed with the transaction flow. Valid values include: NEVER, SUPPORTS, and MANDATORY. The value defaults to SUPPORTS.

For complete details on the valid values and their meanings, and valid value combinations when configuring web service atomic transactions for an EJB-style web service that uses the @TransactionAttribute annotation, see the Flow Type Values table in Enabling Web Services Atomic Transactions on Web Services in Developing JAX-WS Web Services for Oracle WebLogic Server.

http-flush-response

The <http-flush-response> child element of the <port-component> element specifies whether or not you want to flush the reliable response. This value defaults to true.

http-response-buffersize

The <http-response-buffersize> child element of the <port-component> element specifies the size of the reliable response buffer that is used to cache the request on the server. This value defaults to 0.

inactivity-timeout

The <inactivity-timeout> child element of the <reliability-config> element specifies an inactivity interval. If, during the specified interval, an endpoint (RM source or RM destination) has not received application or control messages, the endpoint may consider the RM sequence to have been terminated due to inactivity.

This value must be a positive value and conform to the XML schema duration lexical format, as follows:

PnYnMnDTnHnMnS

Table 7-1 describes the duration format fields. This value defaults to P0DT600S (600 seconds).

See Configuring Inactivity Timeout in Developing JAX-WS Web Services for Oracle WebLogic Server.

jndi-connection-factory-name

The <jndi-connection-factory-name> child element of the <soapjms-service-endpoint-address> element defines the JNDI name of the connection factory that is used to establish a JMS connection. This value defaults to com.oracle.webservices.jms.ConnectionFactory.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

jndi-context-parameter

The <jndi-context-parameter> child element of the <soapjms-service-endpoint-address> element defines additional JNDI environment properties. Each property is specified using name-value pairs, separated by semicolons (;). For example: name1=value1;...;nameN=valueN.

JNDI properties. Each property is specified using name-value pairs, separated by semicolons (;). For example: name1=value1;...;nameN=valueN.

This property can be specified more than once. Each occurrence of the jndiContextParameter property specifies a JNDI property name-value pair to be added to the java.util.Hashtable sent to the InitialContext constructor for the JNDI provider.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

jndi-initial-context-factory

The <jndi-initial-connection-factory> child element of the <soapjms-service-endpoint-address> element defines the name of the initial context factory class used for JNDI lookup. This value defaults to weblogic.jndi.WLInitialContextFactory.

This value maps to the java.naming.factory.initial property.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

jndi-url

The <jndi-url> child element of the <soapjms-service-endpoint-address> element defines the JNDI provider URL. This value maps to the java.naming.provider.url property. This value defaults to t3://localhost:7001.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

logging-level

The <logging-level> child element of the <port-component> element sets the logging level for the port component. Valid values include: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL, and OFF.

login-config

The <j2ee:login-config> element specifies the authentication method that should be used, the realm name that should be used for this application, and the attributes that are needed by the form login mechanism.

The XML Schema data type of the <j2ee:login-config> element is <j2ee:login-configType>, and is defined in the Java EE Schema that describes the standard web.xml deployment descriptor. For the full reference information, see http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd.

lookup-variant

The <lookup-variant> child element of the <soapjms-service-endpoint-address> element defines the method used for looking up the specified destination name. This value must be set to jndi to support SOAP over JMS transport.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

mbean-name

The <mbean-name> child element of the <webservice-security> element specifies the name of the web service security configuration (specifically an instantiation of the WebserviceSecurityMBean) that is associated with the web services described in the deployment descriptor file. The default configuration is called default_wss.

The associated security configuration 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.

You must create the security configuration (even the default one) using the WebLogic Server Administration Console before you can successfully invoke the web service.

Note:

The web service security configuration described by this element applies to all web services contained in the weblogic-webservices.xml file. The jwsc Ant task always packages a web service in its own JAR or WAR file, so this limitation is not an issue if you always use the jwsc Ant task to generate a web service. However, if you update the weblogic-webservices.xml deployment descriptor manually and add additional web service descriptions, you cannot associate different security configurations to different services.

mdb-per-destination

The <mdb-per-destination> child element of the <soapjms-service-endpoint-address> element is a Boolean value that specifies whether to create one listening message-driven bean (MDB) for each requested destination. This value defaults to true.

If set to false, one listening MDB is created for each web service port, and that MDB cannot be shared by other ports.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

message-type

The <message-type> child element of the <soapjms-service-endpoint-address> element specifies message type to use with the request message. A value of BYTES indicates the javax.jms.BytesMessage object is used. A value of TEXT indicates javax.jms.TextMessage object is used. This value defaults to BYTES.

The web service uses the same message type when sending the response. If the request is received as a BYTES, the reply will be sent as a BYTES.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

messaging-queue-jndi-name

The <messaging-queue-jndi-name> child element of the <reliability-config> element specifies the JNDI name of the destination queue or topic.

See Using Web Services Reliable Messaging in Developing JAX-WS Web Services for Oracle WebLogic Server.

messaging-queue-mdb-run-as-principal-name

The <messaging-queue-mdb-run-as-principal-name> child element of the <reliability-config> element specifies the principal used to run the listening MDB.

See Using Web Services Reliable Messaging in Developing JAX-WS Web Services for Oracle WebLogic Server.

name

The <name> child element of the <operation> element defines the name of the web service operation.

non-buffered-destination

The <non-buffered-destination> child element of the <reliability-config> element is a Boolean value that specifies whether to disable message buffering on a particular destination server to control whether buffering is used when receiving messages.

See Configuring a Non-buffered Destination for a Web Service in Developing JAX-WS Web Services for Oracle WebLogic Server.

non-buffered-source

The <non-buffered-source> child element of the <reliability-config> element is a Boolean value that specifies whether to disable message buffering on a particular source server to control whether buffering is used when delivering messages. This value should always be set to false; message buffering should always be enabled on the source server.

See Configuring a Non-buffered Destination for a Web Service in Developing JAX-WS Web Services for Oracle WebLogic Server.

operation

The <operation> element defines characteristics of a web service operation. The child elements of the <operation> element defines the name and configuration options of the web service operation.

persistence-config

The <persistence-config> element groups together the persistence configuration elements. The child elements of the <persistence-config> element specify the default logical store.

See Managing Web Service Persistence in Developing JAX-WS Web Services for Oracle WebLogic Server.

port-component

The <port-component> element is a container of other elements used to describe a web service port. The child elements of the <port-component> element specify WebLogic-specific characteristics of the web service port, such as the context path and service URI used to invoke the web service after it has been deployed to WebLogic Server.

port-component-name

The <port-component-name> child element of the <port-component> element specifies the internal name of the WSDL port. The value of this element must be unique for all <port-component-name> elements within a single weblogic-webservices.xml file.

priority

The <priority> child element of the <soapjms-service-endpoint-address> element defines the JMS priority associated with the request and response message. Specify this value as a positive Integer from 0, the lowest priority, to 9, the highest priority. This value defaults to 0).

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

reliability-config

The <reliability-config> element groups together the reliable messaging configuration elements. The child elements of the <reliability-config> element specify runtime configuration values such as retransmission and timeout intervals for reliable messaging.

See Using Web Services Reliable Messaging in Developing JAX-WS Web Services for Oracle WebLogic Server.

reply-to-name

The <reply-to-name> child element of the <soapjms-service-endpoint-address> element defines the JNDI name of the JMS destination to which the response message is sent.

For a two-way operation, a temporary response queue is generated by default. Using the default temporary response queue minimizes the configuration that is required. However, in the event of a server failure, the response message may be lost. This property enables the client to use a previously defined, "permanent" queue or topic rather than use the default temporary queue or topic, for receiving replies.

The value maps to the JMSReplyTo JMS header in the request message.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

request-queue

The <request-queue> child element of the <buffering-config> element. defines the JNDI name of the connection factory to use for request message buffering. This value defaults to the default JMS connection factory defined by the server.

See Configuring the Request Queue in Developing JAX-WS Web Services for Oracle WebLogic Server.

response-queue

The <response-queue> child element of the <buffering-config> element. defines the JNDI name of the connection factory to use for response message buffering. This value defaults to the default JMS connection factory defined by the server.

See Configuring the Response Queue in Developing JAX-WS Web Services for Oracle WebLogic Server.

retransmission-exponential-backoff

The <retransmission-exponential-backoff> child element of the <reliability-config> element is a boolean attribute that specifies whether the message retransmission interval will be adjusted using the exponential backoff algorithm. This element is used in conjunction with the <base-retransmission-interval> element.

If a destination endpoint does not acknowledge a sequence of messages for the time interval specified by <base-retransmission-interval>, the exponential backoff algorithm is used for timing successive retransmissions by the source endpoint, should the message continue to go unacknowledged.

This value defaults to false—the same retransmission interval is used in successive retries, rather than the interval increasing exponentially.

See Configuring the Retransmission Exponential Backoff in Developing JAX-WS Web Services for Oracle WebLogic Server.

retry-count

The <retry-count> child element of the <buffering-config> element. defines the number of times that the JMS queue on the invoked WebLogic Server instance attempts to deliver the message to the web service implementation until the operation is successfully invoked. This value defaults to 3.

See Configuring Message Retry Count and Delay in Developing JAX-WS Web Services for Oracle WebLogic Server.

retry-delay

The <retry-delay> child element of the <buffering-config> element. defines the number of times that the JMS queue on the invoked WebLogic Server instance attempts to deliver the message to the web service implementation until the operation is successfully invoked. This value defaults to 3.

Amount of time between retries of a buffered request and response. Note, this value is only applicable when RetryCount is greater than 0.

This value must be a positive value and conform to the XML schema duration lexical format, as follows:

PnYnMnDTnHnMS

Table 7-1 describes the duration format fields. This value defaults to P0DT30S (30 seconds).

See Configuring Message Retry Count and Delay in Developing JAX-WS Web Services for Oracle WebLogic Server.

run-as-principal

The <run-as-principal> child element of the <soapjms-service-endpoint-address> element defines the principal used to run the listening MDB.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

run-as-role

The <run-as-role> child element of the <soapjms-service-endpoint-address> element defines the role used to run the listening MDB.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

sequence-expiration

The <sequence-expiration> child element of the <reliability-config> element specifies the expiration time for a sequence regardless of activity.

This value must be a positive value and conform to the XML schema duration lexical format, as follows:

PnYnMnDTnHnMS

Table 7-1 describes the duration format fields. This value defaults to P1D (1 day).

See Configuring the Sequence Expiration in Developing JAX-WS Web Services for Oracle WebLogic Server.

service-endpoint-address

The <service-endpoint-address> element groups the WebLogic-specific context path and service URI values that together make up the web service endpoint address, or the URL that invokes the web service after it has been deployed to WebLogic Server.

These values are specified with the <webservice-contextpath> and <webservice-serviceuri> child elements.

soapjms-service-endpoint-address

The <soapjms-service-endpoint-address> element groups the configuration properties for SOAP over JMS transport.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

stream-attachments

The <stream-attachments> child element of the <port-component> element is a boolean value that specifies whether the WebLogic web services runtime uses streaming APIs when reading the parameters of all methods of the web service. This increases the performance of web service operation invocation, in particular when the parameters are large, such as images.

You cannot use this annotation if you are also using the following features in the same web service:

  • Conversations

  • Reliable Messaging

  • JMS Transport

  • A proxy server between the client application and the web service it invokes

target-service

The <target-service> child element of the <soapjms-service-endpoint-address> element defines the port component name of the web service. This value is used by the service implementation to dispatch the service request. If not specified, the service name from the WSDL or @javax.jms.WebService annotation is used.

This value maps to the SOAPJMS_targetService JMS message property.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

time-to-live

The <time-to-live> child element of the <soapjms-service-endpoint-address> element defines the lifetime, in milliseconds, of the request message. A value of 0 indicates an infinite lifetime. If not specified, the JMS-defined default value (180000) is used.

On the service side, timeToLive also specifies the expiration time for each MDB transaction.

See Using SOAP Over JMS Transport in Developing JAX-WS Web Services for Oracle WebLogic Server.

transport-guarantee

The j2ee:transport-guarantee element specifies the type of communication between the client application invoking the web service and WebLogic server.

Valid values include:

  • INTEGRAL—Application requires that the data sent between the client and server be sent in such a way that it cannot be changed in transit.

  • CONFIDENTIAL—Application requires that the data be transmitted in a way that prevents other entities from observing the contents of the transmission.

  • NONE—Application does not require transport guarantees.

The XML Schema data type of the j2ee:transport-guarantee element is j2ee:transport-guaranteeType, and is defined in the Java EE Schema that describes the standard web.xml deployment descriptor. For the full reference information, see http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd.

transaction-enabled

The <transaction-enabled> child element of the <request-queue> and <response-queue> elements is a Boolean value that specifies whether transactions should be used when storing and retrieving messages from the request and response buffering queues, respectively. This flag defaults to false.

See Configuring Message Buffering for Web Services in Developing JAX-WS Web Services for Oracle WebLogic Server.

transaction-timeout

The <transaction-timeout> child element of the <port-component> element specifies a timeout value for the current transaction, if the web service operation(s) are running as part of a transaction.

This value must be a positive value and conform to the XML schema duration lexical format, as follows:

PnYnMnDTnHnMnS

Table 7-1 describes the duration format fields. This value defaults to 30 seconds.

validate-request

The <validate-request> child element of the <port-component> element is a boolean value that specifies whether the request should be validated.

The value specified must be a positive value and conform to the XML schema duration lexical format, as follows:

PnYnMnDTnHnMnS

Table 7-1 describes the duration format fields. This value defaults to P0DT3S (3 seconds).

version

The <version> child element of the <wsat-config> element specifies the version of the web service 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 more information about web service atomic transactions, see Using Web Service Atomic Transactions in Developing JAX-WS Web Services for Oracle WebLogic Server.

weblogic-webservices

The <weblogic-webservices> element is the root element of the WebLogic-specific web services deployment descriptor (weblogic-webservices.xml).

The element specifies the set of web services contained in the Java EE component archive in which the deployment descriptor is also contained. The archive is either an EJB JAR file (for stateless session EJB-implemented web services) or a WAR file (for Java class-implemented web services)

webservice-contextpath

The <webservice-contextpath> element specifies the context path portion of the URL used to invoke the web service. The URL to invoke a web service deployed to WebLogic Server is: 

http://host:port/contextPath/serviceURI

where

  • host is the host computer on which WebLogic Server is running.

  • port is the port address to which WebLogic Server is listening.

  • contextPath is the value of this element

  • serviceURI is the value of the webservice-serviceuri element.

When using the jwsc Ant task to generate a web service from a JWS file, the value of the <webservice-contextpath> element is taken from the contextPath attribute of the WebLogic-specific @WLHttpTransport annotation or the <WLHttpTransport> child element of jwsc.

webservice-description

The <webservice-description> element is a container of other elements used to describe a web service. The <webservice-description> element defines a set of port components (specified using one or more <port-component> child elements) that are associated with the WSDL ports defined in the WSDL document.

There may be multiple <webservice-description> elements defined within a single weblogic-webservices.xml file, each corresponding to a particular stateless session EJB or Java class contained within the archive, depending on the implementation of your web service. In other words, an EJB JAR contains the EJBs that implement a web service, a WAR file contains the Java classes.

webservice-description-name

The <webservice-description-name> element specifies the internal name of the web service. The value of this element must be unique for all <webservice-description-name> elements within a single weblogic-webservices.xml file.

webservice-security

Element used to group together all the security-related elements of the weblogic-webservices.xml deployment descriptor.

webservice-serviceuri

The <webservice-serviceuri> element specifies the web service URI portion of the URL used to invoke the web service. The URL to invoke a web service deployed to WebLogic Server is: 

http://host:port/contextPath/serviceURI

where

  • host is the host computer on which WebLogic Server is running.

  • port is the port address to which WebLogic Server is listening.

  • contextPath is the value of the webservice-contextpath element

  • serviceURI is the value of this element.

When using the jwsc Ant task to generate a web service from a JWS file, the value of the <webservice-serviceuri> element is taken from the serviceURI attribute of the WebLogic-specific @WLHttpTransport annotation (JAX-RPC only) or the <WLHttpTransport> child element of jwsc.

webservice-type

The <webservice-type> element specifies whether the web service is based on the JAX-WS or JAX-RPC standard. Valid values include: JAXWS and JAXRPC. This value defaults to JAXRPC.

wsat-config

The <wsat-config> element enables and configures web service atomic transaction configuration at the class or synchronous method level. The child elements of the <wsat-config> element specify the WS-AtomicTransaction version supported and whether or not the web service atomic transaction coordination context is passed with the transaction flow.

For more information about web service atomic transactions, see Using Web Service Atomic Transactions in Developing JAX-WS Web Services for Oracle WebLogic Server.

wsdl

The <wsdl> element groups together all the WSDL-related elements of the weblogic-webservices.xml deployment descriptor.

wsdl-publish-file

The <wsdl-publish-file> element specifies a directory (on the system that hosts the web service) to which WebLogic Server should publish a hard-copy of the WSDL file of a deployed web service; this is in addition to the standard WSDL file accessible via HTTP.

For example, assume that your web service is implemented with an EJB, and its WSDL file is located in the following directory of the EJB JAR file, relative to the root of the JAR:

META-INF/wsdl/a/b/Fool.wsdl

Further assume that the weblogic-webservices.xml file includes the following element for a given web service: 

<wsdl-publish-file>d:/bar</wsdl-publish-file>

This means that when WebLogic Server deploys the web service, the server publishes the WSDL file at the standard HTTP location, but also puts a copy of the WSDL file in the following directory of the computer on which the service is running:

d:/bar/a/b/Foo.wsdl

Note:

Only specify this element if client applications that invoke the web service need to access the WSDL via the local file system or FTP; typically, client applications access the WSDL using HTTP, as described in Browsing to the WSDL of the web service in Oracle Fusion Middleware Developing JAX-RPC Web Services for Oracle WebLogic Server.

The value of this element should be an absolute directory pathname. This directory must exist on every machine which hosts a WebLogic Server instance or cluster to which you deploy the web service.