javaee:service-refType

The service-ref element declares a reference to a Web
service. It contains optional description, display name and
icons, a declaration of the required Service interface,
an optional WSDL document location, an optional set
of JAX-RPC mappings, an optional QName for the service element,
an optional set of Service Endpoint Interfaces to be resolved
by the container to a WSDL port, and an optional set of handlers.

Complex Type Information

Model

Attributes

QName Type Fixed Default Use Inheritable Annotation
id xsd:ID optional

Used By

Source

<xsd:complexType name="service-refType">
  <xsd:annotation>
    <xsd:documentation>The service-ref element declares a reference to a Web service. It contains optional description, display name and icons, a declaration of the required Service interface, an optional WSDL document location, an optional set of JAX-RPC mappings, an optional QName for the service element, an optional set of Service Endpoint Interfaces to be resolved by the container to a WSDL port, and an optional set of handlers.</xsd:documentation>
  </xsd:annotation>
  <xsd:sequence>
    <xsd:group ref="javaee:descriptionGroup"/>
    <xsd:element name="service-ref-name" type="javaee:jndi-nameType">
      <xsd:annotation>
        <xsd:documentation>The service-ref-name element declares logical name that the components in the module use to look up the Web service. It is recommended that all service reference names start with "service/".</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="service-interface" type="javaee:fully-qualified-classType">
      <xsd:annotation>
        <xsd:documentation>The service-interface element declares the fully qualified class name of the JAX-RPC Service interface the client depends on. In most cases the value will be javax.xml.rpc.Service. A JAX-RPC generated Service Interface class may also be specified.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="service-ref-type" type="javaee:fully-qualified-classType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>The service-ref-type element declares the type of the service-ref element that is injected or returned when a JNDI lookup is done. This must be either a fully qualified name of Service class or the fully qualified name of service endpoint interface class. This is only used with JAX-WS runtime where the corresponding @WebServiceRef annotation can be used to denote both a Service or a Port. If this is not specified, then the type of service-ref element that is injected or returned when a JNDI lookup is done is always a Service interface/class.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="wsdl-file" type="javaee:xsdAnyURIType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>The wsdl-file element contains the URI location of a WSDL file. The location is relative to the root of the module.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="jaxrpc-mapping-file" type="javaee:pathType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>The jaxrpc-mapping-file element contains the name of a file that describes the JAX-RPC mapping between the Java interaces used by the application and the WSDL description in the wsdl-file. The file name is a relative path within the module file. This is not required when JAX-WS based runtime is used.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="service-qname" type="javaee:xsdQNameType" minOccurs="0" maxOccurs="1">
      <xsd:annotation>
        <xsd:documentation>The service-qname element declares the specific WSDL service element that is being refered to. It is not specified if no wsdl-file is declared.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:element name="port-component-ref" type="javaee:port-component-refType" minOccurs="0" maxOccurs="unbounded">
      <xsd:annotation>
        <xsd:documentation>The port-component-ref element declares a client dependency on the container for resolving a Service Endpoint Interface to a WSDL port. It optionally associates the Service Endpoint Interface with a particular port-component. This is only used by the container for a Service.getPort(Class) method call.</xsd:documentation>
      </xsd:annotation>
    </xsd:element>
    <xsd:choice>
      <xsd:element name="handler" type="javaee:service-ref_handlerType" minOccurs="0" maxOccurs="unbounded">
        <xsd:annotation>
          <xsd:documentation>Declares the handler for a port-component. Handlers can access the init-param name/value pairs using the HandlerInfo interface. If port-name is not specified, the handler is assumed to be associated with all ports of the service. To be used with JAX-RPC based runtime only.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:element name="handler-chains" type="javaee:service-ref_handler-chainsType" minOccurs="0" maxOccurs="1">
        <xsd:annotation>
          <xsd:documentation>To be used with JAX-WS based runtime only.</xsd:documentation>
        </xsd:annotation>
      </xsd:element>
    </xsd:choice>
    <xsd:group ref="javaee:resourceGroup"/>
  </xsd:sequence>
  <xsd:attribute name="id" type="xsd:ID"/>
</xsd:complexType>