General eCAP configuration. More...

#include <Config.h>

Inheritance diagram for Adaptation::Ecap::Config:

Collaboration diagram for Adaptation::Ecap::Config:

[legend]

Public Types
typedef std::vector< ServiceConfigPointer >	ServiceConfigs

Public Member Functions
	Config ()

	~Config () override

bool	finalize () override

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 = nullptr

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
Adaptation::ServiceConfig *	newServiceConfig () const override
	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 &)

Config &	operator= (const Config &)

Adaptation::ServicePointer	createService (const ServiceConfigPointer &cfg) override

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

typedef std::vector<ServiceConfigPointer> Adaptation::Config::ServiceConfigs

inherited

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 ( )

overridevirtual

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, and size.

◆ createService()

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

overrideprivatevirtual

Implements Adaptation::Config.

Definition at line 43 of file Config.cc.

◆ DumpAccess()

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

staticinherited

Definition at line 299 of file Config.cc.

References Adaptation::AllRules(), dump_acl_access(), LOCAL_ARRAY, SQUIDSTRINGPH, and SQUIDSTRINGPRINT.

◆ dumpService()

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

inherited

Definition at line 157 of file Config.cc.

References Adaptation::AllServices(), Adaptation::ServiceConfig::bypass, String::caseCmp(), Adaptation::ServiceConfig::connectionEncryption, Security::PeerOptions::encryptTransport, Adaptation::ServiceConfig::key, Adaptation::ServiceConfig::methodStr(), Adaptation::ServiceConfig::protocol, Adaptation::ServiceConfig::secure, SQUIDSTRINGPH, SQUIDSTRINGPRINT, storeAppendPrintf(), Adaptation::ServiceConfig::uri, and Adaptation::ServiceConfig::vectPointStr().

Referenced by dump_ecap_service_type(), and dump_icap_service_type().

◆ DumpServiceGroups()

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

staticprivateinherited

Definition at line 270 of file Config.cc.

References Adaptation::AllGroups(), SQUIDSTRINGPH, SQUIDSTRINGPRINT, and storeAppendPrintf().

◆ finalize()

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

overridevirtual

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.