/*
- * $Id$
- *
- *
- * SQUID Web Proxy Cache http://www.squid-cache.org/
- * ----------------------------------------------------------
- *
- * Squid is the result of efforts by numerous individuals from
- * the Internet community; see the CONTRIBUTORS file for full
- * details. Many organizations have provided support for Squid's
- * development; see the SPONSORS file for full details. Squid is
- * Copyrighted (C) 2001 by the Regents of the University of
- * California; see the COPYRIGHT file for full details. Squid
- * incorporates software developed and/or copyrighted by other
- * sources; see the CREDITS file for full details.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ * Copyright (C) 1996-2017 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_AUTHSCHEME_H
-#define SQUID_AUTHSCHEME_H
+#ifndef SQUID_AUTH_SCHEME_H
+#define SQUID_AUTH_SCHEME_H
-#include "config.h"
-#include "Array.h"
-#include "RefCount.h"
+#if USE_AUTH
-class AuthConfig;
+#include "base/RefCount.h"
+
+#include <vector>
/**
- \defgroup AuthSchemeAPI Authentication Scheme API
+ \defgroup AuthSchemeAPI Authentication Scheme API
\ingroup AuthAPI
*/
+namespace Auth
+{
+
+class Config;
+
/**
* \ingroup AuthAPI
* \ingroup AuthSchemeAPI
* store the scheme metadata.
* \par
* Should we need multiple configs of a single scheme,
- * a new class AuthConfiguration should be made, and the
- * config specific calls on AuthScheme moved to it.
+ * a new class should be made, and the config specific calls on Auth::Scheme moved to it.
*/
-class AuthScheme : public RefCountable
+class Scheme : public RefCountable
{
public:
- typedef RefCount<AuthScheme> Pointer;
- typedef Vector<AuthScheme::Pointer>::iterator iterator;
- typedef Vector<AuthScheme::Pointer>::const_iterator const_iterator;
+ typedef RefCount<Scheme> Pointer;
+ typedef std::vector<Scheme::Pointer>::iterator iterator;
+ typedef std::vector<Scheme::Pointer>::const_iterator const_iterator;
public:
- AuthScheme() : initialised (false) {};
- virtual ~AuthScheme() {};
+ Scheme() : initialised (false) {};
+ virtual ~Scheme() {};
- static void AddScheme(AuthScheme::Pointer);
+ static void AddScheme(Scheme::Pointer);
/**
* Final termination of all authentication components.
/**
* Locate an authentication scheme component by Name.
*/
- static AuthScheme::Pointer Find(const char *);
+ static Scheme::Pointer Find(const char *);
/* per scheme methods */
- virtual char const *type () const = 0;
- virtual void done() = 0;
- virtual AuthConfig *createConfig() = 0;
+ virtual char const *type() const = 0;
+ virtual void shutdownCleanup() = 0;
+ virtual Auth::Config *createConfig() = 0;
// Not implemented
- AuthScheme(AuthScheme const &);
- AuthScheme &operator=(AuthScheme const&);
+ Scheme(Scheme const &);
+ Scheme &operator=(Scheme const&);
- static Vector<AuthScheme::Pointer> &GetSchemes();
+ static std::vector<Scheme::Pointer> &GetSchemes();
protected:
bool initialised;
private:
- static Vector<AuthScheme::Pointer> *_Schemes;
+ static std::vector<Scheme::Pointer> *_Schemes;
};
-#endif /* SQUID_AUTHSCHEME_H */
+} // namespace Auth
+
+#endif /* USE_AUTH */
+#endif /* SQUID_AUTH_SCHEME_H */
+