shibsp::RemotedHandler Class Reference

Base class for handlers that need HTTP request/response layer to be remoted. More...

#include <shibsp/handler/RemotedHandler.h>

Inheritance diagram for shibsp::RemotedHandler:
shibsp::Handler shibsp::Remoted shibsp::PropertySet shibsp::AssertionConsumerService shibsp::LogoutHandler shibsp::LogoutInitiator

List of all members.

Static Public Member Functions

static void addRemotedHeader (const char *header)
 Ensures that a request header will be remoted.

Protected Member Functions

void setAddress (const char *address)
 Establishes message remoting using the supplied address.
DDF wrap (const SPRequest &request, const std::vector< std::string > *headers=nullptr, bool certs=false) const
 Wraps a request by creating an outgoing data flow with the data needed to remote the request information.
virtual std::pair< bool, long > unwrap (SPRequest &request, DDF &out) const
 Unwraps a response by examining an incoming data flow to determine whether a response was produced by the remoted handler.
xmltooling::HTTPRequest * getRequest (DDF &in) const
 Builds a new request instance around a remoted data object.
xmltooling::HTTPResponse * getResponse (DDF &out) const
 Builds a new response instance around an outgoing data object.

Protected Attributes

std::string m_address
 Message address for remote half.

Detailed Description

Base class for handlers that need HTTP request/response layer to be remoted.


Member Function Documentation

static void shibsp::RemotedHandler::addRemotedHeader ( const char *  header  )  [static]

Ensures that a request header will be remoted.

Parameters:
header name of request header to remote
xmltooling::HTTPRequest* shibsp::RemotedHandler::getRequest ( DDF in  )  const [protected]

Builds a new request instance around a remoted data object.

Parameters:
in the dataflow object containing the remoted request
Returns:
a call-specific request object based on the input, to be freed by the caller
xmltooling::HTTPResponse* shibsp::RemotedHandler::getResponse ( DDF out  )  const [protected]

Builds a new response instance around an outgoing data object.

Parameters:
out the dataflow object to be returned by the caller
Returns:
a call-specific response object, to be freed by the caller
void shibsp::RemotedHandler::setAddress ( const char *  address  )  [protected]

Establishes message remoting using the supplied address.

Parameters:
address a unique "address" for remote message handling
virtual std::pair<bool,long> shibsp::RemotedHandler::unwrap ( SPRequest request,
DDF out 
) const [protected, virtual]

Unwraps a response by examining an incoming data flow to determine whether a response was produced by the remoted handler.

Parameters:
request SP request context
out the dataflow object to unpack
Returns:
a pair containing a "request completed" indicator and a server-specific response code
DDF shibsp::RemotedHandler::wrap ( const SPRequest request,
const std::vector< std::string > *  headers = nullptr,
bool  certs = false 
) const [protected]

Wraps a request by creating an outgoing data flow with the data needed to remote the request information.

Parameters:
request an SPRequest to remote
headers array of additional request headers to copy to remote request
certs true iff client certificates should be available for the remote request
Returns:
the input dataflow object

Member Data Documentation

std::string shibsp::RemotedHandler::m_address [protected]

Message address for remote half.


The documentation for this class was generated from the following file:

Generated on 15 Nov 2017 for shibboleth-2.6.1 by  doxygen 1.6.1