Committed by
Gerrit Code Review
[ONOS-3116] Port Pair Service
Change-Id: Ifa73037d107cf0c19f6c8b50639a160e81b05681
Showing
2 changed files
with
100 additions
and
0 deletions
| 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.vtnrsc.portpair; | ||
| 17 | + | ||
| 18 | +import org.onosproject.vtnrsc.PortPair; | ||
| 19 | +import org.onosproject.vtnrsc.PortPairId; | ||
| 20 | + | ||
| 21 | +/** | ||
| 22 | + * Service for interacting with the inventory of port pairs. | ||
| 23 | + */ | ||
| 24 | +public interface PortPairService { | ||
| 25 | + | ||
| 26 | + /** | ||
| 27 | + * Returns if the port pair is existed. | ||
| 28 | + * | ||
| 29 | + * @param portPairId port pair identifier | ||
| 30 | + * @return true or false if one with the given identifier exists. | ||
| 31 | + */ | ||
| 32 | + boolean exists(PortPairId portPairId); | ||
| 33 | + | ||
| 34 | + /** | ||
| 35 | + * Returns the number of port pairs known to the system. | ||
| 36 | + * | ||
| 37 | + * @return number of port pairs. | ||
| 38 | + */ | ||
| 39 | + int getPortPairCount(); | ||
| 40 | + | ||
| 41 | + /** | ||
| 42 | + * Returns an iterable collection of the currently known port pairs. | ||
| 43 | + * | ||
| 44 | + * @return collection of port pairs. | ||
| 45 | + */ | ||
| 46 | + Iterable<PortPair> getPortPairs(); | ||
| 47 | + | ||
| 48 | + /** | ||
| 49 | + * Returns the portPair with the given identifier. | ||
| 50 | + * | ||
| 51 | + * @param portPairId port pair identifier | ||
| 52 | + * @return PortPair or null if port pair with the given identifier is not | ||
| 53 | + * known. | ||
| 54 | + */ | ||
| 55 | + PortPair getPortPair(PortPairId portPairId); | ||
| 56 | + | ||
| 57 | + /** | ||
| 58 | + * Creates a PortPair in the store. | ||
| 59 | + * | ||
| 60 | + * @param portPair the port pair to create | ||
| 61 | + * @return true if given port pair is created successfully. | ||
| 62 | + */ | ||
| 63 | + boolean createPortPair(PortPair portPair); | ||
| 64 | + | ||
| 65 | + /** | ||
| 66 | + * Updates the portPair in the store. | ||
| 67 | + * | ||
| 68 | + * @param portPair the port pair to update | ||
| 69 | + * @return true if given port pair is updated successfully. | ||
| 70 | + */ | ||
| 71 | + boolean updatePortPair(PortPair portPair); | ||
| 72 | + | ||
| 73 | + /** | ||
| 74 | + * Deletes portPair by given portPairId. | ||
| 75 | + * | ||
| 76 | + * @param portPairId id of port pair to remove | ||
| 77 | + * @return true if the give port pair is deleted successfully. | ||
| 78 | + */ | ||
| 79 | + boolean removePortPair(PortPairId portPairId); | ||
| 80 | +} |
| 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 | + | ||
| 17 | +/** | ||
| 18 | + * Service for interacting with the inventory of port pairs. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.vtnrsc.portpair; |
-
Please register or login to post a comment