blob: c4e0c8ca84cb2319a7f98b37c43a1f5a2cf5da3b [file] [log] [blame]
Aihua Guo1ce2dd12016-08-12 23:37:44 -04001/*
2 * Copyright 2016 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 */
16package org.onosproject.tetopology.management.api.node;
17
18import java.util.List;
19
20import org.onosproject.tetopology.management.api.KeyId;
Aihua Guo1ce2dd12016-08-12 23:37:44 -040021
22/**
23 * Abstraction of a termination point.
24 */
Henry Yu4b4a7eb2016-11-09 20:07:53 -050025public interface TerminationPoint {
Aihua Guo1ce2dd12016-08-12 23:37:44 -040026
27 /**
Henry Yu4b4a7eb2016-11-09 20:07:53 -050028 * Returns the termination point identifier.
Aihua Guo1ce2dd12016-08-12 23:37:44 -040029 *
30 * @return termination point id
31 */
Henry Yu4b4a7eb2016-11-09 20:07:53 -050032 KeyId tpId();
Aihua Guo1ce2dd12016-08-12 23:37:44 -040033
34 /**
Henry Yu4b4a7eb2016-11-09 20:07:53 -050035 * Returns list of supporting termination point identifiers.
Aihua Guo1ce2dd12016-08-12 23:37:44 -040036 *
Henry Yu4b4a7eb2016-11-09 20:07:53 -050037 * @return the supporting termination point ids
Aihua Guo1ce2dd12016-08-12 23:37:44 -040038 */
Henry Yu4b4a7eb2016-11-09 20:07:53 -050039 List<TerminationPointKey> supportingTpIds();
Aihua Guo1ce2dd12016-08-12 23:37:44 -040040
41 /**
Henry Yu4b4a7eb2016-11-09 20:07:53 -050042 * Returns TE termination point identifier.
Aihua Guo1ce2dd12016-08-12 23:37:44 -040043 *
Henry Yu4b4a7eb2016-11-09 20:07:53 -050044 * @return the TE TP id
Aihua Guo1ce2dd12016-08-12 23:37:44 -040045 */
Henry Yu4b4a7eb2016-11-09 20:07:53 -050046 Long teTpId();
Aihua Guo1ce2dd12016-08-12 23:37:44 -040047}