XrdSecEntityAttr Class Reference

#include <XrdSecEntityAttr.hh>

Inheritance diagram for XrdSecEntityAttr:

Collaboration diagram for XrdSecEntityAttr:

Public Member Functions
	XrdSecEntityAttr (XrdSecEntityXtra *xtra)
	~XrdSecEntityAttr ()
bool	Add (const std::string &key, const std::string &val, bool replace=false)
bool	Add (XrdSecAttr &attr)
bool	Get (const std::string &key, std::string &val)
XrdSecAttr *	Get (const void *sigkey)
std::vector< std::string >	Keys ()
void	List (XrdSecEntityAttrCB &attrCB)

Friends
class	XrdSecEntity

Detailed Description

Definition at line 54 of file XrdSecEntityAttr.hh.

Constructor & Destructor Documentation

XrdSecEntityAttr()

XrdSecEntityAttr::XrdSecEntityAttr ( XrdSecEntityXtra * xtra )

inline

Constructor and Destructor.

Parameters

xtra	- Pointer to the data for the implementation.

Definition at line 130 of file XrdSecEntityAttr.hh.

: entXtra(xtra) {}

Referenced by XrdSecEntityXtra::XrdSecEntityXtra().

Here is the caller graph for this function:

~XrdSecEntityAttr()

XrdSecEntityAttr::~XrdSecEntityAttr ( )

inline

Definition at line 132 of file XrdSecEntityAttr.hh.

{}

Member Function Documentation

Add() [1/2]

bool XrdSecEntityAttr::Add	(	const std::string &	key,
		const std::string &	val,
		bool	replace = false )

Add a key-value attribute to this entity. If one exists it is replaced.

Parameters

key	- Reference to the key.
val	- Reference to the value.
replace	- When true, any existing key-value is replaced. Otherwise, the add is not performed.

Returns

True, the key-value was added or replaced.

False, the key already exists so he value was not added.

Definition at line 59 of file XrdSecEntityAttr.cc.

{
   XrdSysMutexHelper mHelp(entXtra->xMutex);
   std::map<std::string, std::string>::iterator it;
   bool found = false;
 
// Check if this attribute already exists
//
   it = entXtra->attrMap.find(key);
   if (it != entXtra->attrMap.end())
      {if (!replace) return false;
       found = true;
      }
 
// Add or replace the value
//
   if (found) it->second = val;
      else entXtra->attrMap.insert(std::make_pair(key, val));
   return true;
}

Add() [2/2]

bool XrdSecEntityAttr::Add

(

XrdSecAttr &

attr

)

Add an attribute object to this entity.

Parameters

attr	- Reference to the attribute object.

Returns

True, the object was added.

False, the object was not added because such an object exists.

Definition at line 41 of file XrdSecEntityAttr.cc.

{
   XrdSysMutexHelper mHelp(entXtra->xMutex);
   std::vector<XrdSecAttr*>::iterator it;
 
// Check if this attribute already exists
//
   for (it = entXtra->attrVec.begin(); it != entXtra->attrVec.end(); it++)
       if ((*it)->Signature == attr.Signature) return false;
 
// Add the attribute object to our list of objects
//
   entXtra->attrVec.push_back(&attr);
   return true;
}

Referenced by Macaroons::Authz::Access(), XrdAccSciTokens::Access(), XrdAccEntity::PutEntity(), and XrdOfs::rename().

Here is the caller graph for this function:

Get() [1/2]

bool XrdSecEntityAttr::Get	(	const std::string &	key,
		std::string &	val )

Get an attribute key value associated with this entity.

Parameters

key	- The reference to the key.
val	- The reference to the string object to receive the value.

Returns

Upon success true is returned. If the key does not exist, false is returned and the val object remains unchanged.

Definition at line 102 of file XrdSecEntityAttr.cc.

{
   XrdSysMutexHelper mHelp(entXtra->xMutex);
   std::map<std::string, std::string>::iterator it;
 
// Return pointer to the attribute if it exists
//
   it = entXtra->attrMap.find(key);
   if (it != entXtra->attrMap.end())
      {val = it->second;
       return true;
      }
 
// The key does not exists
//
   return false;
}

Get() [2/2]

XrdSecAttr * XrdSecEntityAttr::Get

(

const void *

sigkey

)

Get an attribute object associated with this entity.

Parameters

sigkey

- A unique attribute object signature key.

Returns

Upon success a pointer to the attribute object is returned. Otherwise, a nil pointer is returned.

Definition at line 85 of file XrdSecEntityAttr.cc.

{
   XrdSysMutexHelper mHelp(entXtra->xMutex);
   std::vector<XrdSecAttr*>::iterator it;
 
// Return pointer to the attribute if it exists
//
   for (it = entXtra->attrVec.begin(); it != entXtra->attrVec.end(); it++)
       if ((*it)->Signature == sigkey) return *it;
 
// Attribute not found
//
   return (XrdSecAttr *)0;
}

Referenced by XrdAccAccess::Access(), XrdVomsMapfile::Apply(), XrdAccAccess::Audit(), XrdAccEntity::GetEntity(), and XrdThrottle::File::open().

Here is the caller graph for this function:

Keys()

std::vector< std::string > XrdSecEntityAttr::Keys

(

)

Get all the keys for associated attribytes.

Returns

A vector containing all of the keys.

Definition at line 124 of file XrdSecEntityAttr.cc.

{
   XrdSysMutexHelper mHelp(entXtra->xMutex);
   std::map<std::string, std::string>::iterator itM;
   std::vector<std::string> keyVec;
 
   for (itM  = entXtra->attrMap.begin();
        itM != entXtra->attrMap.end(); itM++) keyVec.push_back(itM->first);
 
   return keyVec;
}

List()

void XrdSecEntityAttr::List

(

XrdSecEntityAttrCB &

attrCB

)

List key-value pairs via iterative callback on passed ovject.

Parameters

attrCB

- Reference to the callback object to receive list entries.

Definition at line 140 of file XrdSecEntityAttr.cc.

{
   XrdSysMutexHelper mHelp(entXtra->xMutex);
   std::map<std::string, std::string>::iterator itM;
   std::vector<const char *> attrDel;
   std::vector<const char *>::iterator itV;
   XrdSecEntityAttrCB::Action rc = XrdSecEntityAttrCB::Action::Stop;
 
   for (itM  = entXtra->attrMap.begin();
        itM != entXtra->attrMap.end(); itM++)
       {rc = attrCB.Attr(itM->first.c_str(), itM->second.c_str());
        if (rc == XrdSecEntityAttrCB::Stop) break;
           else if (rc == XrdSecEntityAttrCB::Delete)
                   attrDel.push_back(itM->first.c_str());
       }
 
   if (rc != XrdSecEntityAttrCB::Stop) attrCB.Attr(0, 0);
 
   for (itV  = attrDel.begin(); itV != attrDel.end(); itV++)
       entXtra->attrMap.erase(std::string(*itV));
}

References XrdSecEntityAttrCB::Attr(), XrdSecEntityAttrCB::Delete, and XrdSecEntityAttrCB::Stop.

Here is the call graph for this function:

Friends And Related Symbol Documentation

XrdSecEntity

friend class XrdSecEntity

friend

Definition at line 57 of file XrdSecEntityAttr.hh.

References XrdSecEntity.

Referenced by XrdSecEntity.

---

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

• XrdSecEntityAttr.hh
• XrdSecEntityAttr.cc