######
Tunnel
######


****
NAME
****


Kernel::GenericInterface::Invoker::Generic::Tunnel - Generic Interface Invoker for pass-through requester calls


***********
DESCRIPTION
***********


Invoker that passes request and response data through unchanged.


****************
PUBLIC INTERFACE
****************


new()
=====


usually, you want to create an instance of this
by using Kernel::GenericInterface::Invoker->new();


PrepareRequest()
================


prepare the invocation of the configured remote web service.


.. code-block:: perl

     my $Result = $InvokerObject->PrepareRequest(
         Data => {                               # data payload
             ...
         },
     );


Returns:


.. code-block:: perl

     $Result = {
         Success         => 1,                   # 0 or 1
         Data            => {                    # data payload after Invoker
             ...
         },
     };



HandleResponse()
================


handle response data of the configured remote web service.


.. code-block:: perl

     my $Result = $InvokerObject->HandleResponse(
         ResponseSuccess      => 1,              # success status of the remote web service
         ResponseErrorMessage => '',             # in case of web service error
         Data => {                               # data payload
             ...
         },
     );


Returns:


.. code-block:: perl

     $Result = {
         Success         => 1,                   # 0 or 1
         ErrorMessage    => '',                  # in case of error
         Data            => {                    # data payload after Invoker
             ...
         },
     };