| 1 |
/* |
| 2 |
Copyright 2017 The Kubernetes Authors. |
| 3 |
|
| 4 |
Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 |
you may not use this file except in compliance with the License. |
| 6 |
You may obtain a copy of the License at |
| 7 |
|
| 8 |
http://www.apache.org/licenses/LICENSE-2.0 |
| 9 |
|
| 10 |
Unless required by applicable law or agreed to in writing, software |
| 11 |
distributed under the License is distributed on an "AS IS" BASIS, |
| 12 |
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 |
See the License for the specific language governing permissions and |
| 14 |
limitations under the License. |
| 15 |
*/ |
| 16 |
|
| 17 |
package audit |
| 18 |
|
| 19 |
import ( |
| 20 |
auditinternal "k8s.io/apiserver/pkg/apis/audit" |
| 21 |
) |
| 22 |
|
| 23 |
type Sink interface { |
| 24 |
// ProcessEvents handles events. Per audit ID it might be that ProcessEvents is called up to three times. |
| 25 |
// Errors might be logged by the sink itself. If an error should be fatal, leading to an internal |
| 26 |
// error, ProcessEvents is supposed to panic. The event must not be mutated and is reused by the caller |
| 27 |
// after the call returns, i.e. the sink has to make a deepcopy to keep a copy around if necessary. |
| 28 |
// Returns true on success, may return false on error. |
| 29 |
ProcessEvents(events ...*auditinternal.Event) bool |
| 30 |
} |
| 31 |
|
| 32 |
type Backend interface { |
| 33 |
Sink |
| 34 |
|
| 35 |
// Run will initialize the backend. It must not block, but may run go routines in the background. If |
| 36 |
// stopCh is closed, it is supposed to stop them. Run will be called before the first call to ProcessEvents. |
| 37 |
Run(stopCh <-chan struct{}) error |
| 38 |
|
| 39 |
// Shutdown will synchronously shut down the backend while making sure that all pending |
| 40 |
// events are delivered. It can be assumed that this method is called after |
| 41 |
// the stopCh channel passed to the Run method has been closed. |
| 42 |
Shutdown() |
| 43 |
|
| 44 |
// Returns the backend PluginName. |
| 45 |
String() string |
| 46 |
} |