github.com/cs3org/reva/v2@v2.27.7/pkg/ctx/initiatorctx.go (about)

     1  // Copyright 2018-2021 CERN
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package ctx
    20  
    21  import "context"
    22  
    23  // InitiatorHeader is the header key used to pass the initiator id to http services and grpc calls.
    24  var InitiatorHeader = "initiator-id"
    25  
    26  // ContextGetInitiator returns the initiator if set in the given context.
    27  func ContextGetInitiator(ctx context.Context) (string, bool) {
    28  	i, ok := ctx.Value(initiatorKey).(string)
    29  	return i, ok
    30  }
    31  
    32  // ContextSetInitiator stores the initiator in the context.
    33  func ContextSetInitiator(ctx context.Context, i string) context.Context {
    34  	return context.WithValue(ctx, initiatorKey, i)
    35  }