Scheme.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
 */
 
#ifndef SQUID_SRC_AUTH_SCHEME_H
#define SQUID_SRC_AUTH_SCHEME_H
 
#if USE_AUTH
 
#include "auth/forward.h"
#include "base/RefCount.h"
 
namespace Auth
{
 
class Scheme : public RefCountable
{
public:
    typedef RefCount<Scheme> Pointer;
    typedef std::vector<Scheme::Pointer>::iterator iterator;
    typedef std::vector<Scheme::Pointer>::const_iterator const_iterator;
 
public:
    Scheme() : initialised (false) {};
    ~Scheme() override {};
 
    static void AddScheme(Scheme::Pointer);
 
    static void FreeAll();
 
    static Scheme::Pointer Find(const char *);
 
    /* per scheme methods */
    virtual char const *type() const = 0;
    virtual void shutdownCleanup() = 0;
    virtual Auth::SchemeConfig *createConfig() = 0;
 
    // Not implemented
    Scheme(Scheme const &);
    Scheme &operator=(Scheme const&);
 
    static std::vector<Scheme::Pointer> &GetSchemes();
 
protected:
    bool initialised;
};
 
} // namespace Auth
 
#endif /* USE_AUTH */
#endif /* SQUID_SRC_AUTH_SCHEME_H */