forked from smallnest/rpcx
-
Notifications
You must be signed in to change notification settings - Fork 1
/
client_plugin.go
212 lines (177 loc) · 5.31 KB
/
client_plugin.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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
package rpcx
import "net/rpc"
// ClientPluginContainer implements IPluginContainer interface.
type ClientPluginContainer struct {
plugins []IPlugin
}
// Add adds a plugin.
func (p *ClientPluginContainer) Add(plugin IPlugin) error {
if p.plugins == nil {
p.plugins = make([]IPlugin, 0)
}
pName := p.GetName(plugin)
if pName != "" && p.GetByName(pName) != nil {
return ErrPluginAlreadyExists.Format(pName, p.GetDescription(plugin))
}
p.plugins = append(p.plugins, plugin)
return nil
}
// Remove removes a plugin by it's name.
func (p *ClientPluginContainer) Remove(pluginName string) error {
if p.plugins == nil {
return ErrPluginRemoveNoPlugins.Return()
}
if pluginName == "" {
//return error: cannot delete an unamed plugin
return ErrPluginRemoveEmptyName.Return()
}
indexToRemove := -1
for i := range p.plugins {
if p.GetName(p.plugins[i]) == pluginName {
indexToRemove = i
}
}
if indexToRemove == -1 {
return ErrPluginRemoveNotFound.Return()
}
p.plugins = append(p.plugins[:indexToRemove], p.plugins[indexToRemove+1:]...)
return nil
}
// GetName returns the name of a plugin, if no GetName() implemented it returns an empty string ""
func (p *ClientPluginContainer) GetName(plugin IPlugin) string {
return plugin.Name()
}
// GetDescription returns the name of a plugin, if no GetDescription() implemented it returns an empty string ""
func (p *ClientPluginContainer) GetDescription(plugin IPlugin) string {
return plugin.Description()
}
// GetByName returns a plugin instance by it's name
func (p *ClientPluginContainer) GetByName(pluginName string) IPlugin {
if p.plugins == nil {
return nil
}
for _, plugin := range p.plugins {
if plugin.Name() == pluginName {
return plugin
}
}
return nil
}
// GetAll returns all activated plugins
func (p *ClientPluginContainer) GetAll() []IPlugin {
return p.plugins
}
// DoPreReadResponseHeader invokes DoPreReadResponseHeader plugin.
func (p *ClientPluginContainer) DoPreReadResponseHeader(r *rpc.Response) error {
for i := range p.plugins {
if plugin, ok := p.plugins[i].(IPreReadResponseHeaderPlugin); ok {
err := plugin.PreReadResponseHeader(r)
if err != nil {
return err
}
}
}
return nil
}
// DoPostReadResponseHeader invokes DoPostReadResponseHeader plugin.
func (p *ClientPluginContainer) DoPostReadResponseHeader(r *rpc.Response) error {
for i := range p.plugins {
if plugin, ok := p.plugins[i].(IPostReadResponseHeaderPlugin); ok {
err := plugin.PostReadResponseHeader(r)
if err != nil {
return err
}
}
}
return nil
}
// DoPreReadResponseBody invokes DoPreReadResponseBody plugin.
func (p *ClientPluginContainer) DoPreReadResponseBody(body interface{}) error {
for i := range p.plugins {
if plugin, ok := p.plugins[i].(IPreReadResponseBodyPlugin); ok {
err := plugin.PreReadResponseBody(body)
if err != nil {
return err
}
}
}
return nil
}
// DoPostReadResponseBody invokes DoPostReadResponseBody plugin.
func (p *ClientPluginContainer) DoPostReadResponseBody(body interface{}) error {
for i := range p.plugins {
if plugin, ok := p.plugins[i].(IPostReadResponseBodyPlugin); ok {
err := plugin.PostReadResponseBody(body)
if err != nil {
return err
}
}
}
return nil
}
// DoPreWriteRequest invokes DoPreWriteRequest plugin.
func (p *ClientPluginContainer) DoPreWriteRequest(r *rpc.Request, body interface{}) error {
for i := range p.plugins {
if plugin, ok := p.plugins[i].(IPreWriteRequestPlugin); ok {
err := plugin.PreWriteRequest(r, body)
if err != nil {
return err
}
}
}
return nil
}
// DoPostWriteRequest invokes DoPostWriteRequest plugin.
func (p *ClientPluginContainer) DoPostWriteRequest(r *rpc.Request, body interface{}) error {
for i := range p.plugins {
if plugin, ok := p.plugins[i].(IPostWriteRequestPlugin); ok {
err := plugin.PostWriteRequest(r, body)
if err != nil {
return err
}
}
}
return nil
}
type (
//IPreReadResponseHeaderPlugin represents .
IPreReadResponseHeaderPlugin interface {
PreReadResponseHeader(*rpc.Response) error
}
//IPostReadResponseHeaderPlugin represents .
IPostReadResponseHeaderPlugin interface {
PostReadResponseHeader(*rpc.Response) error
}
//IPreReadResponseBodyPlugin represents .
IPreReadResponseBodyPlugin interface {
PreReadResponseBody(interface{}) error
}
//IPostReadResponseBodyPlugin represents .
IPostReadResponseBodyPlugin interface {
PostReadResponseBody(interface{}) error
}
//IPreWriteRequestPlugin represents .
IPreWriteRequestPlugin interface {
PreWriteRequest(*rpc.Request, interface{}) error
}
//IPostWriteRequestPlugin represents .
IPostWriteRequestPlugin interface {
PostWriteRequest(*rpc.Request, interface{}) error
}
//IClientPluginContainer represents a plugin container that defines all methods to manage plugins.
//And it also defines all extension points.
IClientPluginContainer interface {
Add(plugin IPlugin) error
Remove(pluginName string) error
GetName(plugin IPlugin) string
GetDescription(plugin IPlugin) string
GetByName(pluginName string) IPlugin
GetAll() []IPlugin
DoPreReadResponseHeader(*rpc.Response) error
DoPostReadResponseHeader(*rpc.Response) error
DoPreReadResponseBody(interface{}) error
DoPostReadResponseBody(interface{}) error
DoPreWriteRequest(*rpc.Request, interface{}) error
DoPostWriteRequest(*rpc.Request, interface{}) error
}
)