ctx

Documentation

Index

• Constants
• Variables
• func ContextGetInitiator(ctx context.Context) (string, bool)
• func ContextGetLockID(ctx context.Context) (string, bool)
• func ContextGetScopes(ctx context.Context) (map[string]*auth.Scope, bool)
• func ContextGetToken(ctx context.Context) (string, bool)
• func ContextGetUser(ctx context.Context) (*userpb.User, bool)
• func ContextGetUserAgent(ctx context.Context) (*ua.UserAgent, bool)
• func ContextGetUserAgentCategory(ctx context.Context) (string, bool)
• func ContextGetUserAgentString(ctx context.Context) (string, bool)
• func ContextGetUserID(ctx context.Context) (*userpb.UserId, bool)
• func ContextMustGetToken(ctx context.Context) string
• func ContextMustGetUser(ctx context.Context) *userpb.User
• func ContextSetInitiator(ctx context.Context, i string) context.Context
• func ContextSetLockID(ctx context.Context, t string) context.Context
• func ContextSetScopes(ctx context.Context, s map[string]*auth.Scope) context.Context
• func ContextSetToken(ctx context.Context, t string) context.Context
• func ContextSetUser(ctx context.Context, u *userpb.User) context.Context
• func ContextSetUserID(ctx context.Context, id *userpb.UserId) context.Context

Constants

const (
	UserAgentHeader = "x-user-agent"

	WebUserAgent     = "web"
	GrpcUserAgent    = "grpc"
	MobileUserAgent  = "mobile"
	DesktopUserAgent = "desktop"
)

UserAgentHeader is the header used for the user agent

const TokenHeader = "x-access-token"

TokenHeader is the header to be used across grpc and http services to forward the access token.

Variables

var InitiatorHeader = "initiator-id"

InitiatorHeader is the header key used to pass the initiator id to http services and grpc calls.

Functions

func ContextGetInitiator

func ContextGetInitiator(ctx context.Context) (string, bool)

ContextGetInitiator returns the initiator if set in the given context.

func ContextGetLockID

func ContextGetLockID(ctx context.Context) (string, bool)

ContextGetLockID returns the lock id if set in the given context.

func ContextGetScopes

func ContextGetScopes(ctx context.Context) (map[string]*auth.Scope, bool)

ContextGetScopes returns the scopes if set in the given context.

func ContextGetToken

func ContextGetToken(ctx context.Context) (string, bool)

ContextGetToken returns the token if set in the given context.

func ContextGetUser

func ContextGetUser(ctx context.Context) (*userpb.User, bool)

ContextGetUser returns the user if set in the given context.

func ContextGetUserAgent

func ContextGetUserAgent(ctx context.Context) (*ua.UserAgent, bool)

ContextGetUserAgent returns the user agent if set in the given context. see https://github.com/grpc/grpc-go/issues/1100

func ContextGetUserAgentCategory

func ContextGetUserAgentCategory(ctx context.Context) (string, bool)

ContextGetUserAgentCategory returns the category of the user agent (i.e. if it is a web, mobile, desktop or grpc user agent)

func ContextGetUserAgentString

func ContextGetUserAgentString(ctx context.Context) (string, bool)

ContextGetUserAgentString returns the user agent string if set in the given context.

func ContextGetUserID

func ContextGetUserID(ctx context.Context) (*userpb.UserId, bool)

ContextGetUserID returns the user if set in the given context.

func ContextMustGetToken

func ContextMustGetToken(ctx context.Context) string

ContextMustGetToken panics if token is not in context.

func ContextMustGetUser

func ContextMustGetUser(ctx context.Context) *userpb.User

ContextMustGetUser panics if user is not in context.

func ContextSetInitiator

func ContextSetInitiator(ctx context.Context, i string) context.Context

ContextSetInitiator stores the initiator in the context.

func ContextSetLockID

func ContextSetLockID(ctx context.Context, t string) context.Context

ContextSetLockID stores the lock id in the context.

func ContextSetScopes

func ContextSetScopes(ctx context.Context, s map[string]*auth.Scope) context.Context

ContextSetScopes stores the scopes in the context.

func ContextSetToken

func ContextSetToken(ctx context.Context, t string) context.Context

ContextSetToken stores the token in the context.

func ContextSetUser

func ContextSetUser(ctx context.Context, u *userpb.User) context.Context

ContextSetUser stores the user in the context.

func ContextSetUserID

func ContextSetUserID(ctx context.Context, id *userpb.UserId) context.Context

ContextSetUserID stores the userid in the context.