#include <Acl.h>

Inheritance diagram for ACL:
Collaboration diagram for ACL:

Public Member Functions

void * operator new (size_t)
 
void operator delete (void *)
 
 ACL ()
 
virtual ~ACL ()
 
void context (const char *name, const char *configuration)
 sets user-specified ACL name and squid.conf context More...
 
bool matches (ACLChecklist *checklist) const
 
virtual const Acl::Optionsoptions ()
 
virtual void parseFlags ()
 configures ACL options, throwing on configuration errors More...
 
virtual void parse ()=0
 parses node represenation in squid.conf; dies on failures More...
 
virtual char const * typeString () const =0
 
virtual bool isProxyAuth () const
 
virtual SBufList dump () const =0
 
virtual bool empty () const =0
 
virtual bool valid () const
 
int cacheMatchAcl (dlink_list *cache, ACLChecklist *)
 
virtual int matchForCache (ACLChecklist *checklist)
 
virtual void prepareForUse ()
 
SBufList dumpOptions ()
 

Static Public Member Functions

static void ParseAclLine (ConfigParser &parser, ACL **head)
 
static void Initialize ()
 
static ACLFindByName (const char *name)
 

Public Attributes

char name [ACL_NAME_SZ]
 
char * cfgline
 
ACLnext
 
bool registered
 added to the global list of ACLs via aclRegister() More...
 

Private Member Functions

virtual int match (ACLChecklist *checklist)=0
 Matches the actual data in checklist against this ACL. More...
 
virtual bool requiresAle () const
 whether our (i.e. shallow) match() requires checklist to have a AccessLogEntry More...
 
virtual bool requiresRequest () const
 whether our (i.e. shallow) match() requires checklist to have a request More...
 
virtual bool requiresReply () const
 whether our (i.e. shallow) match() requires checklist to have a reply More...
 

Detailed Description

A configurable condition. A node in the ACL expression tree. Can evaluate itself in FilledChecklist context. Does not change during evaluation.

Definition at line 39 of file Acl.h.

Constructor & Destructor Documentation

ACL::ACL ( )

Definition at line 107 of file Acl.cc.

References name.

ACL::~ACL ( )
virtual

Definition at line 396 of file Acl.cc.

References AclMatchedName, cfgline, debugs, name, NULL, and safe_free.

Member Function Documentation

void ACL::context ( const char *  name,
const char *  configuration 
)
SBufList ACL::dumpOptions ( )
Returns
approximate options configuration

Definition at line 296 of file Acl.cc.

References SBufStream::buf(), SBuf::isEmpty(), and options().

Referenced by dump_acl().

ACL * ACL::FindByName ( const char *  name)
static
void ACL::Initialize ( )
static

Definition at line 404 of file Acl.cc.

References a, SquidConfig::aclList, Config, debugs, next, and prepareForUse().

Referenced by serverConnectionsOpen().

bool ACL::isProxyAuth ( ) const
virtual

Reimplemented in ACLExternal, ACLIdent, and ACLProxyAuth.

Definition at line 283 of file Acl.cc.

Referenced by aclIsProxyAuth().

bool ACL::matches ( ACLChecklist checklist) const

Orchestrates matching checklist against the ACL using match(), after checking preconditions and while providing debugging.

Returns
true if and only if there was a successful match. Updates the checklist state on match, async, and failure.

Definition at line 121 of file Acl.cc.

References AclMatchedName, ACLChecklist::asyncInProgress(), DBG_IMPORTANT, debugs, ACLChecklist::hasAle(), ACLChecklist::hasReply(), ACLChecklist::hasRequest(), match(), name, PROF_start, PROF_stop, requiresAle(), requiresReply(), requiresRequest(), and ACLChecklist::syncAle().

Referenced by ACLChecklist::matchAndFinish(), and ACLChecklist::matchChild().

int ACL::matchForCache ( ACLChecklist checklist)
virtual

Reimplemented in ACLProxyAuth.

Definition at line 315 of file Acl.cc.

References fatal().

Referenced by cacheMatchAcl().

void ACL::operator delete ( void *  )

Definition at line 87 of file Acl.cc.

References fatal().

void * ACL::operator new ( size_t  )

Definition at line 80 of file Acl.cc.

References fatal().

virtual const Acl::Options& ACL::options ( )
inlinevirtual
Returns
(linked) Options supported by this ACL

Reimplemented in ACLStrategised< M >, ACLDestinationIP, and ACLMaxUserIP.

Definition at line 63 of file Acl.h.

References Acl::NoOptions().

Referenced by dumpOptions(), and parseFlags().

void ACL::parseFlags ( )
virtual

Reimplemented in ACLIdent, ACLProxyAuth, ACLStrategised< M >, and ACLExtUser.

Definition at line 289 of file Acl.cc.

References Acl::NoFlags(), options(), and Acl::ParseFlags().

Referenced by ParseAclLine().

virtual void ACL::prepareForUse ( )
inlinevirtual

Reimplemented in ACLStrategised< M >, Acl::InnerNode, and ACLMaxConnection.

Definition at line 79 of file Acl.h.

Referenced by Initialize(), and Acl::InnerNode::prepareForUse().

bool ACL::requiresAle ( ) const
privatevirtual

Reimplemented in ACLExternal.

Definition at line 375 of file Acl.cc.

Referenced by matches().

bool ACL::requiresReply ( ) const
privatevirtual

Reimplemented in ACLStrategised< M >, and ACLHTTPStatus.

Definition at line 381 of file Acl.cc.

Referenced by matches().

bool ACL::requiresRequest ( ) const
privatevirtual

Reimplemented in ACLExternal, ACLProxyAuth, ACLStrategised< M >, ACLMaxUserIP, and Acl::TransactionInitiator.

Definition at line 387 of file Acl.cc.

Referenced by matches().

bool ACL::valid ( ) const
virtual

Reimplemented in ACLExternal, ACLStrategised< M >, ACLProxyAuth, ACLMaxConnection, ACLMaxUserIP, and ACLRandom.

Definition at line 115 of file Acl.cc.

Referenced by ParseAclLine().

Member Data Documentation

char* ACL::cfgline

Definition at line 84 of file Acl.h.

Referenced by context(), Acl::AllOf::parse(), ParseAclLine(), and ~ACL().

ACL* ACL::next

Definition at line 85 of file Acl.h.

Referenced by dump_acl(), FindByName(), Initialize(), and ParseAclLine().

bool ACL::registered

Definition at line 86 of file Acl.h.

Referenced by aclDeregister(), aclDestroyAcls(), and aclRegister().


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

 

Introduction

Documentation

Support

Miscellaneous

Web Site Translations

Mirrors