OpenDDS::Security::TokenWriter Class Reference

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

#include <TokenWriter.h>

Collaboration diagram for OpenDDS::Security::TokenWriter:

Public Member Functions
	TokenWriter (DDS::Security::Token &token_ref)
	TokenWriter (DDS::Security::Token &token_ref, const std::string &class_id)
virtual	~TokenWriter ()
const TokenReader &	get_reader ()
void	set_class_id (const std::string &class_name)
void	add_property (const char *prop_name, const char *prop_value, bool propagate=true)
void	add_property (const char *prop_name, const DDS::OctetSeq &prop_value, bool propagate=true)
void	add_bin_property (const char *prop_name, const DDS::OctetSeq &prop_value, bool propagate=true)
void	add_bin_property (const char *prop_name, const std::string &prop_value, bool propagate=true)

Private Attributes
DCPS::SequenceBackInsertIterator< DDS::BinaryPropertySeq >	binary_property_inserter_
DCPS::SequenceBackInsertIterator< DDS::PropertySeq >	property_inserter_
DDS::Security::Token &	token_ref_
OpenDDS::Security::TokenReader	reader_

Detailed Description

Implements some simple wrapper functions to provide a non-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 43 of file TokenWriter.h.

Constructor & Destructor Documentation

TokenWriter() [1/2]

OpenDDS::Security::TokenWriter::TokenWriter ( DDS::Security::Token &  token_ref )

explicit

Definition at line 16 of file TokenWriter.cpp.

: binary_property_inserter_(token_ref.binary_properties)
, property_inserter_(token_ref.properties)
, token_ref_(token_ref)
, reader_(token_ref)
{

}

TokenWriter() [2/2]

OpenDDS::Security::TokenWriter::TokenWriter	(	DDS::Security::Token &	token_ref,
		const std::string &	class_id
	)

Definition at line 25 of file TokenWriter.cpp.

References DDS::Security::DataHolder::class_id.

: binary_property_inserter_(token_ref.binary_properties)
, property_inserter_(token_ref.properties)
, token_ref_(token_ref)
, reader_(token_ref)
{
  token_ref.class_id = class_id.c_str();
}

~TokenWriter()

OpenDDS::Security::TokenWriter::~TokenWriter ( )

virtual

Definition at line 34 of file TokenWriter.cpp.

{
}

Member Function Documentation

add_bin_property() [1/2]

void OpenDDS::Security::TokenWriter::add_bin_property	(	const char *	prop_name,
		const DDS::OctetSeq &	prop_value,
		bool	propagate = true
	)

Definition at line 59 of file TokenWriter.cpp.

References binary_property_inserter_, DDS::BinaryProperty_t::name, DDS::BinaryProperty_t::propagate, and DDS::BinaryProperty_t::value.

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

{
  DDS::BinaryProperty_t p;
  p.name = prop_name;
  p.value = prop_value;
  p.propagate = propagate;
  *binary_property_inserter_ = p;
}

add_bin_property() [2/2]

void OpenDDS::Security::TokenWriter::add_bin_property	(	const char *	prop_name,
		const std::string &	prop_value,
		bool	propagate = true
	)

Definition at line 68 of file TokenWriter.cpp.

References binary_property_inserter_, DDS::BinaryProperty_t::name, OPENDDS_END_VERSIONED_NAMESPACE_DECL, DDS::BinaryProperty_t::propagate, and DDS::BinaryProperty_t::value.

{
  DDS::BinaryProperty_t p;
  p.name = prop_name;
  p.propagate = propagate;
  p.value.length(static_cast<unsigned int>(prop_value.size() + 1 /* For null */));
  std::memcpy(p.value.get_buffer(),
              prop_value.c_str(),
              p.value.length());
  *binary_property_inserter_ = p;
}

add_property() [1/2]

void OpenDDS::Security::TokenWriter::add_property	(	const char *	prop_name,
		const char *	prop_value,
		bool	propagate = true
	)

Definition at line 38 of file TokenWriter.cpp.

References DDS::Property_t::name, DDS::Property_t::propagate, property_inserter_, and DDS::Property_t::value.

Referenced by OpenDDS::Security::AuthenticationBuiltInImpl::get_identity_token(), and OpenDDS::Security::AccessControlBuiltInImpl::validate_local_permissions().

{
  DDS::Property_t p;
  p.name = prop_name;
  p.value = prop_value;
  p.propagate = propagate;
  *property_inserter_ = p;
}

add_property() [2/2]

void OpenDDS::Security::TokenWriter::add_property	(	const char *	prop_name,
		const DDS::OctetSeq &	prop_value,
		bool	propagate = true
	)

Definition at line 47 of file TokenWriter.cpp.

References DDS::Property_t::name, DDS::Property_t::propagate, property_inserter_, and DDS::Property_t::value.

{
  std::ostringstream out;
  out.write(reinterpret_cast<const char*>(prop_value.get_buffer()), prop_value.length());

  DDS::Property_t p;
  p.name = prop_name;
  p.value = out.str().c_str();
  p.propagate = propagate;
  *property_inserter_ = p;
}

get_reader()

const TokenReader & OpenDDS::Security::TokenWriter::get_reader ( )

inline

Definition at line 67 of file TokenWriter.h.

{
  return reader_;
}

set_class_id()

void OpenDDS::Security::TokenWriter::set_class_id ( const std::string &  class_name )

inline

Definition at line 72 of file TokenWriter.h.

References OPENDDS_END_VERSIONED_NAMESPACE_DECL.

{
  token_ref_.class_id = class_id.c_str();
}

Member Data Documentation

binary_property_inserter_

DCPS::SequenceBackInsertIterator<DDS::BinaryPropertySeq> OpenDDS::Security::TokenWriter::binary_property_inserter_

private

Definition at line 61 of file TokenWriter.h.

Referenced by add_bin_property().

property_inserter_

DCPS::SequenceBackInsertIterator<DDS::PropertySeq> OpenDDS::Security::TokenWriter::property_inserter_

private

Definition at line 62 of file TokenWriter.h.

Referenced by add_property().

reader_

OpenDDS::Security::TokenReader OpenDDS::Security::TokenWriter::reader_

private

Definition at line 64 of file TokenWriter.h.

token_ref_

DDS::Security::Token& OpenDDS::Security::TokenWriter::token_ref_

private

Definition at line 63 of file TokenWriter.h.

---

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

• TokenWriter.h
• TokenWriter.cpp