Package org.frankframework.http

Class AbstractHttpSender

java.lang.Object
org.frankframework.http.AbstractHttpSession
org.frankframework.http.AbstractHttpSender
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
Direct Known Subclasses:
CmisHttpSender, HttpSender, MsalClientAdapter, NetStorageSender
@DestinationType(HTTP) @Forward(name="*", description="statuscode of the HTTP response") public abstract class AbstractHttpSender extends AbstractHttpSession implements HasPhysicalDestination, ISenderWithParameters, CanUseSharedResource<HttpSession>
Sender for the HTTP protocol using HttpMethod. By default, any response code outside the 2xx or 3xx range is considered an error and the exception forward of the SenderPipe is followed if present and if there is no forward for the specific HTTP status code. Forwards for specific HTTP codes (e.g. "200", "201", ...) are returned by this sender, so they are available to the SenderPipe.

Expected message format:

GET methods expect a message looking like this: 

param_name=param_value&another_param_name=another_param_value

POST AND PUT methods expect a message similar as GET, or looking like this: 


   param_name=param_value
   another_param_name=another_param_value
Since:
7.0
Author:
Niels Meijer
Parameters
Any parameters present are appended to the request (when method is GET as request-parameters, when method POST as body part) except the headersParams list, which are added as HTTP headers, and the urlParam header

  • Field Details

    • MESSAGE_ID_HEADER

      public static final String MESSAGE_ID_HEADER
      See Also:

    • CORRELATION_ID_HEADER

      public static final String CORRELATION_ID_HEADER
      See Also:

    • urlParameter

      protected IParameter urlParameter

    • staticUri

      protected URI staticUri

    • requestOrBodyParamsSet

      protected Set<String> requestOrBodyParamsSet

    • headerParamsSet

      protected Set<String> headerParamsSet

    • parametersToSkipWhenEmptySet

      protected Set<String> parametersToSkipWhenEmptySet

    • paramList

      @Nonnull protected ParameterList paramList

  • Constructor Details

    • AbstractHttpSender

      public AbstractHttpSender()

  • Method Details

    • addParameter

      public void addParameter(IParameter p)
      Specified by:
      addParameter in interface IWithParameters

    • getParameterList

      @Nonnull public ParameterList getParameterList()
      return the Parameters
      Specified by:
      getParameterList in interface IWithParameters

    • 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 AbstractHttpSession
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • getObjectType

      public Class<HttpSession> getObjectType()
      Description copied from interface: CanUseSharedResource
      Used to validate the expected type so now unexpected ClassCastExceptions can occur. May be NULL in which case this check will be skipped and the SharedResource will be returned regardless.
      Specified by:
      getObjectType in interface CanUseSharedResource<HttpSession>

    • start

      public void start()
      Description copied from interface: ISender
      This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.
      Specified by:
      start in interface ConfigurableLifecycle
      Specified by:
      start in interface ISender
      Specified by:
      start in interface org.springframework.context.Lifecycle
      Overrides:
      start in class AbstractHttpSession

    • stop

      public void stop()
      Description copied from interface: ISender
      Stop/close the sender and deallocate resources.
      Specified by:
      stop in interface ISender
      Specified by:
      stop in interface org.springframework.context.Lifecycle
      Overrides:
      stop in class AbstractHttpSession

    • appendParameters

      protected boolean appendParameters(boolean parametersAppended, StringBuilder path, ParameterValueList parameters) throws SenderException
      Throws:
      SenderException

    • getLogPrefix

      protected String getLogPrefix()
      Returns the true name of the class and not XsltPipe$$EnhancerBySpringCGLIB$$563e6b5d. ClassUtils.nameOf(Object) makes sure the original class will be used.
      Returns:
      className + name of the ISender

    • getMethod

      protected abstract org.apache.http.client.methods.HttpRequestBase getMethod(URI uri, Message message, @Nonnull ParameterValueList parameters, PipeLineSession session) throws SenderException
      Custom implementation to create a HttpRequest object.
      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 abstract Message extractResult(HttpResponseHandler responseHandler, PipeLineSession session) throws SenderException, IOException
      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.
      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

    • validateResponseCode

      protected boolean validateResponseCode(int statusCode)

    • sendMessage

      @Nonnull public SenderResult sendMessage(@Nonnull Message message, @Nonnull PipeLineSession session) throws SenderException, TimeoutException
      Description copied from interface: ISender
      Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

      The following table shows the difference between synchronous and a-synchronous senders:

       synchronousa-synchronous
      ISender.isSynchronous() returnstruefalse
      return value of sendMessage() isthe reply-messagethe messageId of the message sent
      the correlationID specified with sendMessage()may be ignoredis sent with the message
      a {link TimeOutException}may be thrown if a timeout occurs waiting for a replyshould not be expected

      Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

      Specified by:
      sendMessage in interface ISender
      Throws:
      SenderException
      TimeoutException

    • getPhysicalDestinationName

      public String getPhysicalDestinationName()
      Specified by:
      getPhysicalDestinationName in interface HasPhysicalDestination

    • getCredentials

      public CredentialFactory getCredentials()

    • getTokenEndpoint

      public String getTokenEndpoint()

    • getOauthAuthenticationMethod

      public AbstractHttpSession.OauthAuthenticationMethod getOauthAuthenticationMethod()

    • setUrl

      public void setUrl(String string)
      URL or base of URL to be used. Expects all parts of the URL to already be encoded.

    • setUrlParam

      public void setUrlParam(String urlParam)
      Parameter that is used to obtain URL; overrides url-attribute.
      Default value
      url

    • setMethodType

      public void setMethodType(AbstractHttpSender.HttpMethod method)
      The HTTP Method used to execute the request
      Default value
      GET

    • setContentType

      public void setContentType(String string)
      Content-Type (superset of mimetype + charset) of the request, for POST, PUT and PATCH methods
      Default value
      text/html, when postType=RAW

    • setCharSet

      public void setCharSet(String string)
      Charset of the request. Typically only used on PUT and POST requests.
      Default value
      UTF-8

    • setHeadersParams

      public void setHeadersParams(String headersParams)
      Comma separated list of parameter names which should be set as HTTP headers

    • setParametersToSkipWhenEmpty

      public void setParametersToSkipWhenEmpty(String parametersToSkipWhenEmpty)
      Comma separated list of parameter names that should not be added as request or body parameter, or as HTTP header, if they are empty. Set to '*' for this behaviour for all parameters

    • setXhtml

      public void setXhtml(boolean xHtml)
      If true, the HTML response is transformed to XHTML
      Default value
      false

    • setStyleSheetName

      public void setStyleSheetName(String stylesheetName)
      (Only used when xHtml=true) stylesheet to apply to the HTML response

    • setResultStatusCodeSessionKey

      public void setResultStatusCodeSessionKey(String resultStatusCodeSessionKey)
      If set, the status code of the HTTP response is put in the specified sessionKey and the (error or okay) response message is returned. Setting this property has a side effect. If a 4xx or 5xx result code is returned and if the pipeline does not implement the specific forward, pipeline-global forward or pipeline-exit for the returned HTTP result code, then the success forward is followed instead of the exception forward.