Package org.frankframework.http

Class WebServiceSender

java.lang.Object
org.frankframework.http.AbstractHttpSession
org.frankframework.http.AbstractHttpSender
org.frankframework.http.HttpSender
org.frankframework.http.WebServiceSender
All Implemented Interfaces:
CanUseSharedResource<HttpSession>, FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, HasKeystore, HasTruststore, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle
public class WebServiceSender extends HttpSender
Sender that sends a message via a WebService.
Since:
7.0
Version:
2.0
Author:
Gerrit van Brakel, Niels Meijer

  • Constructor Details

    • WebServiceSender

      public WebServiceSender()

  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from interface: IConfigurable
      Configure this component.

      configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

      In the case of a container, this will propagate the configure signal to all components that apply.

      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class HttpSender
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • getMethod

      protected org.apache.http.client.methods.HttpRequestBase getMethod(URI uri, Message message, @Nonnull ParameterValueList parameters, PipeLineSession session) throws SenderException
      Description copied from class: AbstractHttpSender
      Custom implementation to create a HttpRequest object.
      Overrides:
      getMethod in class HttpSender
      Parameters:
      uri - endpoint to send the message to
      message - to be sent
      parameters - ParameterValueList that contains all the senders parameters
      session - PipeLineSession to retrieve or store data from, or NULL when not set
      Returns:
      a HttpRequest object
      Throws:
      SenderException

    • extractResult

      protected Message extractResult(HttpResponseHandler responseHandler, PipeLineSession session) throws SenderException, IOException
      Description copied from class: AbstractHttpSender
      Custom implementation to extract the response and format it to a String result.
      It is important that the response will be read or will be closed.
      Overrides:
      extractResult in class HttpSender
      Parameters:
      responseHandler - HttpResponseHandler that contains the response information
      session - PipeLineSession which may be null
      Returns:
      a string that will be passed to the pipeline
      Throws:
      SenderException
      IOException

    • setSoap

      public void setSoap(boolean b)
      when true, messages sent are put in a soap envelope and the soap envelope is removed from received messages (soap envelope will not be visible to the pipeline)
      Default value
      true

    • setMethodType

      @Protected public void setMethodType(AbstractHttpSender.HttpMethod method)
      Hide this property from being set. SOAP should always be POST
      Overrides:
      setMethodType in class AbstractHttpSender

    • setSoapAction

      public void setSoapAction(String soapAction)
      the soapactionuri to be set in the requestheader

    • setSoapActionParam

      public void setSoapActionParam(String soapActionParam)
      parameter to obtain the soapactionuri

    • setEncodingStyle

      public void setEncodingStyle(String encodingStyle)
      the encodingstyle to be set in the messageheader

    • setThrowApplicationFaults

      public void setThrowApplicationFaults(boolean b)
      controls whether soap faults generated by the application generate an exception, or are treated as 'normal' messages
      Default value
      true

    • setServiceNamespace

      public void setServiceNamespace(String serviceNamespace)
      the namespace of the message sent. identifies the service to be called. may be overriden by an actual namespace setting in the message to be sent

    • setServiceNamespaceParam

      public void setServiceNamespaceParam(String serviceNamespaceParam)
      parameter to obtain the servicenamespace

    • setNamespaceDefs

      public void setNamespaceDefs(String namespaceDefs)
      namespace defintions to be added in the soap envelope tag. must be in the form of a comma or space separated list of prefix=namespaceuri-definitions

    • setWssUserName

      public void setWssUserName(String string)
      username used to obtain credentials for authentication to web services security

    • setWssPassword

      public void setWssPassword(String string)
      password used to obtain credentials for authentication to web services security

    • setWssAuthAlias

      public void setWssAuthAlias(String string)
      alias used to obtain credentials for authentication to web services security

    • setWssPasswordDigest

      public void setWssPasswordDigest(boolean b)
      when true, the password is sent digested. otherwise it is sent in clear text
      Default value
      true