Daniele Moro | 8d630f1 | 2021-06-15 20:53:22 +0200 | [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 | |
tosinski | 36ba33a | 2021-11-22 16:53:00 +0100 | [diff] [blame] | 17 | package org.onosproject.net.behaviour.upf; |
| 18 | |
| 19 | import com.google.common.annotations.Beta; |
| 20 | |
Daniele Moro | 8d630f1 | 2021-06-15 20:53:22 +0200 | [diff] [blame] | 21 | /** |
tosinski | 36ba33a | 2021-11-22 16:53:00 +0100 | [diff] [blame] | 22 | * Abstraction of a UPF entity used to interact with the UPF-programmable device. |
Daniele Moro | 8d630f1 | 2021-06-15 20:53:22 +0200 | [diff] [blame] | 23 | */ |
tosinski | 36ba33a | 2021-11-22 16:53:00 +0100 | [diff] [blame] | 24 | @Beta |
| 25 | public interface UpfEntity { |
| 26 | /** |
Daniele Moro | a1c7ba4 | 2022-01-13 19:16:34 +0100 | [diff] [blame] | 27 | * Default Application ID, to be used if application filtering is performed. |
| 28 | */ |
| 29 | byte DEFAULT_APP_ID = 0; |
| 30 | |
| 31 | /** |
Daniele Moro | 909b958 | 2022-01-26 15:47:29 +0100 | [diff] [blame] | 32 | * Default session index, to be used if no session metering is performed. |
| 33 | */ |
| 34 | int DEFAULT_SESSION_INDEX = 0; |
| 35 | |
| 36 | /** |
| 37 | * Default app index, to be used if no app metering is performed. |
| 38 | */ |
| 39 | int DEFAULT_APP_INDEX = 0; |
| 40 | |
| 41 | /** |
tosinski | 36ba33a | 2021-11-22 16:53:00 +0100 | [diff] [blame] | 42 | * Returns the type of this entity. |
| 43 | * |
| 44 | * @return entity type |
| 45 | */ |
| 46 | UpfEntityType type(); |
| 47 | } |