go.temporal.io/server@v1.23.0/common/persistence/nosql/nosqlplugin/cassandra/translator/translator_plugin.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package translator
    26  
    27  import (
    28  	"errors"
    29  
    30  	"github.com/gocql/gocql"
    31  
    32  	"go.temporal.io/server/common/config"
    33  )
    34  
    35  var (
    36  	ErrInvalidTranslatorPluginName = errors.New("translator_plugin: invalid translator plugin requested")
    37  	translators                    = map[string]TranslatorPlugin{}
    38  )
    39  
    40  type (
    41  	// TranslatorPlugin interface for Cassandra address translation mechanism
    42  	TranslatorPlugin interface {
    43  		GetTranslator(*config.Cassandra) (gocql.AddressTranslator, error)
    44  	}
    45  )
    46  
    47  // RegisterPlugin adds an auth plugin to the plugin registry
    48  // it is only safe to use from a package init function
    49  func RegisterTranslator(name string, plugin TranslatorPlugin) {
    50  	translators[name] = plugin
    51  }
    52  
    53  func LookupTranslator(name string) (TranslatorPlugin, error) {
    54  	plugin, ok := translators[name]
    55  	if !ok {
    56  		return nil, ErrInvalidTranslatorPluginName
    57  	}
    58  
    59  	return plugin, nil
    60  }