xrootd
Public Member Functions | List of all members
XrdSecEntityPin Class Referenceabstract

#include <XrdSecEntityPin.hh>

Public Member Functions

virtual bool Process (XrdSecEntity &entity, XrdOucErrInfo &einfo)=0
 
 XrdSecEntityPin ()
 
virtual ~XrdSecEntityPin ()
 

Detailed Description

This class defines the XrdSecEntity object post processing plugin. When authentication succeeds, the plugin is called to inspect and possible decorate (e.g. add attributes) the entity object. The plugin also has the capability of returning failure due to some problem. When failure ooccurs, the security framework moves on to another authentication protocol, if one is avalable. Entity post processing plugins may be stacked. You always return the results of the stacked plugin whether or not you wish to handle the entity object, if a stacked plugin exists; unless you return false.

Constructor & Destructor Documentation

◆ XrdSecEntityPin()

XrdSecEntityPin::XrdSecEntityPin ( )
inline

◆ ~XrdSecEntityPin()

virtual XrdSecEntityPin::~XrdSecEntityPin ( )
inlinevirtual

Member Function Documentation

◆ Process()

virtual bool XrdSecEntityPin::Process ( XrdSecEntity entity,
XrdOucErrInfo einfo 
)
pure virtual

Post process an authenticated entity object.

Parameters
entityReference to the entity object.
einfoReference to errinfo object where a message that should be returned to the client on why post processing failed.
Returns
true upon success and false upon failure with einfo containing the reason for the failure.

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