Back to index

nordugrid-arc-nox  1.1.0~rc6
Public Member Functions | Static Public Attributes | Protected Member Functions
Arc::SecAttr Class Reference

This is an abstract interface to a security attribute. More...

#include <SecAttr.h>

Inheritance diagram for Arc::SecAttr:
Inheritance graph
[legend]
Collaboration diagram for Arc::SecAttr:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 SecAttr ()
 representation for GACL policy
virtual ~SecAttr ()
bool operator== (const SecAttr &b) const
 This function should (in inheriting classes) return true if this and b are considered to represent same content.
bool operator!= (const SecAttr &b) const
 This is a convenience function to allow the usage of "not equal" conditions and need not be overridden.
virtual operator bool () const
 This function should return false if the value is to be considered null, e.g.
virtual bool Export (SecAttrFormat format, std::string &val) const
 Convert internal structure into specified format.
virtual bool Export (SecAttrFormat format, XMLNode &val) const
 Convert internal structure into specified format.
virtual bool Import (SecAttrFormat format, const std::string &val)
 Fills internal structure from external object of specified format.
virtual bool Import (SecAttrFormat format, XMLNode val)

Static Public Attributes

static SecAttrFormat UNDEFINED
static SecAttrFormat ARCAuth
 own serialization/deserialization format
static SecAttrFormat XACML
 representation for ARC authorization policy
static SecAttrFormat SAML
 represenation for XACML policy
static SecAttrFormat GACL
 suitable for inclusion into SAML structures

Protected Member Functions

virtual bool equal (const SecAttr &b) const

Detailed Description

This is an abstract interface to a security attribute.

This class is meant to be inherited to implement security attributes. Depending on what data it needs to store inheriting classes may need to implement constructor and destructor. They must however override the equality and the boolean operators. The equality is meant to compare security attributes. The prototype implies that all attributes are comparable to all others. This behaviour should be modified as needed by using dynamic_cast operations. The boolean cast operation is meant to embody "nullness" if that is applicable to the particular type.

Definition at line 37 of file SecAttr.h.


Constructor & Destructor Documentation

Arc::SecAttr::SecAttr ( ) [inline]

representation for GACL policy

Definition at line 44 of file SecAttr.h.

{};
virtual Arc::SecAttr::~SecAttr ( ) [inline, virtual]

Definition at line 45 of file SecAttr.h.

{};

Member Function Documentation

bool Arc::SecAttr::equal ( const SecAttr b) const [protected, virtual]
bool Arc::SecAttr::Export ( SecAttrFormat  format,
std::string &  val 
) const [virtual]

Convert internal structure into specified format.

Returns false if format is not supported/suitable for this attribute.

Definition at line 20 of file SecAttr.cpp.

                                                              {
  NS ns;
  XMLNode x(ns, "");
  if(!Export(format,x)) return false;
  x.GetXML(val);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool Arc::SecAttr::Export ( SecAttrFormat  format,
XMLNode val 
) const [virtual]

Convert internal structure into specified format.

Returns false if format is not supported/suitable for this attribute. XML node referenced by is turned into top level element of specified format.

Reimplemented in Arc::TCPSecAttr, Arc::MultiSecAttr, TestSecAttr, Arc::TLSSecAttr, Arc::SOAPSecAttr, Arc::HTTPSecAttr, ArcSec::SAMLAssertionSecAttr, SPService::SAMLAssertionSecAttr, ArcSec::DelegationMultiSecAttr, ISIS::ISISSecAttr, and ArcSec::DelegationSecAttr.

Definition at line 28 of file SecAttr.cpp.

                                                  {
  return false;
}
bool Arc::SecAttr::Import ( SecAttrFormat  format,
const std::string &  val 
) [virtual]

Fills internal structure from external object of specified format.

Returns false if failed to do. The usage pattern for this method is not defined and it is provided only to make class symmetric. Hence it's implementation is not required yet.

Definition at line 32 of file SecAttr.cpp.

                                                              {
  XMLNode x(val);
  if(!x) return false;
  return Import(format,x);
}
bool Arc::SecAttr::Import ( SecAttrFormat  format,
XMLNode  val 
) [virtual]

Reimplemented in Arc::MultiSecAttr.

Definition at line 38 of file SecAttr.cpp.

                                           {
  return false;
}
Arc::SecAttr::operator bool ( void  ) const [virtual]

This function should return false if the value is to be considered null, e.g.

if it hasn't been set or initialized. In other cases it should return true.

Reimplemented in Arc::MultiSecAttr, TestSecAttr, Arc::TLSSecAttr, Arc::SOAPSecAttr, Arc::HTTPSecAttr, ArcSec::SAMLAssertionSecAttr, SPService::SAMLAssertionSecAttr, ISIS::ISISSecAttr, and ArcSec::DelegationSecAttr.

Definition at line 16 of file SecAttr.cpp.

                             {
  return false;
}
bool Arc::SecAttr::operator!= ( const SecAttr b) const [inline]

This is a convenience function to allow the usage of "not equal" conditions and need not be overridden.

Definition at line 54 of file SecAttr.h.

{ return !equal(b); };

Here is the call graph for this function:

bool Arc::SecAttr::operator== ( const SecAttr b) const [inline]

This function should (in inheriting classes) return true if this and b are considered to represent same content.

Identifying and restricting the type of b should be done using dynamic_cast operations. Currently it is not defined how comparison methods to be used. Hence their implementation is not required.

Definition at line 51 of file SecAttr.h.

{ return equal(b); };

Here is the call graph for this function:


Member Data Documentation

own serialization/deserialization format

Definition at line 40 of file SecAttr.h.

suitable for inclusion into SAML structures

Definition at line 43 of file SecAttr.h.

represenation for XACML policy

Definition at line 42 of file SecAttr.h.

Definition at line 39 of file SecAttr.h.

representation for ARC authorization policy

Definition at line 41 of file SecAttr.h.


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