All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jakarta.servlet.resources.jakartaee_web_services_client_2_0.xsd Maven / Gradle / Ivy

There is a newer version: 6.1.0
Show newest version


  
    

      Copyright (c) 2009, 2021 Oracle and/or its affiliates. All rights reserved.
      
      This program and the accompanying materials are made available under the
      terms of the Eclipse Public License v. 2.0, which is available at
      http://www.eclipse.org/legal/epl-2.0.
      
      This Source Code may also be made available under the following Secondary
      Licenses when the conditions for such availability set forth in the
      Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
      version 2 with the GNU Classpath Exception, which is available at
      https://www.gnu.org/software/classpath/license.html.
      
      SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
      
    
  

  
    

      (C) Copyright International Business Machines Corporation 2002
      
    
  




  
    
      

        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 Jakarta XML 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.
        
      
    
    
      
      
        
          

            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/".
            
          
        
      
      
        
          

            The service-interface element declares the fully qualified class
            name of the Jakarta XML RPC Service interface the client depends on. 
            In most cases the value will be jakarta.xml.rpc.Service.  A Jakarta XML 
            RPC generated Service Interface class may also be specified.
            
          
        
      
      
        
          

            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 Jakarta XML Web Services 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.
            
          
        
      
      
        
          

            The wsdl-file element contains the URI location of a WSDL
            file. The location is relative to the root of the module.
            
          
        
      
      
        
          

            The jaxrpc-mapping-file element contains the name of a file that
            describes the Jakarta XML 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 Jakarta Enterprise Web Services based 
            runtime is used.
            
          
        
      
      
        
          

            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.
            
          
        
      
      
        
          

            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.
            
          
        
      
      
        
          
            

              	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 Jakarta XML RPC based runtime only.
              
            
          
        
        
          
            

              	 To be used with Jakarta XML Web Services based runtime only.
              
            
          
        
      
      
    
    
  




  
    
      

        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.
        
      
    
    
      
        
          

            The service-endpoint-interface element defines a fully qualified
            Java class that represents the Service Endpoint Interface of a
            WSDL port.
            
          
        
      
      
        
          

            Used to enable or disable SOAP MTOM/XOP mechanism on the client
            side for a port-component. 
            
            Not to be specified for Jakarta XML RPC runtime
            
          
        
      
      
        
          

            When MTOM is enabled, binary data above this size in bytes
            should be XOP encoded or sent as attachment. Default value is 0.
            
            Not to be specified for Jakarta XML RPC runtime
            
          
        
      
      
        
          

            This specifies the WS-Addressing requirements for a Jakarta XML 
            web service. It corresponds to jakarta.xml.ws.soap.Addressing
            annotation or its feature jakarta.xml.ws.soap.AddressingFeature.
            
            See the addressingType for more information.
            
            Not to be specified for Jakarta XML RPC runtime
            
          
        
      
      
        
          

            Corresponds to the jakarta.xml.ws.RespectBinding annotation
            or its corresponding jakarta.xml.ws.RespectBindingFeature web
            service feature. This is used to control whether a Jakarta XML Web 
            Services implementation must respect/honor the contents of the
            wsdl:binding in the WSDL that is associated with the service.
            
            Not to be specified for Jakarta XML RPC runtime
            
          
        
      
      
        
          

            The port-component-link element links a port-component-ref
            to a specific port-component required to be made available
            by a service reference.
            
            The value of a port-component-link must be the
            port-component-name of a port-component in the same module
            or another module in the same application unit. The syntax
            for specification follows the syntax defined for ejb-link
            in the EJB 2.0 specification.
            
          
        
      
    
    
  




  
    
      

        The handler-chains element defines the handlerchains associated with this
        service or service endpoint.
        
      
    
    
      
    
    
  




  
    
      

        The handler-chain element defines the handlerchain. 
        Handlerchain can be defined such that the handlers in the
        handlerchain operate,all ports of a service, on a specific
        port or on a list of protocol-bindings. The choice of elements
        service-name-pattern, port-name-pattern and protocol-bindings
        are used to specify whether the handlers in handler-chain are
        for a service, port or protocol binding. If none of these 
        choices are specified with the handler-chain element then the
        handlers specified in the handler-chain will be applied on 
        everything.
        
      
    
    
      
        
        
        
      
      
    
    
  

  
    
      

        Defines the type used for specifying a list of
        protocol-bindingType(s). For e.g.
        
        ##SOAP11_HTTP ##SOAP12_HTTP ##XML_HTTP
        
      
    
    
  

  
    
      

        Defines the type used for specifying the URI for the
        protocol binding used by the port-component.  For
        portability one could use one of the following tokens that
        alias the standard binding types: 
        
        ##SOAP11_HTTP
        ##SOAP11_HTTP_MTOM
        ##SOAP12_HTTP
        ##SOAP12_HTTP_MTOM
        ##XML_HTTP
        
        Other specifications could define tokens that start with ##
        to alias new standard binding URIs that are introduced.
        
      
    
    
  

  
    
      

        Defines the type that is used for specifying tokens that
        start with ## which are used to alias existing standard
        protocol bindings and support aliases for new standard
        binding URIs that are introduced in future specifications.
        
        The following tokens alias the standard protocol binding
        URIs:
        
        ##SOAP11_HTTP = "http://schemas.xmlsoap.org/wsdl/soap/http"
        ##SOAP11_HTTP_MTOM = 
        "http://schemas.xmlsoap.org/wsdl/soap/http?mtom=true"
        ##SOAP12_HTTP = "http://www.w3.org/2003/05/soap/bindings/HTTP/"
        ##SOAP12_HTTP_MTOM = 
        "http://www.w3.org/2003/05/soap/bindings/HTTP/?mtom=true"
        ##XML_HTTP = "http://www.w3.org/2004/08/wsdl/http"
        
      
    
    
      
    
  

  
    
      

        This is used to specify the QName pattern in the
        attribute service-name-pattern and port-name-pattern in
        the handler-chain element
        
        For example, the various forms acceptable here for
        service-name-pattern attribute in handler-chain element
        are :
        
        Exact Name: service-name-pattern="ns1:EchoService"
        
        	 In this case, handlers specified in this
        	 handler-chain element will apply to all ports with
        	 this exact service name. The namespace prefix must
        	 have been declared in a namespace declaration
        	 attribute in either the start-tag of the element
        	 where the prefix is used or in an an ancestor 
        	 element (i.e. an element in whose content the 
        	 prefixed markup occurs)
        	 
        
        Pattern : service-name-pattern="ns1:EchoService*"
        
        	 In this case, handlers specified in this
        	 handler-chain element will apply to all ports whose
        	 Service names are like EchoService1, EchoServiceFoo
        	 etc. The namespace prefix must have been declared in
        	 a namespace declaration attribute in either the
        	 start-tag of the element where the prefix is used or
        	 in an an ancestor element (i.e. an element in whose 
        	 content the prefixed markup occurs)
        
        Wild Card : service-name-pattern="*"
        
        	In this case, handlers specified in this handler-chain
        	element will apply to ports of all service names.
        
        The same can be applied to port-name attribute in
        handler-chain element.
        
      
    
    
      
    
  




  
    
      

        This specifies the WS-Addressing requirements for a Jakarta XML web 
        service. It corresponds to jakarta.xml.ws.soap.Addressing annotation or its
        feature jakarta.xml.ws.soap.AddressingFeature.
        
        If the "enabled" element is "true", WS-Addressing is enabled.
        It means that the endpoint supports WS-Addressing but does not require
        its use. The default value for "enabled" is "true".
        
        If the WS-Addressing is enabled and the "required" element is "true",
        it means that the endpoint requires WS-Addressing. The default value
        for "required" is "false".
        
        If WS-Addressing is enabled, the "responses" element determines
        if an endpoint requires the use of only anonymous responses,
        or only non-anonymous responses, or all. The value of the "responses"
        element must be one of the following:
        
        ANONYMOUS
        NON_ANONYMOUS
        ALL
        
        The default value for the "responses" is ALL.
        
      
    
    
      
      
      
    
  




  
    
      

        If WS-Addressing is enabled, this type determines if an endpoint
        requires the use of only anonymous responses, or only non-anonymous
        responses, or all.
        
      
    
    
      
        
        
        
      
    
  




  
    
      

        Corresponds to the jakarta.xml.ws.RespectBinding annotation
        or its corresponding jakarta.xml.ws.RespectBindingFeature web
        service feature. This is used to control whether a Jakarta XML 
        Web Services implementation must respect/honor the contents of the
        wsdl:binding in the WSDL that is associated with the service.
        
        If the "enabled" element is "true", wsdl:binding in the
        associated WSDL, if any, must be respected/honored.
        
      
    
    
      
    
  




  
    
      

        Declares the handler for a port-component, service-ref. Handlers can
        access the init-param name/value pairs using the HandlerInfo interface.
        
        Used in: port-component, service-ref
        
      
    
    
      
      
        
          

            Defines the name of the handler. The name must be unique within the
            module.
            
          
        
      
      
        
          

            Defines a fully qualified class name for the handler implementation.
            
          
        
      
      
        
          

            Not to be specified for Jakarta XML Web Services runtime
            
          
        
      
      
        
          

            Defines the QName of a SOAP header that will be processed by the
            handler.
            
            Not to be specified for Jakarta XML Web Services runtime
            
          
        
      
      
        
          

            The soap-role element contains a SOAP actor definition that the
            Handler will play as a role.
            
          
        
      
      
        
          

            The port-name element defines the WSDL port-name that a
            handler should be associated with. If port-name is not
            specified, the handler is assumed to be associated with
            all ports of the service.
            
            Not to be specified for Jakarta XML Web Services runtime
            
          
        
      
    
    
  

  
    
      
        
          
            

              Defines the name of the handler. The name must be unique
              within the module.
              
            
          
          
          
        
      
    
  






© 2015 - 2024 Weber Informatics LLC | Privacy Policy