Package org.apache.axis2.jaxws.description

Interface EndpointDescription

  • All Known Implementing Classes:
    EndpointDescriptionImpl
    public interface EndpointDescription
    An EndpointDescription corresponds to a particular Service Implementation. It can correspond to either either a client to that impl or the actual service impl.

    The EndpointDescription contains information that is relevant to both a Provider-based and SEI-based (aka Endpoint-based or Java-based) enpdoints. SEI-based endpoints (whether they have an explicit or implcit SEI) will have addtional metadata information in an EndpointInterfaceDescription class and sub-hierachy; Provider-based endpoitns do not have such a hierachy. 

     EndpointDescription details
 
    
     CORRESPONDS TO:      The endpoint (both Client and Server)
 
    
     AXIS2 DELEGATE:      AxisService
 
    
     CHILDREN:            0..1 EndpointInterfaceDescription
 
    
     ANNOTATIONS:
         WebService [181]
         WebServiceProvider [224]
             ServicMode [224]
         BindingType [224]
 
    
     WSDL ELEMENTS:
         port

    • Method Detail

      • getPortInfo

        PortInfo getPortInfo()
        Returns the JAX-WS handler PortInfo object for this endpoint.
        Returns:
        PortInfo

      • isProviderBased

        boolean isProviderBased()

      • isEndpointBased

        boolean isEndpointBased()

      • getTargetNamespace

        String getTargetNamespace()

      • getBindingType

        String getBindingType()
        Returns the binding type FOR A SERVER. This is based on the BindingType annotation and/or the WSDL. This will return the default binding (SOAP11) if no annotation was specified on the server. This should NOT be called on the client since it will always return the default binding. Use getClientBindingID() on clients.
        Returns:

      • getHandlerChain

        HandlerChainsType getHandlerChain​(Object serviceDelegateKey)
        Return the handler chain configuration information as a HandlerChainsType object. If the key is non-null then it is used to look for handler chain configuration information in the sparse metadata. The order in which the configuration information is resolved is: 1) Look in sparse composite if the key is not null 2) Look in the composite 3) Look for a HandlerChain annotation and read in the file it specifies
        Parameters:
        serviceDelegateKey - May be null. If non-null, used to look for service-delegate specific sparse composite information.
        Returns:
        A HandlerChainsType object or null

      • getHandlerChain

        HandlerChainsType getHandlerChain()
        Return the handler chain configuration information as a HandlerChainsType object. This is the same as calling getHandlerChain(null).
        See Also:
        getHandlerChain(Object)

      • setClientBindingID

        void setClientBindingID​(String clientBindingID)
        Set the binding type FOR A CLIENT. The BindingType annotation is not valid on the client per the JAX-WS spec. The value can be set via addPort(...) for a Dispatch client or via TBD for a Proxy client.

      • getClientBindingID

        String getClientBindingID()
        Return the binding type FOR A CLIENT. This will return the default client binding type if called on the server. Use getBindingType() on servers.
        Returns:
        String representing the client binding type

      • setEndpointAddress

        void setEndpointAddress​(String endpointAddress)

      • getEndpointAddress

        String getEndpointAddress()

      • getPortQName

        QName getPortQName()

      • getServiceQName

        QName getServiceQName()

      • isMTOMEnabled

        boolean isMTOMEnabled()
        Signals whether or not MTOM has been turned on for the endpoint based on the annotation configuration. Both the @MTOM and @BindingType are inspected. The @MTOM annotation is inspected first. If the @MTOM annotation is not present, then the @BindingType is inspected.
        Returns:
        a boolean value

      • getMTOMThreshold

        int getMTOMThreshold()
        If MTOM is enabled, returns the threshold value.
        Returns:
        -1 if MTOM is not enabled, a positive integer value if one was configured.

      • respectBinding

        boolean respectBinding()
        Returns true if the contents of the <wsdl:binding> must be strictly respected by the runtime.
        Returns:
        a boolean value

      • setRespectBinding

        void setRespectBinding​(boolean respect)
        Indicate whether or not strict binding support should be used.

      • addRequiredBinding

        boolean addRequiredBinding​(WSDLValidatorElement element)
        Adds the QName to a list of binding types that are required to be supported by the endpoint as defined in the WSDL.
        Parameters:
        name -
        Returns:

      • getRequiredBindings

        Set<WSDLValidatorElement> getRequiredBindings()
        Returns a list of all known bindings that should be supported based on the information in the WSDL.
        Returns:

      • getDescriptionBuilderComposite

        DescriptionBuilderComposite getDescriptionBuilderComposite()
        Return the DescriptionBuilderComposite, if any, used to build this service description.
        Returns:

      • getProperty

        Object getProperty​(String key)
        Return the Object that corresponds to the property key supplied.

      • setProperty

        void setProperty​(String key,
                 Object value)
        Store the property by the key specified.