ndn::security::pib::CertificateContainer Class Reference

Container of certificates of a key. More...

#include <certificate-container.hpp>

Inheritance diagram for ndn::security::pib::CertificateContainer:

Collaboration diagram for ndn::security::pib::CertificateContainer:

Classes
class	const_iterator

Public Types
typedef const_iterator	iterator

Public Member Functions
const_iterator	begin () const
const_iterator	end () const
const_iterator	find (const Name &certName) const
size_t	size () const
void	add (const v2::Certificate &certificate)
	Add certificate into the container. More...
void	remove (const Name &certName)
	Remove a certificate with certName from the container. More...
v2::Certificate	get (const Name &certName) const
	Get a certificate with certName from the container. More...
bool	isConsistent () const
	Check if the container is consistent with the backend storage. More...
const std::set< Name > &	getCertNames () const
const std::unordered_map< Name, v2::Certificate > &	getCache () const

Public Attributes
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE	__pad0__: CertificateContainer(const Name& keyName
NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE shared_ptr< PibImpl >	pibImpl

Friends
class	detail::KeyImpl

Detailed Description

Container of certificates of a key.

The container is used to search/enumerate certificates of a key. The container can be created only by detail::KeyImpl.

Definition at line 47 of file certificate-container.hpp.

Member Typedef Documentation

iterator

typedef const_iterator ndn::security::pib::CertificateContainer::iterator

Definition at line 86 of file certificate-container.hpp.

Member Function Documentation

begin()

CertificateContainer::const_iterator ndn::security::pib::CertificateContainer::begin

(

)

const

Definition at line 92 of file certificate-container.cpp.

end()

CertificateContainer::const_iterator ndn::security::pib::CertificateContainer::end

(

)

const

Definition at line 98 of file certificate-container.cpp.

find()

CertificateContainer::const_iterator ndn::security::pib::CertificateContainer::find

(

const Name &

certName

)

const

Definition at line 104 of file certificate-container.cpp.

size()

size_t ndn::security::pib::CertificateContainer::size

(

)

const

Definition at line 110 of file certificate-container.cpp.

add()

void ndn::security::pib::CertificateContainer::add

(

const v2::Certificate &

certificate

)

Add certificate into the container.

Exceptions

std::invalid_argument

the name of certificate does not match the key name

Definition at line 116 of file certificate-container.cpp.

References ndn::security::v2::Certificate::getKeyName(), ndn::Data::getName(), NDN_THROW, and ndn::Name::toUri().

Referenced by ndn::security::pib::detail::KeyImpl::addCertificate().

remove()

void ndn::security::pib::CertificateContainer::remove

(

const Name &

certName

)

Remove a certificate with certName from the container.

Exceptions

std::invalid_argument

certName does not match the key name

Definition at line 129 of file certificate-container.cpp.

References ndn::security::v2::extractKeyNameFromCertName(), ndn::security::v2::Certificate::isValidName(), NDN_THROW, and ndn::Name::toUri().

Referenced by ndn::security::pib::detail::KeyImpl::removeCertificate().

get()

v2::Certificate ndn::security::pib::CertificateContainer::get

(

const Name &

certName

)

const

Get a certificate with certName from the container.

Exceptions

std::invalid_argument	certName does not match the key name
Pib::Error	the certificate does not exist

Definition at line 143 of file certificate-container.cpp.

References ndn::security::v2::extractKeyNameFromCertName(), ndn::security::v2::Certificate::isValidName(), NDN_THROW, and ndn::Name::toUri().

Referenced by ndn::security::pib::detail::KeyImpl::getCertificate(), and ndn::security::pib::detail::KeyImpl::setDefaultCertificate().

isConsistent()

bool ndn::security::pib::CertificateContainer::isConsistent

(

)

const

Check if the container is consistent with the backend storage.

Note

this method is heavyweight and should be used in debugging mode only.

Definition at line 161 of file certificate-container.cpp.

Referenced by ndn::security::pib::detail::KeyImpl::addCertificate(), ndn::security::pib::detail::KeyImpl::getCertificate(), ndn::security::pib::detail::KeyImpl::getCertificates(), ndn::security::pib::detail::KeyImpl::getDefaultCertificate(), ndn::security::pib::detail::KeyImpl::removeCertificate(), and ndn::security::pib::detail::KeyImpl::setDefaultCertificate().

getCertNames()

const std::set<Name>& ndn::security::pib::CertificateContainer::getCertNames ( ) const

inline

Definition at line 138 of file certificate-container.hpp.

getCache()

const std::unordered_map<Name, v2::Certificate>& ndn::security::pib::CertificateContainer::getCache ( ) const

inline

Definition at line 144 of file certificate-container.hpp.

Friends And Related Function Documentation

detail::KeyImpl

friend class detail::KeyImpl

friend

Definition at line 157 of file certificate-container.hpp.

Member Data Documentation

__pad0__

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE ndn::security::pib::CertificateContainer::__pad0__

Definition at line 130 of file certificate-container.hpp.

pibImpl

NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE shared_ptr<PibImpl> ndn::security::pib::CertificateContainer::pibImpl

Definition at line 135 of file certificate-container.hpp.

---

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

• ndnSIM/ndn-cxx/ndn-cxx/security/pib/certificate-container.hpp
• ndnSIM/ndn-cxx/ndn-cxx/security/pib/certificate-container.cpp