![]() |
Kea 3.0.0
|
Base type of HTTP authentication configuration. More...
#include <auth_config.h>
Public Member Functions | |
| virtual | ~HttpAuthConfig () |
| Destructor. | |
| virtual isc::http::HttpResponseJsonPtr | checkAuth (const isc::http::HttpResponseCreator &creator, const isc::http::HttpRequestPtr &request) const =0 |
| Validate HTTP request. | |
| virtual void | clear ()=0 |
| Clear configuration. | |
| virtual bool | empty () const =0 |
| Empty predicate. | |
| const std::string & | getDirectory () const |
| Returns the common part for file paths (usually a directory). | |
| const std::string & | getRealm () const |
| Returns the realm. | |
| virtual void | parse (const isc::data::ConstElementPtr &config)=0 |
| Parses HTTP authentication configuration. | |
| void | setDirectory (const std::string &directory) |
| Set the common part for file paths (usually a directory). | |
| void | setRealm (const std::string &realm) |
| Set the realm. | |
| virtual isc::data::ElementPtr | toElement () const =0 |
| Unparses HTTP authentication configuration. | |
| Public Member Functions inherited from isc::data::UserContext | |
| void | contextToElement (data::ElementPtr map) const |
| Merge unparse a user_context object. | |
| data::ConstElementPtr | getContext () const |
| Returns const pointer to the user context. | |
| void | setContext (const data::ConstElementPtr &ctx) |
| Sets user context. | |
| Public Member Functions inherited from isc::data::CfgToElement | |
| virtual | ~CfgToElement () |
| Destructor. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from isc::data::UserContext | |
| static data::ElementPtr | toElement (data::ConstElementPtr map) |
| Copy an Element map. | |
| Protected Attributes inherited from isc::data::UserContext | |
| data::ConstElementPtr | user_context_ |
| Pointer to the user context (may be NULL) | |
Base type of HTTP authentication configuration.
Definition at line 22 of file auth_config.h.
|
inlinevirtual |
Destructor.
Definition at line 27 of file auth_config.h.
|
pure virtual |
Validate HTTP request.
| creator | The HTTP response creator. |
| request | The HTTP request to validate. |
Implemented in isc::http::BasicHttpAuthConfig.
|
pure virtual |
Clear configuration.
Implemented in isc::http::BasicHttpAuthConfig.
|
pure virtual |
Empty predicate.
Implemented in isc::http::BasicHttpAuthConfig.
|
inline |
Returns the common part for file paths (usually a directory).
Definition at line 53 of file auth_config.h.
Referenced by isc::http::BasicHttpAuthConfig::getFileContent(), and isc::http::BasicHttpAuthConfig::toElement().
|
inline |
Returns the realm.
Definition at line 39 of file auth_config.h.
Referenced by isc::http::BasicHttpAuthConfig::checkAuth(), and isc::http::BasicHttpAuthConfig::toElement().
|
pure virtual |
Parses HTTP authentication configuration.
| config | Element holding the basic HTTP authentication configuration to be parsed. |
| DhcpConfigError | when the configuration is invalid. |
Implemented in isc::http::BasicHttpAuthConfig.
|
inline |
Set the common part for file paths (usually a directory).
| directory | New directory. |
Definition at line 46 of file auth_config.h.
Referenced by isc::http::BasicHttpAuthConfig::parse().
|
inline |
Set the realm.
| realm | New realm. |
Definition at line 32 of file auth_config.h.
Referenced by isc::http::BasicHttpAuthConfig::parse().
|
pure virtual |
Unparses HTTP authentication configuration.
Implements isc::data::CfgToElement.
Implemented in isc::http::BasicHttpAuthConfig.