XrdSecEntityAttr Class Reference

#include <XrdSecEntityAttr.hh>

Inheritance diagram for XrdSecEntityAttr:

Collaboration diagram for XrdSecEntityAttr:

Public Member Functions
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)
	~XrdSecEntityAttr ()

Private Attributes
XrdSecEntityXtra *	entXtra

Friends
class	XrdSecEntity

Constructor & Destructor Documentation

XrdSecEntityAttr()

XrdSecEntityAttr::XrdSecEntityAttr ( XrdSecEntityXtra *  xtra )

inline

Constructor and Destructor.

Parameters

xtra	- Pointer to the data for the implementation.

~XrdSecEntityAttr()

XrdSecEntityAttr::~XrdSecEntityAttr ( )

inline

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.

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.

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.

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.

Keys()

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

(

)

Get all the keys for associated attribytes.

Returns

A vector containing all of the keys.

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.

Friends And Related Symbol Documentation

XrdSecEntity

friend class XrdSecEntity

friend

Member Data Documentation

entXtra

XrdSecEntityXtra* XrdSecEntityAttr::entXtra

private

---

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

• XrdSecEntityAttr.hh