org.apache.woden.wsdl20.extensions.soap

## Interface SOAPEndpointExtensions

- All Superinterfaces:
    ComponentExtensionContext

      public interface SOAPEndpointExtensions
      extends ComponentExtensionContext

  There are no WSDL 2.0 SOAP extension properties (from the namespace `http://www.w3.org/ns/wsdl/soap`) attached to the Endpoint component.

  The purpose of this interface is to maintain consistency across the WSDL 2.0 SOAP extensions in Woden, which define accessor methods for the HTTP properties that are added to WSDL 2.0 components, along with the SOAP properties, when a SOAP binding specifies HTTP as the underlying protocol.

  For this interface, the generic ExtensionProperty accessor methods, `getProperties` and `getProperty`, return null (because they only apply to SOAP extension properties, which are not present for the Endpoint component).

  This interface defines additional extension-specific accessor methods for the HTTP extension properties that are added to the Endpoint component by a SOAP binding when the underlying protocol is HTTP.

  These are:

  - {http authentication scheme}
  - {http authentication realm}

  TODO Re HTTP methods, consider WODEN-158 which proposes keeping extension interfaces namespace-specific, not binding-type-specific

  Author:
    Arthur Ryman (ryman@ca.ibm.com, arthur.ryman@gmail.com)

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getHttpAuthenticationRealm()` If the SOAP binding specifies HTTP as the underlying protocol, the {http authentication realm} property is added to the Endpoint component and it will be returned by this method.
    `HTTPAuthenticationScheme` | `getHttpAuthenticationScheme()` If the SOAP binding specifies HTTP as the underlying protocol, the {http authentication scheme} property is added to the Endpoint component and it will be returned by this method.

    - ### Methods inherited from interface org.apache.woden.wsdl20.extensions.ComponentExtensionContext

      `getNamespace, getParent, getProperties, getProperty`

- - ### Method Detail

    - #### getHttpAuthenticationScheme

          HTTPAuthenticationScheme getHttpAuthenticationScheme()

      If the SOAP binding specifies HTTP as the underlying protocol, the {http authentication scheme} property is added to the Endpoint component and it will be returned by this method. If the underlying protocol is not HTTP, this method will return null.
      Returns:
        the HTTPAuthenticationScheme if present, otherwise null

    - #### getHttpAuthenticationRealm

          String getHttpAuthenticationRealm()

      If the SOAP binding specifies HTTP as the underlying protocol, the {http authentication realm} property is added to the Endpoint component and it will be returned by this method. If the underlying protocol is not HTTP, this method will return null.
      Returns:
        a String representing the {http authentication realm} property if present, otherwise null.

Copyright ? Apache Software Foundation. All Rights Reserved.