xorp

XrlPolicyTargetBase Class Reference

Inheritance diagram for XrlPolicyTargetBase:
XrlPolicyTarget

List of all members.

Classes

struct  handler_table

Public Member Functions

 XrlPolicyTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlPolicyTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.
 XrlPolicyTargetBase (XrlCmdMap *cmds=0)
 Constructor.
virtual ~XrlPolicyTargetBase ()
 Destructor.
bool set_command_map (XrlCmdMap *cmds)
 Set command map.
const string & get_name () const
 Get Xrl instance name associated with command map.
const char * version () const
 Get version string of instance.

Protected Member Functions

virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_create_term (const string &policy, const string &order, const string &term)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_delete_term (const string &policy, const string &term)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_update_term_block (const string &policy, const string &term, const uint32_t &block, const string &order, const string &statement)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_create_policy (const string &policy)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_delete_policy (const string &policy)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_create_set (const string &set)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_update_set (const string &type, const string &set, const string &elements)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_delete_set (const string &set)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_add_to_set (const string &type, const string &set, const string &element)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_delete_from_set (const string &type, const string &set, const string &element)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_done_global_policy_conf ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_import (const string &protocol, const string &policies, const string &modifier)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_export (const string &protocol, const string &policies, const string &modifier)=0
virtual XrlCmdError policy_0_1_add_varmap (const string &protocol, const string &variable, const string &type, const string &access, const uint32_t &id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_dump_state (const uint32_t &id, string &state)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_set_proto_target (const string &protocol, const string &target)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError cli_processor_0_1_process_command (const string &processor_name, const string &cli_term_name, const uint32_t &cli_session_id, const string &command_name, const string &command_args, string &ret_processor_name, string &ret_cli_term_name, uint32_t &ret_cli_session_id, string &ret_command_output)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_target_name (string &name)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_version (string &version)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_get_status (uint32_t &status, string &reason)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_shutdown ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError common_0_1_startup ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_birth (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError finder_event_observer_0_1_xrl_target_death (const string &target_class, const string &target_instance)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_create_term (const string &policy, const string &order, const string &term)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_delete_term (const string &policy, const string &term)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_update_term_block (const string &policy, const string &term, const uint32_t &block, const string &order, const string &statement)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_create_policy (const string &policy)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_delete_policy (const string &policy)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_create_set (const string &set)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_update_set (const string &type, const string &set, const string &elements)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_delete_set (const string &set)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_add_to_set (const string &type, const string &set, const string &element)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_delete_from_set (const string &type, const string &set, const string &element)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_done_global_policy_conf ()=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_import (const string &protocol, const string &policies, const string &modifier)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_export (const string &protocol, const string &policies, const string &modifier)=0
virtual XrlCmdError policy_0_1_add_varmap (const string &protocol, const string &variable, const string &type, const string &access, const uint32_t &id)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_dump_state (const uint32_t &id, string &state)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError policy_0_1_set_proto_target (const string &protocol, const string &target)=0
 Pure-virtual function that needs to be implemented to:
virtual XrlCmdError cli_processor_0_1_process_command (const string &processor_name, const string &cli_term_name, const uint32_t &cli_session_id, const string &command_name, const string &command_args, string &ret_processor_name, string &ret_cli_term_name, uint32_t &ret_cli_session_id, string &ret_command_output)=0
 Pure-virtual function that needs to be implemented to:

Protected Attributes

XrlCmdMap_cmds

Private Member Functions

XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_create_term (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_delete_term (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_update_term_block (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_create_policy (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_delete_policy (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_create_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_update_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_delete_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_add_to_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_delete_from_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_done_global_policy_conf (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_import (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_export (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_add_varmap (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_dump_state (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_set_proto_target (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_cli_processor_0_1_process_command (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()
XrlCmdRT handle_common_0_1_get_target_name (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_version (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_get_status (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_shutdown (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_common_0_1_startup (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_birth (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_finder_event_observer_0_1_xrl_target_death (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_create_term (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_delete_term (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_update_term_block (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_create_policy (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_delete_policy (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_create_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_update_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_delete_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_add_to_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_delete_from_set (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_done_global_policy_conf (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_import (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_export (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_add_varmap (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_dump_state (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_policy_0_1_set_proto_target (const XrlArgs &in, XrlCmdOT out)
XrlCmdRT handle_cli_processor_0_1_process_command (const XrlArgs &in, XrlCmdOT out)
void add_handlers ()
void remove_handlers ()

Static Private Attributes

static struct handler_table handlers []
static const size_t num_handlers = (sizeof(XrlPolicyTargetBase::handlers) / sizeof(XrlPolicyTargetBase::handlers[0]))

Constructor & Destructor Documentation

XrlPolicyTargetBase::XrlPolicyTargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
XrlPolicyTargetBase::~XrlPolicyTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.

XrlPolicyTargetBase::XrlPolicyTargetBase ( XrlCmdMap cmds = 0)

Constructor.

Parameters:
cmdsan XrlCmdMap that the commands associated with the target should be added to. This is typically the XrlRouter associated with the target.
virtual XrlPolicyTargetBase::~XrlPolicyTargetBase ( ) [virtual]

Destructor.

Dissociates instance commands from command map.


Member Function Documentation

virtual XrlCmdError XrlPolicyTargetBase::cli_processor_0_1_process_command ( const string &  processor_name,
const string &  cli_term_name,
const uint32_t &  cli_session_id,
const string &  command_name,
const string &  command_args,
string &  ret_processor_name,
string &  ret_cli_term_name,
uint32_t &  ret_cli_session_id,
string &  ret_command_output 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Process a CLI command.

Parameters:
processor_namethe processor name for this command.
cli_term_namethe terminal name the command was entered from.
cli_session_idthe CLI session ID the command was entered from.
command_namethe command name to process.
command_argsthe command arguments to process.
ret_processor_namethe processor name to return back to the CLI.
ret_cli_term_namethe terminal name to return back.
ret_cli_session_idthe CLI session ID to return back.
ret_command_outputthe command output to return back.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::cli_processor_0_1_process_command ( const string &  processor_name,
const string &  cli_term_name,
const uint32_t &  cli_session_id,
const string &  command_name,
const string &  command_args,
string &  ret_processor_name,
string &  ret_cli_term_name,
uint32_t &  ret_cli_session_id,
string &  ret_command_output 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Process a CLI command.

Parameters:
processor_namethe processor name for this command.
cli_term_namethe terminal name the command was entered from.
cli_session_idthe CLI session ID the command was entered from.
command_namethe command name to process.
command_argsthe command arguments to process.
ret_processor_namethe processor name to return back to the CLI.
ret_cli_term_namethe terminal name to return back.
ret_cli_session_idthe CLI session ID to return back.
ret_command_outputthe command output to return back.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_get_status ( uint32_t &  status,
string &  reason 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get status of Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_get_target_name ( string &  name) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get name of Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_get_version ( string &  version) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Get version string from Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_shutdown ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request clean shutdown of Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::common_0_1_startup ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Request a startup of Xrl Target

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::finder_event_observer_0_1_xrl_target_birth ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target birth to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::finder_event_observer_0_1_xrl_target_death ( const string &  target_class,
const string &  target_instance 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Announce target death to observer.

Parameters:
target_classthe target class name.
target_instancethe target instance name.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_add_to_set ( const string &  type,
const string &  set,
const string &  element 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add an element to a set.

Parameters:
typethe type of the set.
setname of the set.
elementthe element to add.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_add_to_set ( const string &  type,
const string &  set,
const string &  element 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add an element to a set.

Parameters:
typethe type of the set.
setname of the set.
elementthe element to add.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_add_varmap ( const string &  protocol,
const string &  variable,
const string &  type,
const string &  access,
const uint32_t &  id 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add a variable to the varmap configuration.

Parameters:
protocolthe protocol this variable is available to.
variablename of the variable.
typethe type of the variable.
accessthe permissions on the variable (r/rw).
idunique id for this var. Scoped by protocol.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_add_varmap ( const string &  protocol,
const string &  variable,
const string &  type,
const string &  access,
const uint32_t &  id 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Add a variable to the varmap configuration.

Parameters:
protocolthe protocol this variable is available to.
variablename of the variable.
typethe type of the variable.
accessthe permissions on the variable (r/rw).
idunique id for this var. Scoped by protocol.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_create_policy ( const string &  policy) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a policy.

Parameters:
policyname of the policy.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_create_policy ( const string &  policy) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a policy.

Parameters:
policyname of the policy.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_create_set ( const string &  set) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a set.

Parameters:
setname of the set.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_create_set ( const string &  set) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a set.

Parameters:
setname of the set.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_create_term ( const string &  policy,
const string &  order,
const string &  term 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a term in a policy. The term will be the last term in the policy statement.

Parameters:
policythe name of the policy.
orderposition of term.
termthe name of the term.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_create_term ( const string &  policy,
const string &  order,
const string &  term 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Create a term in a policy. The term will be the last term in the policy statement.

Parameters:
policythe name of the policy.
orderposition of term.
termthe name of the term.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_delete_from_set ( const string &  type,
const string &  set,
const string &  element 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete an element from a set.

Parameters:
typethe type of the set.
setname of the set.
elementthe element to delete.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_delete_from_set ( const string &  type,
const string &  set,
const string &  element 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete an element from a set.

Parameters:
typethe type of the set.
setname of the set.
elementthe element to delete.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_delete_policy ( const string &  policy) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a policy.

Parameters:
policyname of the policy.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_delete_policy ( const string &  policy) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a policy.

Parameters:
policyname of the policy.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_delete_set ( const string &  set) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a set.

Parameters:
setname of the set.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_delete_set ( const string &  set) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a set.

Parameters:
setname of the set.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_delete_term ( const string &  policy,
const string &  term 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a term in a policy.

Parameters:
policythe name of the policy.
termthe name of the term.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_delete_term ( const string &  policy,
const string &  term 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Delete a term in a policy.

Parameters:
policythe name of the policy.
termthe name of the term.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_done_global_policy_conf ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Commit the configuration.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_done_global_policy_conf ( ) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Commit the configuration.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_dump_state ( const uint32_t &  id,
string &  state 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Dump state of policy manager. To be used ONLY for debugging.

Parameters:
idwhich aspect of the internal state to dump.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_dump_state ( const uint32_t &  id,
string &  state 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Dump state of policy manager. To be used ONLY for debugging.

Parameters:
idwhich aspect of the internal state to dump.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_import ( const string &  protocol,
const string &  policies,
const string &  modifier 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Replace import/export policies for a protocol. Will normally cause a delayed commit.

Parameters:
protocolprotocol for which policies must be replaced.
policiescomma separated list of policies.
modifiera match statement to insert in each policy.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_import ( const string &  protocol,
const string &  policies,
const string &  modifier 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Replace import/export policies for a protocol. Will normally cause a delayed commit.

Parameters:
protocolprotocol for which policies must be replaced.
policiescomma separated list of policies.
modifiera match statement to insert in each policy.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_set_proto_target ( const string &  protocol,
const string &  target 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Update the mapping from protocols to their XRL target name.

Parameters:
protocolprotocol to update.
targetXRL target for the protocol.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_set_proto_target ( const string &  protocol,
const string &  target 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Update the mapping from protocols to their XRL target name.

Parameters:
protocolprotocol to update.
targetXRL target for the protocol.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_update_set ( const string &  type,
const string &  set,
const string &  elements 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Replace elements in a set.

Parameters:
typethe type of the set.
setname of the set.
elementscomma delimited list of set elements.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_update_set ( const string &  type,
const string &  set,
const string &  elements 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Replace elements in a set.

Parameters:
typethe type of the set.
setname of the set.
elementscomma delimited list of set elements.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_update_term_block ( const string &  policy,
const string &  term,
const uint32_t &  block,
const string &  order,
const string &  statement 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Update the source/dest/action block of a term in a policy. Note: if statement is empty, the previous one in that position will be deleted.

Parameters:
policythe name of the policy.
termthe name of the term.
blockthe block to update (0:source, 1:dest, 2:action).
ordernumerical position (local) of statement.
statementthe statement to insert or delete.

Implemented in XrlPolicyTarget.

virtual XrlCmdError XrlPolicyTargetBase::policy_0_1_update_term_block ( const string &  policy,
const string &  term,
const uint32_t &  block,
const string &  order,
const string &  statement 
) [protected, pure virtual]

Pure-virtual function that needs to be implemented to:

Update the source/dest/action block of a term in a policy. Note: if statement is empty, the previous one in that position will be deleted.

Parameters:
policythe name of the policy.
termthe name of the term.
blockthe block to update (0:source, 1:dest, 2:action).
ordernumerical position (local) of statement.
statementthe statement to insert or delete.

Implemented in XrlPolicyTarget.

bool XrlPolicyTargetBase::set_command_map ( XrlCmdMap cmds)

Set command map.

Parameters:
cmdspointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.
Returns:
true on success, false if cmds is null or a command map has already been supplied.
bool XrlPolicyTargetBase::set_command_map ( XrlCmdMap cmds)

Set command map.

Parameters:
cmdspointer to command map to associate commands with. This argument is typically a pointer to the XrlRouter associated with the target.
Returns:
true on success, false if cmds is null or a command map has already been supplied.

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations