SoapServiceProvider (Mule Extensions SOAP API 1.0.0-rc API)

```
public interface SoapServiceProvider
```
Contract for implementations that handles the web services that the extension will be able to execute by returning a list of WebServiceDefinitions.
Implementations can also add a level of security by overriding the getSecurities() method.

Since:

1.0

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Map<String,String>`	`getCustomHeaders(WebServiceDefinition definition, String operation)` Gives the capability to create Soap headers given the a service definition and the operation that is being consumed so they can be bundled with the soap request
`default List<SecurityStrategy>`	`getSecurities()`
`List<WebServiceDefinition>`	`getWebServiceDefinitions()`
`default void`	`validateConfiguration()` This method is a hook for `SoapServiceProvider` instances to validate the configured parameters and fail gracefully before attempting to create a connection avoiding misleading and confusing error messages.

- Method Detail
  - getWebServiceDefinitions
```
List<WebServiceDefinition> getWebServiceDefinitions()
```
    Returns:
    
    a List with all the WebServiceDefinitions that the provider implementation handles.
  - getSecurities
```
default List<SecurityStrategy> getSecurities()
```
    Returns:
    
    a List with all the Soap Securities that should be added for the services described by the provider impl.
  - getCustomHeaders
```
default Map<String,String> getCustomHeaders(WebServiceDefinition definition,
                                            String operation)
```
    Gives the capability to create Soap headers given the a service definition and the operation that is being consumed so they can be bundled with the soap request
    It returns a Map with String keys representing the name of the headers and String values representing the actual XML soap header value.
    
    Parameters:
    
    definition - the WebServiceDefinition of the service being called.
    
    operation - the name of the operation that is going to be consumed.
    
    Returns:
    
    a Map of soap headers to be bundled in the generated envelope.
  - validateConfiguration
```
default void validateConfiguration()
                            throws SoapServiceProviderConfigurationException
```
    This method is a hook for SoapServiceProvider instances to validate the configured parameters and fail gracefully before attempting to create a connection avoiding misleading and confusing error messages.
    
    Throws:
    
    SoapServiceProviderConfigurationException - if any configured parameter has an invalid value.

Interface SoapServiceProvider

Method Summary

Method Detail

getWebServiceDefinitions

getSecurities

getCustomHeaders

validateConfiguration