XrdSecEntityAttr.hh

Go to the documentation of this file.

#ifndef __SEC_ENTITYATTR_H__
#define __SEC_ENTITYATTR_H__
/******************************************************************************/
/*                                                                            */
/*                   X r d S e c E n t i t y A t t r . h h                    */
/*                                                                            */
/* (c) 2019 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/******************************************************************************/
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
#include <sys/types.h>
 
#include <string>
#include <vector>
 
class XrdSecAttr;
class XrdSecEntityAttrCB;
class XrdSecEntityXtra;
  
/******************************************************************************/
/*                      X r d S e c E n t i t y A t t r                       */
/******************************************************************************/
  
class XrdSecEntityAttr
{
public:
friend class XrdSecEntity;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         bool    Add(XrdSecAttr &attr);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         bool    Add(const std::string &key,
                     const std::string &val, bool replace=false);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
XrdSecAttr      *Get(const void *sigkey);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         bool    Get(const std::string &key, std::string &val);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
std::vector<std::string> Keys();
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         void    List(XrdSecEntityAttrCB &attrCB);
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         XrdSecEntityAttr(XrdSecEntityXtra *xtra) : entXtra(xtra) {}
 
        ~XrdSecEntityAttr() {}
 
private:
 
XrdSecEntityXtra *entXtra;
};
 
/******************************************************************************/
/*                    X r d S e c E n t i t y A t t r C B                     */
/******************************************************************************/
 
// The XrdSecEntityAttrCB class defines the callback object passed to the
// XrdSecEntity::List() method to iteratively obtain the key-value attribute
// pairs associated with the entity. The XrdSecEntityAttrCB::Attr() method is
// called for each key-value pair. The end of the list is indicated by calling
// Attr() with nil key-value pointers. The Attr() method should not call
// the XrdSecEntity::Add() or XrdSecEntity::Get() methods; otherwise, a
// deadlock will occur.
//
class XrdSecEntityAttrCB
{
public:
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
enum     Action {Delete = -1, 
                 Stop   =  0, 
                 Next   =  1  
                };
 
virtual  Action Attr(const char *key, const char *val) = 0;
 
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
 
         XrdSecEntityAttrCB() {}
virtual ~XrdSecEntityAttrCB() {}
};
#endif