AuthBackend: Create AuthBackend

In RestRserve: A Framework for Building HTTP API

Create AuthBackend

Description

Creates AuthBackend class object.

Public fields

HTTPError

Class which raises HTTP errors.

Methods

Public methods

• AuthBackend$new()

• AuthBackend$authenticate()

• AuthBackend$clone()

---

Method new()

Creates AuthBackend class object.

Usage

AuthBackend$new(FUN, auth_header_prefix)

Arguments

FUN

Authentication handler function.

auth_header_prefix

Authentication HTTP header prefix.

---

Method authenticate()

This placeholder. It must be implemented in the subclass.

Usage

AuthBackend$authenticate()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

AuthBackend$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

This object is typically constructed via a derived classes, e.g. AuthBackendBasic or AuthBackendBearer.

References

falcon-auth

See Also

Other AuthBackend: AuthBackendBasic, AuthBackendBearer, AuthMiddleware

RestRserve documentation built on May 29, 2024, 8:18 a.m.