TAO_CosTrader  2.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | List of all members
TAO_Policies Class Reference

This class ensures that policies submitted to Lookup make sense, have the correct value types, and don't exceed the maximums set through the Admin Interface. More...

#include <Trader_Utils.h>

Collaboration diagram for TAO_Policies:
Collaboration graph
[legend]

Public Types

enum  POLICY_TYPE {
  STARTING_TRADER, EXACT_TYPE_MATCH, HOP_COUNT, LINK_FOLLOW_RULE,
  MATCH_CARD, RETURN_CARD, SEARCH_CARD, USE_DYNAMIC_PROPERTIES,
  USE_MODIFIABLE_PROPERTIES, USE_PROXY_OFFERS, REQUEST_ID
}
 

Public Member Functions

 TAO_Policies (TAO_Trader_Base &trader, const CosTrading::PolicySeq &policies)
 
 ~TAO_Policies (void)
 
CORBA::ULong search_card (void) const
 
CORBA::ULong match_card (void) const
 
CORBA::ULong return_card (void) const
 
CORBA::Boolean use_modifiable_properties (void) const
 
CORBA::Boolean use_dynamic_properties (void) const
 
CORBA::Boolean use_proxy_offers (void) const
 
CORBA::Boolean exact_type_match (void) const
 
CosTrading::TraderNamestarting_trader (void) const
 
CosTrading::FollowOption link_follow_rule (void) const
 Determine the link follow policy for this query overall. More...
 
CosTrading::FollowOption link_follow_rule (const CosTrading::Link::LinkInfo &link_info) const
 
CORBA::ULong hop_count (void) const
 
CosTrading::Admin::OctetSeqrequest_id (void) const
 
void copy_to_pass (CosTrading::PolicySeq &policy_seq, const CosTrading::Admin::OctetSeq &request_id) const
 Policies to forward to the next trader in a federated query. More...
 
void copy_to_forward (CosTrading::PolicySeq &policy_seq, const CosTrading::TraderName &name) const
 Policies to forward to the next trader in a directed query. More...
 
void copy_in_follow_option (CosTrading::PolicySeq &policy_seq, const CosTrading::Link::LinkInfo &link_info) const
 

Static Public Attributes

static const char * POLICY_NAMES []
 

Private Member Functions

CORBA::ULong ulong_prop (POLICY_TYPE pol) const
 Reconclile a ULong property with its default. More...
 
CORBA::Boolean boolean_prop (POLICY_TYPE pol) const
 Reconcile a Boolean property with its debault. More...
 
 TAO_Policies (const TAO_Policies &)
 
TAO_Policiesoperator= (const TAO_Policies &)
 

Private Attributes

CosTrading::Policypolicies_ [TAO_NUM_POLICIES]
 The policies indexable from the enumerated type. More...
 
TAO_Trader_Basetrader_
 For the validating identifier names. More...
 

Detailed Description

This class ensures that policies submitted to Lookup make sense, have the correct value types, and don't exceed the maximums set through the Admin Interface.

TAO_Policies does an admirable job of reconciling differences between the default parameter settings of the Trader and the import and other policies set by the client. Unbeknownst to its client TAO_Policies hides this arbitration, and records whether the user policy was chosen, or the default. This information gets returned to the invoker of the query method.

Member Enumeration Documentation

This enum represents the relative order that properties are passed from one trader to another. Hence, as recommended by the spec, the starting_trader policies will be the first element in the polcy sequence if it's set for a query.

Enumerator
STARTING_TRADER 
EXACT_TYPE_MATCH 
HOP_COUNT 
LINK_FOLLOW_RULE 
MATCH_CARD 
RETURN_CARD 
SEARCH_CARD 
USE_DYNAMIC_PROPERTIES 
USE_MODIFIABLE_PROPERTIES 
USE_PROXY_OFFERS 
REQUEST_ID 

Constructor & Destructor Documentation

TAO_Policies::TAO_Policies ( TAO_Trader_Base trader,
const CosTrading::PolicySeq policies 
)
TAO_Policies::~TAO_Policies ( void  )
TAO_Policies::TAO_Policies ( const TAO_Policies )
private

Member Function Documentation

CORBA::Boolean TAO_Policies::boolean_prop ( POLICY_TYPE  pol) const
private

Reconcile a Boolean property with its debault.

void TAO_Policies::copy_in_follow_option ( CosTrading::PolicySeq policy_seq,
const CosTrading::Link::LinkInfo link_info 
) const

Determine the link follow policy to pass down the link with <link_name>. This method returns the link_follow_rule for a link whose name is <link_name> using the following formula: If the importer specified a link_follow_rule, policy pass on min(query.link_follow_rule, link.limiting_follow_rule, trader.max_follow_policy) else pass on min(link.def_pass_on_follow_rule, trader.max_follow_policy)

void TAO_Policies::copy_to_forward ( CosTrading::PolicySeq policy_seq,
const CosTrading::TraderName name 
) const

Policies to forward to the next trader in a directed query.

void TAO_Policies::copy_to_pass ( CosTrading::PolicySeq policy_seq,
const CosTrading::Admin::OctetSeq request_id 
) const

Policies to forward to the next trader in a federated query.

CORBA::Boolean TAO_Policies::exact_type_match ( void  ) const
CORBA::ULong TAO_Policies::hop_count ( void  ) const
CosTrading::FollowOption TAO_Policies::link_follow_rule ( void  ) const

Determine the link follow policy for this query overall.

CosTrading::FollowOption TAO_Policies::link_follow_rule ( const CosTrading::Link::LinkInfo link_info) const

Determine the link follow policy for a given <link_name>. This method returns the link_follow_rule for a link whose name is <link_name> using the following formula: if the importer specified a link_follow_rule policy min(trader.max_follow_policy, link.limiting_follow_rule, query.link_follow_rule) else min(trader.max_follow_policy, link.limiting_follow_rule, trader.def_follow_policy)

CORBA::ULong TAO_Policies::match_card ( void  ) const
TAO_Policies& TAO_Policies::operator= ( const TAO_Policies )
private
CosTrading::Admin::OctetSeq * TAO_Policies::request_id ( void  ) const

Return the request_id passed to the query method across a link to another trader.

CORBA::ULong TAO_Policies::return_card ( void  ) const
CORBA::ULong TAO_Policies::search_card ( void  ) const
CosTrading::TraderName * TAO_Policies::starting_trader ( void  ) const

BEGIN SPEC The "starting_trader" policy facilitates the distribution of the trading service itself. It allows an importer to scope a search by choosing to explicitly navigate the links of the trading graph. If the policy is used in a query invocation it is recommended that it be the first policy-value pair; this facilitates an optimal forwarding of the query operation. A "policies" parameter need not include a value for the "starting_trader" policy. Where this policy is present, the first name component is compared against the name held in each link. If no match is found, the InvalidPolicyValue exception is raised. Otherwise, the trader invokes query() on the Lookup interface held by the named link, but passing the "starting_trader" policy with the first component removed. END SPEC

CORBA::ULong TAO_Policies::ulong_prop ( POLICY_TYPE  pol) const
private

Reconclile a ULong property with its default.

CORBA::Boolean TAO_Policies::use_dynamic_properties ( void  ) const
CORBA::Boolean TAO_Policies::use_modifiable_properties ( void  ) const
CORBA::Boolean TAO_Policies::use_proxy_offers ( void  ) const

Member Data Documentation

CosTrading::Policy* TAO_Policies::policies_[TAO_NUM_POLICIES]
private

The policies indexable from the enumerated type.

const char * TAO_Policies::POLICY_NAMES
static
Initial value:
=
{
"starting_trader",
"exact_type_match",
"hop_count",
"link_follow_rule",
"match_card",
"return_card",
"search_card",
"use_dynamic_properties",
"use_modifiable_properties",
"use_proxy_offers",
"request_id"
}
TAO_Trader_Base& TAO_Policies::trader_
private

For the validating identifier names.


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