SOAP Extensibility Samples

Stable Version 1.0.3 (OutSystems 11)
Published on 15 Feb by 
Created on 14 Feb
Details
SOAP Extensibility Samples provides you with several server actions implementing common extensibility use cases using the SOAP Extensibility API. Use this component as a starting point for using the SOAP Extensibility API, adapting it according to your specific needs if required.
Read More





Feature List:

  • Add/Inspect SOAP headers;

  • Add/Inspect HTTP headers;

  • Add WS-Addressing elements to SOAP requests;

  • Add client-side certificate authentication;

  • Change the service endpoint;

  • Enable MTOM (Message Transmission Optimization Mechanism);

  • Use a different character encoding.



SOAP Extensibility Samples is an OutSystems extension providing you with several server actions implementing common extensibility use cases using the SOAP Extensibility API. The Extensibility API allows you to use advanced functionalities when consuming SOAP web services in Service Studio.

Check the "Use Advanced Extensibility" documentation page to learn how to implement your own extensibility use cases leveraging the SOAP Extensibility API.


Actions:

AddHTTPHeader_ToRequest:

Adds an HTTP header to requests of a consumed SOAP web service. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Inputs:

  • Name - Name of the HTTP header.
  • Value - Value of the HTTP header.

Outputs:

  • None


AddHTTPHeader_ToResponse

Adds an HTTP header to responses of a consumed SOAP web service. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Inputs:

  • Name - Name of the HTTP header.
  • Value - Value of the HTTP header.

Outputs:

  • None


AddSOAPHeader_ToRequest

Adds a SOAP header to requests of a consumed SOAP web service. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Inputs:

  • Name - Name of the SOAP header.
  • Namespace - Namespace of the SOAP header.
  • Value - Value of the SOAP header.

Outputs:

  • None


AddSOAPHeader_ToResponse

Adds a SOAP header to responses of a consumed SOAP web service. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Inputs:

  • Name - Name of the SOAP header.
  • Namespace - Namespace of the SOAP header.
  • Value - Value of the SOAP header.

Outputs:

  • None


AddWSAddressing

Adds WS-Addressing elements to requests of a consumed SOAP web service. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Inputs:

  • None

Outputs:

  • None


ChangeEndpoint

Sets the service endpoint for the requests of a consumed SOAP web service. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.
Note: The new URI must have the same scheme (e.g. "https://") of the original URI, where the original URI is either the effective URL defined in Service Center (if configured) or the URL that appears in the service properties in Service Studio. 

Inputs:

  • Uri - New URI of the service endpoint. Must have the same scheme of the original URI (e.g. “https://”). 

Outputs:

  • None


EnableMTOM

Adds support for Message Transmission Optimization Mechanism (MTOM) in a consumed SOAP web service. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Inputs:

  • None

Outputs:

  • None


GetHTTPHeaders_FromRequest

Returns the list of HTTP headers sent in the last request of a consumed SOAP web service. To use this action you must call the RegisterInspectHeaders server action in the OnBeforeRequestAdvanced callback of the SOAP web service.

Inputs:

  • None

Outputs:

  • HTTPHeaders - List of HTTP headers in the request.


GetHTTPHeaders_FromResponse

Returns the list of HTTP headers received in the last response of a consumed SOAP web service. To use this action you must call the RegisterInspectHeaders server action in the OnBeforeRequestAdvanced callback of the SOAP web service.

Inputs:

  • None

Outputs:

  • HTTPHeaders - List of HTTP headers in the response.


GetSOAPHeaders_FromRequest

Returns the list of SOAP headers sent in the last request of a consumed SOAP web service. To use this action you must call the RegisterInspectHeaders server action in the OnBeforeRequestAdvanced callback of the SOAP web service.

Inputs:

  • None

Outputs:

  • SOAPHeaders - List of SOAP headers in the request.


GetSOAPHeaders_FromResponse

Returns the list of SOAP headers received in the last response of a consumed SOAP web service. To use this action you must call the RegisterInspectHeaders server action in the OnBeforeRequestAdvanced callback of the SOAP web service.

Inputs:

  • None

Outputs:

  • SOAPHeaders - List of SOAP headers in the response.


RegisterInspectHeaders

Enables the inspection of both HTTP and SOAP headers included in requests and responses of SOAP web services. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Note: If RegisterInspectHeaders is not called, all the Get*Headers_From* server actions will return an empty list.

Inputs:

  • None

Outputs:

  • None


SetClientCertificate

Defines the client certificate used in requests of a consumed SOAP web service for authentication purposes. This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Inputs:

  • ClientCertificateByteArray - Client certificate contents as binary data.
  • CertificatePassword - Certificate password.

Outputs:

  • None


SetEncoding

Defines the character encoding used in requests of a consumed SOAP web service. Used to configure a custom character encoding supported by the .NET framework but which is not supported out-of-the-box by Windows Communication Foundation (WCF). This method must be called in the context of the OnBeforeRequestAdvanced SOAP callback.

Inputs:

Outputs:

  • None


Structures

HTTPHeader:

  • Name - Name of the HTTP header.
  • Value - Value of the HTTP header.


SOAPHeader:

  • Actor - Recipient of the SOAP header.
  • Element - XML header element of a SOAP request or response.
  • MustUnderstand - Value indicating whether the SoapHeader must be understood.
  • Relay - Value that indicates whether the SOAP header is to be relayed to the next SOAP node if the current node does not understand the header.
What’s new (1.0.3)

The component is now distributed as an OutSystems application package for easier installation.

Reviews (0)
Category
Applications, Components
Support Options
This component is not supported by OutSystems. You may use the discussion forums to leave suggestions or obtain best-effort support from the community, including from Pedro Guimarães who created this component.
Dependencies
SOAP Extensibility Samples has no dependencies.
Requirements
Platform:
11.0.0.200
Database:
All
Stack:
.NET
Component Consumers
No consumers yet.
Weekly Downloads