Scott Baker | bba67b6 | 2019-01-28 17:38:21 -0800 | [diff] [blame] | 1 | # Copyright 2017-present Open Networking Foundation |
| 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 | |
| 16 | """ policy.py |
| 17 | |
| 18 | Base Classes for Model Policies |
| 19 | """ |
| 20 | |
| 21 | from xosconfig import Config |
| 22 | from multistructlog import create_logger |
| 23 | |
| 24 | log = create_logger(Config().get("logging")) |
| 25 | |
| 26 | |
| 27 | class Policy(object): |
| 28 | """ An XOS Model Policy |
| 29 | |
| 30 | Set the class member model_name to the name of the model that this policy will act on. |
| 31 | |
| 32 | The following functions will be invoked if they are defined: |
| 33 | |
| 34 | handle_create ... called when a model is created |
| 35 | handle_update ... called when a model is updated |
| 36 | handle_delete ... called when a model is deleted |
| 37 | """ |
| 38 | |
Scott Baker | c2fddaa | 2019-01-30 15:45:03 -0800 | [diff] [blame] | 39 | def __init__(self, model_accessor): |
| 40 | self.model_accessor = model_accessor |
Scott Baker | bba67b6 | 2019-01-28 17:38:21 -0800 | [diff] [blame] | 41 | self.logger = log |