shibboleth-2.5.6

shibsp::SecuredHandler Class Reference

Pluggable runtime functionality that is protected by simple access control. More...

#include <shibsp/handler/SecuredHandler.h>

Inheritance diagram for shibsp::SecuredHandler:
shibsp::AbstractHandler shibsp::Handler shibsp::DOMPropertySet shibsp::PropertySet shibsp::PropertySet

List of all members.

Public Member Functions

std::pair< bool, long > run (SPRequest &request, bool isHandler=true) const
 Executes handler functionality as an incoming request.

Protected Member Functions

 SecuredHandler (const xercesc::DOMElement *e, xmltooling::logging::Category &log, const char *aclProperty="acl", const char *defaultACL=nullptr, xercesc::DOMNodeFilter *filter=nullptr, const std::map< std::string, std::string > *remapper=nullptr)
 Constructor.

Detailed Description

Pluggable runtime functionality that is protected by simple access control.


Constructor & Destructor Documentation

shibsp::SecuredHandler::SecuredHandler ( const xercesc::DOMElement *  e,
xmltooling::logging::Category &  log,
const char *  aclProperty = "acl",
const char *  defaultACL = nullptr,
xercesc::DOMNodeFilter *  filter = nullptr,
const std::map< std::string, std::string > *  remapper = nullptr 
) [protected]

Constructor.

Parameters:
eDOM element to load as property set
loglogging category to use
aclPropertyname of IP/CIDR ACL property
defaultACLIP/CIDR ACL to apply if no acl property is set
filteroptional filter controls what child elements to include as nested PropertySets
remapperoptional map of property rename rules for legacy property support

Member Function Documentation

std::pair<bool,long> shibsp::SecuredHandler::run ( SPRequest request,
bool  isHandler = true 
) const [virtual]

Executes handler functionality as an incoming request.

Handlers can be run either directly by incoming web requests or indirectly/implicitly during other SP processing.

Parameters:
requestSP request context
isHandlertrue iff executing in the context of a direct handler invocation
Returns:
a pair containing a "request completed" indicator and a server-specific response code

Implements shibsp::Handler.


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