General eCAP configuration. More...

#include <Config.h>

Inheritance diagram for Adaptation::Ecap::Config:
Collaboration diagram for Adaptation::Ecap::Config:

Public Types

typedef std::vector< ServiceConfigPointerServiceConfigs
 

Public Member Functions

 Config ()
 
 ~Config ()
 
virtual bool finalize ()
 
void parseService (void)
 
void freeService (void)
 
void dumpService (StoreEntry *, const char *) const
 
ServiceConfigPointer findServiceConfig (const String &)
 

Static Public Member Functions

static void Finalize (bool enable)
 
static void ParseServiceSet (void)
 
static void ParseServiceChain (void)
 
static void ParseAccess (ConfigParser &parser)
 
static void FreeAccess (void)
 
static void DumpAccess (StoreEntry *, const char *)
 

Public Attributes

int onoff
 
int service_failure_limit
 
time_t oldest_service_failure
 
int service_revival_delay
 
ServiceConfigs serviceConfigs
 

Static Public Attributes

static bool Enabled = false
 
static char * masterx_shared_name = NULL
 
static int service_iteration_limit = 16
 
static int send_client_ip = false
 
static int send_username = false
 
static int use_indirect_client = true
 
static Notes metaHeaders
 The list of configured meta headers. More...
 
static bool needHistory = false
 HttpRequest adaptation history should recorded. More...
 

Protected Member Functions

virtual Adaptation::ServiceConfignewServiceConfig () const
 creates service configuration object that will parse and keep cfg info More...
 
virtual void clear ()
 Removes any reference to the services from configuration. More...
 
void removeService (const String &service)
 Removes the given service from all service groups. More...
 
void removeRule (const String &id)
 Removes access rules of the given service or group. More...
 

Private Member Functions

 Config (const Config &)
 
Configoperator= (const Config &)
 
virtual Adaptation::ServicePointer createService (const ServiceConfigPointer &cfg)
 

Static Private Member Functions

static void ParseServiceGroup (ServiceGroupPointer group)
 
static void FreeServiceGroups (void)
 
static void DumpServiceGroups (StoreEntry *, const char *)
 

Detailed Description

Definition at line 38 of file Config.h.

Member Typedef Documentation

◆ ServiceConfigs

Definition at line 62 of file Config.h.

Constructor & Destructor Documentation

◆ Config() [1/2]

Adaptation::Ecap::Config::Config ( )

Definition at line 18 of file Config.cc.

◆ ~Config()

Adaptation::Ecap::Config::~Config ( )
virtual

Reimplemented from Adaptation::Config.

Definition at line 22 of file Config.cc.

◆ Config() [2/2]

Adaptation::Ecap::Config::Config ( const Config )
private

Member Function Documentation

◆ clear()

void Adaptation::Config::clear ( )
protectedvirtualinherited

Definition at line 121 of file Config.cc.

References Adaptation::AllGroups(), Adaptation::AllRules(), debugs, HERE(), and size.

◆ createService()

Adaptation::ServicePointer Adaptation::Ecap::Config::createService ( const ServiceConfigPointer cfg)
privatevirtual

Implements Adaptation::Config.

Definition at line 43 of file Config.cc.

◆ DumpAccess()

void Adaptation::Config::DumpAccess ( StoreEntry entry,
const char *  name 
)
staticinherited

◆ dumpService()

◆ DumpServiceGroups()

void Adaptation::Config::DumpServiceGroups ( StoreEntry entry,
const char *  name 
)
staticprivateinherited

◆ finalize()

bool Adaptation::Ecap::Config::finalize ( )
virtual

Creates and starts the adaptation services. In the case the adaptation mechanism is disabled then removes any reference to the services from access rules and service groups, and returns false.

Returns
true if the services are ready and running, false otherwise

Reimplemented from Adaptation::Config.

Definition at line 27 of file Config.cc.

References Adaptation::AllServices(), Adaptation::Ecap::CheckUnusedAdapterServices(), Adaptation::Config::finalize(), and Adaptation::Ecap::Host::Register().

Referenced by mainInitialize(), and mainReconfigureFinish().

◆ Finalize()

void Adaptation::Config::Finalize ( bool  enable)
staticinherited

◆ findServiceConfig()

Adaptation::ServiceConfigPointer Adaptation::Config::findServiceConfig ( const String service)
inherited

Definition at line 91 of file Config.cc.

References NULL.

◆ FreeAccess()

void Adaptation::Config::FreeAccess ( void  )
staticinherited

Definition at line 290 of file Config.cc.

References Adaptation::AllRules().

◆ freeService()

void Adaptation::Config::freeService ( void  )
inherited

◆ FreeServiceGroups()

void Adaptation::Config::FreeServiceGroups ( void  )
staticprivateinherited

Definition at line 261 of file Config.cc.

References Adaptation::AllGroups().

◆ newServiceConfig()

Adaptation::ServiceConfig * Adaptation::Ecap::Config::newServiceConfig ( ) const
protectedvirtual

Reimplemented from Adaptation::Config.

Definition at line 37 of file Config.cc.

◆ operator=()

Config& Adaptation::Ecap::Config::operator= ( const Config )
private

◆ ParseAccess()

void Adaptation::Config::ParseAccess ( ConfigParser parser)
staticinherited

◆ parseService()

void Adaptation::Config::parseService ( void  )
inherited

Definition at line 135 of file Config.cc.

References cfg_filename, config_lineno, and fatalf().

Referenced by parse_ecap_service_type(), and parse_icap_service_type().

◆ ParseServiceChain()

void Adaptation::Config::ParseServiceChain ( void  )
staticinherited

Definition at line 247 of file Config.cc.

References Adaptation::Config::ParseServiceGroup().

Referenced by parse_adaptation_service_chain_type().

◆ ParseServiceGroup()

void Adaptation::Config::ParseServiceGroup ( ServiceGroupPointer  group)
staticprivateinherited

◆ ParseServiceSet()

void Adaptation::Config::ParseServiceSet ( void  )
staticinherited

◆ removeRule()

void Adaptation::Config::removeRule ( const String id)
protectedinherited

Definition at line 103 of file Config.cc.

References Adaptation::AllRules(), debugs, and Adaptation::AccessRule::groupId.

◆ removeService()

void Adaptation::Config::removeService ( const String service)
protectedinherited

Member Data Documentation

◆ Enabled

bool Adaptation::Config::Enabled = false
staticinherited

Definition at line 42 of file Config.h.

Referenced by Adaptation::AccessCheck::Start().

◆ masterx_shared_name

◆ metaHeaders

◆ needHistory

bool Adaptation::Config::needHistory = false
staticinherited

◆ oldest_service_failure

◆ onoff

int Adaptation::Config::onoff
inherited

Definition at line 53 of file Config.h.

Referenced by mainInitialize(), and mainReconfigureFinish().

◆ send_client_ip

int Adaptation::Config::send_client_ip = false
staticinherited

◆ send_username

int Adaptation::Config::send_username = false
staticinherited

Definition at line 48 of file Config.h.

Referenced by Adaptation::Icap::ModXact::makeRequestHeaders().

◆ service_failure_limit

int Adaptation::Config::service_failure_limit
inherited

◆ service_iteration_limit

int Adaptation::Config::service_iteration_limit = 16
staticinherited

Definition at line 46 of file Config.h.

Referenced by Adaptation::Iterator::step().

◆ service_revival_delay

int Adaptation::Config::service_revival_delay
inherited

◆ serviceConfigs

ServiceConfigs Adaptation::Config::serviceConfigs
inherited

Definition at line 63 of file Config.h.

◆ use_indirect_client

int Adaptation::Config::use_indirect_client = true
staticinherited

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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors