-
Notifications
You must be signed in to change notification settings - Fork 4.3k
/
httpfilter.go
100 lines (91 loc) · 4.03 KB
/
httpfilter.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/*
*
* Copyright 2021 gRPC authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
// Package httpfilter contains the HTTPFilter interface and a registry for
// storing and retrieving their implementations.
package httpfilter
import (
"github.com/golang/protobuf/proto"
iresolver "google.golang.org/grpc/internal/resolver"
)
// FilterConfig represents an opaque data structure holding configuration for a
// filter. Embed this interface to implement it.
type FilterConfig interface {
isFilterConfig()
}
// Filter defines the parsing functionality of an HTTP filter. A Filter may
// optionally implement either ClientInterceptorBuilder or
// ServerInterceptorBuilder or both, indicating it is capable of working on the
// client side or server side or both, respectively.
type Filter interface {
// TypeURLs are the registered proto message types supported by this filter.
TypeURLs() []string
// ParseFilterConfig parses the provided configuration proto.Message. This
// may be an anypb.Any or a udpa.type.v1.TypedStruct for filters that do
// not accept a custom type. The resulting FilterConfig will later be
// passed to Build.
ParseFilterConfig(proto.Message) (FilterConfig, error)
// ParseFilterConfigOverrid parses the provided override configuration
// proto.Message. This may be an anypb.Any or a udpa.type.v1.TypedStruct
// for filters that do not accept a custom type. The resulting
// FilterConfig will later be passed to Build.
ParseFilterConfigOverride(proto.Message) (FilterConfig, error)
}
// ClientInterceptorBuilder constructs a Client Interceptor. If this type is
// implemented by a Filter, it is capable of working on a client.
type ClientInterceptorBuilder interface {
// BuildClientInterceptor uses the FilterConfigs produced above to produce
// an HTTP filter interceptor for clients. config will always be non-nil,
// but override may be nil if no override config exists for the filter. It
// is valid for Build to return a nil Interceptor and a nil error. In this
// case, the RPC will not be intercepted by this filter.
BuildClientInterceptor(config, override FilterConfig) (iresolver.ClientInterceptor, error)
}
// ServerInterceptorBuilder constructs a Server Interceptor. If this type is
// implemented by a Filter, it is capable of working on a server.
//
// Server side filters are not currently supported, but this interface is
// defined for clarity.
type ServerInterceptorBuilder interface {
// BuildServerInterceptor uses the FilterConfigs produced above to produce
// an HTTP filter interceptor for servers. config will always be non-nil,
// but override may be nil if no override config exists for the filter. It
// is valid for Build to return a nil Interceptor and a nil error. In this
// case, the RPC will not be intercepted by this filter.
BuildServerInterceptor(config, override FilterConfig) (iresolver.ServerInterceptor, error)
}
var (
// m is a map from scheme to filter.
m = make(map[string]Filter)
)
// Register registers the HTTP filter Builder to the filter map. b.TypeURLs()
// will be used as the types for this filter.
//
// NOTE: this function must only be called during initialization time (i.e. in
// an init() function), and is not thread-safe. If multiple filters are
// registered with the same type URL, the one registered last will take effect.
func Register(b Filter) {
for _, u := range b.TypeURLs() {
m[u] = b
}
}
// Get returns the HTTPFilter registered with typeURL.
//
// If no filter is register with typeURL, nil will be returned.
func Get(typeURL string) Filter {
return m[typeURL]
}