pierventre | 30368ab | 2021-02-24 23:23:22 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2021-present Open Networking Foundation |
| 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 | package org.onosproject.segmentrouting.policy.api; |
| 17 | |
| 18 | /** |
| 19 | * Abstract implementation of the policy interface. |
| 20 | */ |
| 21 | public abstract class AbstractPolicy implements Policy { |
| 22 | // Shared state among policies |
| 23 | protected PolicyId policyId; |
| 24 | private PolicyType policyType; |
| 25 | |
| 26 | /** |
| 27 | * Init the basic information of a policy. |
| 28 | * |
| 29 | * @param pType the policy type |
| 30 | */ |
| 31 | protected AbstractPolicy(PolicyType pType) { |
| 32 | policyType = pType; |
| 33 | } |
| 34 | |
| 35 | @Override |
| 36 | public PolicyId policyId() { |
| 37 | return policyId; |
| 38 | } |
| 39 | |
| 40 | @Override |
| 41 | public PolicyType policyType() { |
| 42 | return policyType; |
| 43 | } |
| 44 | |
pierventre | 4f68ffa | 2021-03-09 22:52:14 +0100 | [diff] [blame^] | 45 | /** |
| 46 | * Computes the policy id. The actual computation is left to |
| 47 | * the implementation class that can decide how to generate the |
| 48 | * policy id. |
| 49 | * |
| 50 | * @return the computed policy id |
| 51 | */ |
pierventre | 30368ab | 2021-02-24 23:23:22 +0100 | [diff] [blame] | 52 | protected abstract PolicyId computePolicyId(); |
| 53 | |
| 54 | } |