The highest tagged major version is
README
¶
Handlers
This package contains handlers to forward values coming from a request header or a cookie, to a request context.
The mapping is done using enumeration of possible keys, and their mappings to header, context or cookie keys.
Usage
- Read a header from a request and add its value to the underlying request context:
// Access token
handler := handlers.CheckHeader(handlers.UserAccess)
// Locale
handler := handlers.CheckHeader(handlers.Locale)
// CollectionID
handler := handlers.CheckHeader(handlers.CollectionID)
- Read a cookie and add its value to the output request context:
// Access token
handler := handlers.CheckCookie(handlers.UserAccess)
// Locale
handler := handlers.CheckCookie(handlers.Locale)
// CollectionID
handler := handlers.CheckCookie(handlers.CollectionID)
- Access the context value:
// Access token
accessToken := ctx.Value(handlers.UserAccess.Context())
// Locale
locale := ctx.Value(handlers.Locale.Context())
// CollectionID
collectionID := ctx.Value(handlers.CollectionID.Context())
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var KeyMaps = map[Key]*KeyMap{ UserAccess: { Header: request.FlorenceHeaderKey, Cookie: request.FlorenceCookieKey, Context: request.FlorenceIdentityKey, }, Locale: { Header: request.LocaleHeaderKey, Cookie: request.LocaleCookieKey, Context: request.LocaleContextKey, }, CollectionID: { Header: request.CollectionIDHeaderKey, Cookie: request.CollectionIDCookieKey, Context: request.CollectionIDContextKey, }, }
KeyMaps maps the possible values of Key enumeration to their Header, Cookie and Context correspnding keys
Functions ¶
func CheckCookie ¶
CheckCookie is a wrapper which adds a cookie value (if found) to the request context. This function complies with alice middleware Constructor type: func(http.Handler) -> (http.Handler))
func CheckHeader ¶
CheckHeader is a wrapper which adds a value from the request header (if found) to the request context. This function complies with alice middleware Constructor type: func(http.Handler) -> (http.Handler)
func DoCheckCookie ¶ added in v1.0.4
DoCheckCookie returns a handler that performs the CheckCookie logic
Source Files
Directories