OpenstackNodeService.java
3.46 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/*
* Copyright 2016-present Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.openstacknode;
import org.onlab.packet.IpAddress;
import org.onosproject.event.ListenerService;
import org.onosproject.net.DeviceId;
import org.onosproject.net.PortNumber;
import java.util.List;
import java.util.Optional;
import java.util.Set;
/**
* Handles the bootstrap request for compute/gateway node.
*/
public interface OpenstackNodeService
extends ListenerService<OpenstackNodeEvent, OpenstackNodeListener> {
enum NodeType {
/**
* Compute or Gateway Node.
*/
COMPUTE,
GATEWAY
}
/**
* Adds or updates a new node to the service.
*
* @param node openstack node
*/
void addOrUpdateNode(OpenstackNode node);
/**
* Bootstraps node with INIT state.
*
* @param node openstack node
*/
void processInitState(OpenstackNode node);
/**
* Bootstraps node with DEVICE_CREATED state.
*
* @param node openstack node
*/
void processDeviceCreatedState(OpenstackNode node);
/**
* Bootstraps node with COMPLETE state.
*
* @param node openstack node
*/
void processCompleteState(OpenstackNode node);
/**
* Bootstraps node with INCOMPLETE state.
*
* @param node openstack node
*/
void processIncompleteState(OpenstackNode node);
/**
* Deletes a node from the service.
*
* @param node openstack node
*/
void deleteNode(OpenstackNode node);
/**
* Returns all nodes known to the service.
*
* @return list of nodes
*/
List<OpenstackNode> nodes();
/**
* Returns all nodes in complete state.
*
* @return set of nodes
*/
Set<OpenstackNode> completeNodes();
/**
* Returns data network IP address of a given integration bridge device.
*
* @param intBridgeId integration bridge device id
* @return ip address; empty value otherwise
*/
Optional<IpAddress> dataIp(DeviceId intBridgeId);
/**
* Returns tunnel port number of a given integration bridge device.
*
* @param intBridgeId integration bridge device id
* @return port number; or empty value
*/
Optional<PortNumber> tunnelPort(DeviceId intBridgeId);
/**
* Returns router bridge device ID connected to a given integration bridge.
* It returns valid value only if the node type is GATEWAY.
*
* @param intBridgeId device id of the integration bridge
* @return device id of a router bridge; or empty value
*/
Optional<DeviceId> routerBridge(DeviceId intBridgeId);
/**
* Returns port number connected to the router bridge.
* It returns valid value only if the node type is GATEWAY.
*
* @param intBridgeId integration bridge device id
* @return port number; or empty value
*/
Optional<PortNumber> externalPort(DeviceId intBridgeId);
}