Mahesh Poojary S | 7e9a78f | 2015-12-04 01:55:57 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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.sfc.forwarder; |
| 17 | |
| 18 | import org.onosproject.net.flowobjective.Objective; |
| 19 | import org.onosproject.net.NshServicePathId; |
| 20 | import org.onosproject.vtnrsc.PortChain; |
| 21 | |
| 22 | /** |
| 23 | * Abstraction of an entity which provides Service function forwarder. |
| 24 | */ |
| 25 | public interface ServiceFunctionForwarderService { |
| 26 | |
| 27 | /** |
| 28 | * Install Forwarding rule. |
| 29 | * |
| 30 | * @param portChain port-chain |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 31 | * @param nshSpi nsh spi |
Mahesh Poojary S | 7e9a78f | 2015-12-04 01:55:57 +0530 | [diff] [blame] | 32 | */ |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 33 | void installForwardingRule(PortChain portChain, NshServicePathId nshSpi); |
Mahesh Poojary S | 7e9a78f | 2015-12-04 01:55:57 +0530 | [diff] [blame] | 34 | |
| 35 | /** |
| 36 | * Uninstall Forwarding rule. |
| 37 | * |
| 38 | * @param portChain port-chain |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 39 | * @param nshSpi nsh spi |
Mahesh Poojary S | 7e9a78f | 2015-12-04 01:55:57 +0530 | [diff] [blame] | 40 | */ |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 41 | void unInstallForwardingRule(PortChain portChain, NshServicePathId nshSpi); |
Mahesh Poojary S | 7e9a78f | 2015-12-04 01:55:57 +0530 | [diff] [blame] | 42 | |
| 43 | /** |
| 44 | * Prepare forwarding object for Service Function. |
| 45 | * |
| 46 | * @param portChain port-chain |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 47 | * @param nshSpi nsh spi |
Mahesh Poojary S | 7e9a78f | 2015-12-04 01:55:57 +0530 | [diff] [blame] | 48 | * @param type forwarding objective operation type |
| 49 | */ |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 50 | void prepareServiceFunctionForwarder(PortChain portChain, NshServicePathId nshSpi, Objective.Operation type); |
Mahesh Poojary S | 7e9a78f | 2015-12-04 01:55:57 +0530 | [diff] [blame] | 51 | } |