Public Member Functions | Static Public Attributes

arm4::ArmIdentityPropertiesTransaction Class Reference
[ARM 4.0 Properties, Identity properties]

Extends ArmIdentityProperties for transactions by adding a URI property. More...

Inheritance diagram for arm4::ArmIdentityPropertiesTransaction:
arm4::ArmIdentityProperties arm4::ArmInterface

List of all members.

Public Member Functions

 ArmIdentityPropertiesTransaction (const std::vector< std::string > &identityNames, const std::vector< std::string > &identityValues, const std::vector< std::string > &contextNames=NullVector, const std::string &uriValue=NullString)
 Constructs an object that extends ArmIdentityProperties to also include a URI property, which is also immutable.
const std::string & getURIValue () const

Static Public Attributes

static const
ArmIdentityPropertiesTransaction 		Null
 A Null ArmIdentityPropertiesTransaction instance.

Detailed Description

Extends ArmIdentityProperties for transactions by adding a URI property.

Unlike the other identity properties, the URI property is implicitly named.

Like other identity properties, it is the same for all instances of the same transaction, and is immutable. In practice, this means that the URI value may be truncated from the URI that is actually used. In particular, parameters that are appended to the end of a URI will often be truncated because they are often different each time the URI is invoked. In this case, the parameters might be provided as part of the URI context value of an ArmTransaction object.

Author:
ARM Working Group of The Open Group, MyARM GmbH

Constructor & Destructor Documentation

arm4::ArmIdentityPropertiesTransaction::ArmIdentityPropertiesTransaction ( const std::vector< std::string > &  identityNames,
const std::vector< std::string > &  identityValues,
const std::vector< std::string > &  contextNames = NullVector,
const std::string &  uriValue = NullString 
)

Constructs an object that extends ArmIdentityProperties to also include a URI property, which is also immutable.

See the ArmIdentityProperties description for all other parameters.

Parameters:
identityNames an vector of identity property names.
identityValues an vector of identity property values.
contextNames an vector of identity property names.
uriValue the URI property value.

Member Function Documentation

const std::string& arm4::ArmIdentityPropertiesTransaction::getURIValue (  )  const
Returns:
the string representing the URI value, if any.

The maximum length is ArmConstants::PROPERTY_URI_MAX_LENGTH characters. The returned value will be NullString if the value is set to NullString.

The documentation for this class was generated from the following file:
MyARM
Documentation generated on Thu May 24 2018 22:24:17. © 2018 by MyARM GmbH