OpenDDS::Security::TokenReader Class Reference

Implements some simple wrapper functions to provide a const API around the Token data structure as specified in the DDS security specification. More...

#include <TokenReader.h>

Collaboration diagram for OpenDDS::Security::TokenReader:

Public Member Functions
	TokenReader (const DDS::Security::Token &token_ref)
virtual	~TokenReader ()
bool	is_nil () const
const char *	get_property_value (const std::string &property_name) const
const DDS::OctetSeq &	get_bin_property_value (const std::string &property_name) const
CORBA::ULong	get_num_properties () const
CORBA::ULong	get_num_bin_properties () const

Private Attributes
const DDS::Security::Token &	token_ref_
const DDS::OctetSeq	_empty_seq_

Detailed Description

Implements some simple wrapper functions to provide a const API around the Token data structure as specified in the DDS security specification.

See the DDS security specification, OMG formal/17-09-20, for a description of the interface this class is implementing.

Definition at line 40 of file TokenReader.h.

Constructor & Destructor Documentation

TokenReader()

OpenDDS::Security::TokenReader::TokenReader ( const DDS::Security::Token &  token_ref )

explicit

Definition at line 32 of file TokenReader.cpp.

: token_ref_(token_ref)
, _empty_seq_()
{
}

~TokenReader()

OpenDDS::Security::TokenReader::~TokenReader ( )

virtual

Definition at line 38 of file TokenReader.cpp.

{
}

Member Function Documentation

get_bin_property_value()

const DDS::OctetSeq & OpenDDS::Security::TokenReader::get_bin_property_value

(

const std::string &

property_name

)

const

Definition at line 59 of file TokenReader.cpp.

References _empty_seq_, DDS::Security::DataHolder::binary_properties, OpenDDS::DCPS::const_sequence_begin(), OpenDDS::DCPS::const_sequence_end(), OPENDDS_END_VERSIONED_NAMESPACE_DECL, and token_ref_.

Referenced by OpenDDS::Security::AuthenticationBuiltInImpl::begin_handshake_reply(), OpenDDS::Security::AuthenticationBuiltInImpl::begin_handshake_request(), OpenDDS::Security::AuthenticationBuiltInImpl::process_final_handshake(), OpenDDS::Security::AuthenticationBuiltInImpl::process_handshake_reply(), and OpenDDS::Security::AccessControlBuiltInImpl::validate_remote_permissions().

{
  typedef ConstSequenceIterator<const DDS::BinaryPropertySeq> iter_t;
  typedef has_property<const DDS::BinaryProperty_t> has_property;

  iter_t begin = const_sequence_begin(token_ref_.binary_properties),
         end = const_sequence_end(token_ref_.binary_properties);

  iter_t result = std::find_if(begin, end, has_property(property_name));

  if (result != end) {
    return result->value;
  }

  return _empty_seq_;
}

get_num_bin_properties()

CORBA::ULong OpenDDS::Security::TokenReader::get_num_bin_properties ( ) const

inline

Definition at line 70 of file TokenReader.h.

References OPENDDS_END_VERSIONED_NAMESPACE_DECL.

{
  return token_ref_.binary_properties.length();
}

get_num_properties()

CORBA::ULong OpenDDS::Security::TokenReader::get_num_properties ( ) const

inline

Definition at line 65 of file TokenReader.h.

{
  return token_ref_.properties.length();
}

get_property_value()

const char * OpenDDS::Security::TokenReader::get_property_value

(

const std::string &

property_name

)

const

Definition at line 42 of file TokenReader.cpp.

References OpenDDS::DCPS::const_sequence_begin(), OpenDDS::DCPS::const_sequence_end(), DDS::Security::DataHolder::properties, and token_ref_.

Referenced by OpenDDS::Security::LocalAuthCredentialData::load_access_permissions(), and OpenDDS::Security::AccessControlBuiltInImpl::validate_local_permissions().

{
  typedef ConstSequenceIterator<const DDS::PropertySeq> iter_t;
  typedef has_property<const DDS::Property_t> has_property;

  iter_t begin = const_sequence_begin(token_ref_.properties),
         end = const_sequence_end(token_ref_.properties);

  iter_t result = std::find_if(begin, end, has_property(property_name));

  if (result != end) {
    return result->value;
  }

  return 0;
}

is_nil()

bool OpenDDS::Security::TokenReader::is_nil ( void  ) const

inline

Definition at line 58 of file TokenReader.h.

Referenced by OpenDDS::Security::AuthenticationBuiltInImpl::begin_handshake_reply(), OpenDDS::Security::AuthenticationBuiltInImpl::begin_handshake_request(), OpenDDS::Security::AuthenticationBuiltInImpl::process_final_handshake(), OpenDDS::Security::AuthenticationBuiltInImpl::process_handshake_reply(), and OpenDDS::Security::AuthenticationBuiltInImpl::validate_remote_identity().

{
  return ((token_ref_.binary_properties.length() == 0)
    && (token_ref_.properties.length() == 0)
    && (token_ref_.class_id[0] == '\0'));
}

Member Data Documentation

_empty_seq_

const DDS::OctetSeq OpenDDS::Security::TokenReader::_empty_seq_

private

Definition at line 55 of file TokenReader.h.

Referenced by get_bin_property_value().

token_ref_

const DDS::Security::Token& OpenDDS::Security::TokenReader::token_ref_

private

Definition at line 54 of file TokenReader.h.

Referenced by get_bin_property_value(), and get_property_value().

---

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

• TokenReader.h
• TokenReader.cpp