Committed by
Gerrit Code Review
Fixing javadoc warnings, provided missing package javadocs and corrected group structure.
Change-Id: I2637afe49b81e8e6d10ef3bb0f2a1cf50b2564cc
Showing
28 changed files
with
345 additions
and
51 deletions
| ... | @@ -23,6 +23,7 @@ import org.onosproject.net.ConnectPoint; | ... | @@ -23,6 +23,7 @@ import org.onosproject.net.ConnectPoint; |
| 23 | import org.onosproject.xosintegration.VoltTenant; | 23 | import org.onosproject.xosintegration.VoltTenant; |
| 24 | import org.onosproject.xosintegration.VoltTenantService; | 24 | import org.onosproject.xosintegration.VoltTenantService; |
| 25 | import org.slf4j.Logger; | 25 | import org.slf4j.Logger; |
| 26 | + | ||
| 26 | import java.util.BitSet; | 27 | import java.util.BitSet; |
| 27 | 28 | ||
| 28 | import static org.slf4j.LoggerFactory.getLogger; | 29 | import static org.slf4j.LoggerFactory.getLogger; |
| ... | @@ -111,7 +112,9 @@ class StateMachine { | ... | @@ -111,7 +112,9 @@ class StateMachine { |
| 111 | 112 | ||
| 112 | /** | 113 | /** |
| 113 | * State Machine Constructor. | 114 | * State Machine Constructor. |
| 114 | - * @param sessionId Session Id represented by the switch dpid + port number | 115 | + * |
| 116 | + * @param sessionId session Id represented by the switch dpid + port number | ||
| 117 | + * @param voltService volt service reference | ||
| 115 | */ | 118 | */ |
| 116 | public StateMachine(String sessionId, VoltTenantService voltService) { | 119 | public StateMachine(String sessionId, VoltTenantService voltService) { |
| 117 | log.info("Creating a new state machine for {}", sessionId); | 120 | log.info("Creating a new state machine for {}", sessionId); |
| ... | @@ -122,6 +125,7 @@ class StateMachine { | ... | @@ -122,6 +125,7 @@ class StateMachine { |
| 122 | 125 | ||
| 123 | /** | 126 | /** |
| 124 | * Get the client id that is requesting for access. | 127 | * Get the client id that is requesting for access. |
| 128 | + * | ||
| 125 | * @return The client id. | 129 | * @return The client id. |
| 126 | */ | 130 | */ |
| 127 | public String getSessionId() { | 131 | public String getSessionId() { |
| ... | @@ -154,15 +158,18 @@ class StateMachine { | ... | @@ -154,15 +158,18 @@ class StateMachine { |
| 154 | 158 | ||
| 155 | /** | 159 | /** |
| 156 | * Set the challenge identifier and the state issued by the RADIUS. | 160 | * Set the challenge identifier and the state issued by the RADIUS. |
| 161 | + * | ||
| 157 | * @param challengeIdentifier The challenge identifier set into the EAP packet from the RADIUS message. | 162 | * @param challengeIdentifier The challenge identifier set into the EAP packet from the RADIUS message. |
| 158 | - * @param challengeState The challenge state from the RADIUS. | 163 | + * @param challengeState The challenge state from the RADIUS. |
| 159 | */ | 164 | */ |
| 160 | protected void setChallengeInfo(byte challengeIdentifier, byte[] challengeState) { | 165 | protected void setChallengeInfo(byte challengeIdentifier, byte[] challengeState) { |
| 161 | this.challengeIdentifier = challengeIdentifier; | 166 | this.challengeIdentifier = challengeIdentifier; |
| 162 | this.challengeState = challengeState; | 167 | this.challengeState = challengeState; |
| 163 | } | 168 | } |
| 169 | + | ||
| 164 | /** | 170 | /** |
| 165 | * Set the challenge identifier issued by the RADIUS on the access challenge request. | 171 | * Set the challenge identifier issued by the RADIUS on the access challenge request. |
| 172 | + * | ||
| 166 | * @param challengeIdentifier The challenge identifier set into the EAP packet from the RADIUS message. | 173 | * @param challengeIdentifier The challenge identifier set into the EAP packet from the RADIUS message. |
| 167 | */ | 174 | */ |
| 168 | protected void setChallengeIdentifier(byte challengeIdentifier) { | 175 | protected void setChallengeIdentifier(byte challengeIdentifier) { |
| ... | @@ -172,6 +179,7 @@ class StateMachine { | ... | @@ -172,6 +179,7 @@ class StateMachine { |
| 172 | 179 | ||
| 173 | /** | 180 | /** |
| 174 | * Get the challenge EAP identifier set by the RADIUS. | 181 | * Get the challenge EAP identifier set by the RADIUS. |
| 182 | + * | ||
| 175 | * @return The challenge EAP identifier. | 183 | * @return The challenge EAP identifier. |
| 176 | */ | 184 | */ |
| 177 | protected byte getChallengeIdentifier() { | 185 | protected byte getChallengeIdentifier() { |
| ... | @@ -181,6 +189,7 @@ class StateMachine { | ... | @@ -181,6 +189,7 @@ class StateMachine { |
| 181 | 189 | ||
| 182 | /** | 190 | /** |
| 183 | * Set the challenge state info issued by the RADIUS. | 191 | * Set the challenge state info issued by the RADIUS. |
| 192 | + * | ||
| 184 | * @param challengeState The challenge state from the RADIUS. | 193 | * @param challengeState The challenge state from the RADIUS. |
| 185 | */ | 194 | */ |
| 186 | protected void setChallengeState(byte[] challengeState) { | 195 | protected void setChallengeState(byte[] challengeState) { |
| ... | @@ -190,6 +199,7 @@ class StateMachine { | ... | @@ -190,6 +199,7 @@ class StateMachine { |
| 190 | 199 | ||
| 191 | /** | 200 | /** |
| 192 | * Get the challenge state set by the RADIUS. | 201 | * Get the challenge state set by the RADIUS. |
| 202 | + * | ||
| 193 | * @return The challenge state. | 203 | * @return The challenge state. |
| 194 | */ | 204 | */ |
| 195 | protected byte[] getChallengeState() { | 205 | protected byte[] getChallengeState() { |
| ... | @@ -198,6 +208,7 @@ class StateMachine { | ... | @@ -198,6 +208,7 @@ class StateMachine { |
| 198 | 208 | ||
| 199 | /** | 209 | /** |
| 200 | * Set the username. | 210 | * Set the username. |
| 211 | + * | ||
| 201 | * @param username The username sent to the RADIUS upon access request. | 212 | * @param username The username sent to the RADIUS upon access request. |
| 202 | */ | 213 | */ |
| 203 | protected void setUsername(byte[] username) { | 214 | protected void setUsername(byte[] username) { |
| ... | @@ -207,6 +218,7 @@ class StateMachine { | ... | @@ -207,6 +218,7 @@ class StateMachine { |
| 207 | 218 | ||
| 208 | /** | 219 | /** |
| 209 | * Get the username. | 220 | * Get the username. |
| 221 | + * | ||
| 210 | * @return The requestAuthenticator. | 222 | * @return The requestAuthenticator. |
| 211 | */ | 223 | */ |
| 212 | protected byte[] getReqeustAuthenticator() { | 224 | protected byte[] getReqeustAuthenticator() { |
| ... | @@ -215,6 +227,7 @@ class StateMachine { | ... | @@ -215,6 +227,7 @@ class StateMachine { |
| 215 | 227 | ||
| 216 | /** | 228 | /** |
| 217 | * Set the username. | 229 | * Set the username. |
| 230 | + * | ||
| 218 | * @param authenticator The username sent to the RADIUS upon access request. | 231 | * @param authenticator The username sent to the RADIUS upon access request. |
| 219 | */ | 232 | */ |
| 220 | protected void setRequestAuthenticator(byte[] authenticator) { | 233 | protected void setRequestAuthenticator(byte[] authenticator) { |
| ... | @@ -224,6 +237,7 @@ class StateMachine { | ... | @@ -224,6 +237,7 @@ class StateMachine { |
| 224 | 237 | ||
| 225 | /** | 238 | /** |
| 226 | * Get the username. | 239 | * Get the username. |
| 240 | + * | ||
| 227 | * @return The username. | 241 | * @return The username. |
| 228 | */ | 242 | */ |
| 229 | protected byte[] getUsername() { | 243 | protected byte[] getUsername() { |
| ... | @@ -232,6 +246,7 @@ class StateMachine { | ... | @@ -232,6 +246,7 @@ class StateMachine { |
| 232 | 246 | ||
| 233 | /** | 247 | /** |
| 234 | * Return the identifier of the state machine. | 248 | * Return the identifier of the state machine. |
| 249 | + * | ||
| 235 | * @return The state machine identifier. | 250 | * @return The state machine identifier. |
| 236 | */ | 251 | */ |
| 237 | public byte getIdentifier() { | 252 | public byte getIdentifier() { |
| ... | @@ -251,15 +266,18 @@ class StateMachine { | ... | @@ -251,15 +266,18 @@ class StateMachine { |
| 251 | 266 | ||
| 252 | /** | 267 | /** |
| 253 | * Move to the next state. | 268 | * Move to the next state. |
| 269 | + * | ||
| 254 | * @param msg | 270 | * @param msg |
| 255 | */ | 271 | */ |
| 256 | - private void next(int msg) { | 272 | + private void next(int msg) { |
| 257 | currentState = transition[currentState][msg]; | 273 | currentState = transition[currentState][msg]; |
| 258 | log.info("Current State " + currentState); | 274 | log.info("Current State " + currentState); |
| 259 | } | 275 | } |
| 260 | 276 | ||
| 261 | /** | 277 | /** |
| 262 | * Client has requested the start action to allow network access. | 278 | * Client has requested the start action to allow network access. |
| 279 | + * | ||
| 280 | + * @throws StateMachineException if authentication protocol is violated | ||
| 263 | */ | 281 | */ |
| 264 | public void start() throws StateMachineException { | 282 | public void start() throws StateMachineException { |
| 265 | try { | 283 | try { |
| ... | @@ -275,6 +293,8 @@ class StateMachine { | ... | @@ -275,6 +293,8 @@ class StateMachine { |
| 275 | /** | 293 | /** |
| 276 | * An Identification information has been sent by the supplicant. | 294 | * An Identification information has been sent by the supplicant. |
| 277 | * Move to the next state if possible. | 295 | * Move to the next state if possible. |
| 296 | + * | ||
| 297 | + * @throws StateMachineException if authentication protocol is violated | ||
| 278 | */ | 298 | */ |
| 279 | public void requestAccess() throws StateMachineException { | 299 | public void requestAccess() throws StateMachineException { |
| 280 | try { | 300 | try { |
| ... | @@ -289,6 +309,8 @@ class StateMachine { | ... | @@ -289,6 +309,8 @@ class StateMachine { |
| 289 | /** | 309 | /** |
| 290 | * RADIUS has accepted the identification. | 310 | * RADIUS has accepted the identification. |
| 291 | * Move to the next state if possible. | 311 | * Move to the next state if possible. |
| 312 | + * | ||
| 313 | + * @throws StateMachineException if authentication protocol is violated | ||
| 292 | */ | 314 | */ |
| 293 | public void authorizeAccess() throws StateMachineException { | 315 | public void authorizeAccess() throws StateMachineException { |
| 294 | try { | 316 | try { |
| ... | @@ -317,6 +339,8 @@ class StateMachine { | ... | @@ -317,6 +339,8 @@ class StateMachine { |
| 317 | /** | 339 | /** |
| 318 | * RADIUS has denied the identification. | 340 | * RADIUS has denied the identification. |
| 319 | * Move to the next state if possible. | 341 | * Move to the next state if possible. |
| 342 | + * | ||
| 343 | + * @throws StateMachineException if authentication protocol is violated | ||
| 320 | */ | 344 | */ |
| 321 | public void denyAccess() throws StateMachineException { | 345 | public void denyAccess() throws StateMachineException { |
| 322 | try { | 346 | try { |
| ... | @@ -332,6 +356,8 @@ class StateMachine { | ... | @@ -332,6 +356,8 @@ class StateMachine { |
| 332 | /** | 356 | /** |
| 333 | * Logoff request has been requested. | 357 | * Logoff request has been requested. |
| 334 | * Move to the next state if possible. | 358 | * Move to the next state if possible. |
| 359 | + * | ||
| 360 | + * @throws StateMachineException if authentication protocol is violated | ||
| 335 | */ | 361 | */ |
| 336 | public void logoff() throws StateMachineException { | 362 | public void logoff() throws StateMachineException { |
| 337 | try { | 363 | try { |
| ... | @@ -345,6 +371,7 @@ class StateMachine { | ... | @@ -345,6 +371,7 @@ class StateMachine { |
| 345 | 371 | ||
| 346 | /** | 372 | /** |
| 347 | * Get the current state. | 373 | * Get the current state. |
| 374 | + * | ||
| 348 | * @return The current state. Could be STATE_IDLE, STATE_STARTED, STATE_PENDING, STATE_AUTHORIZED, | 375 | * @return The current state. Could be STATE_IDLE, STATE_STARTED, STATE_PENDING, STATE_AUTHORIZED, |
| 349 | * STATE_UNAUTHORIZED. | 376 | * STATE_UNAUTHORIZED. |
| 350 | */ | 377 | */ |
| ... | @@ -353,13 +380,14 @@ class StateMachine { | ... | @@ -353,13 +380,14 @@ class StateMachine { |
| 353 | } | 380 | } |
| 354 | 381 | ||
| 355 | 382 | ||
| 356 | - | ||
| 357 | public String toString() { | 383 | public String toString() { |
| 358 | return ("sessionId: " + this.sessionId) + "\t" + ("identifier: " + this.identifier) + "\t" + | 384 | return ("sessionId: " + this.sessionId) + "\t" + ("identifier: " + this.identifier) + "\t" + |
| 359 | ("state: " + this.currentState); | 385 | ("state: " + this.currentState); |
| 360 | } | 386 | } |
| 361 | } | 387 | } |
| 362 | 388 | ||
| 389 | +// FIXME: A source file should contain no more than one top-level entity! | ||
| 390 | + | ||
| 363 | abstract class State { | 391 | abstract class State { |
| 364 | private final Logger log = getLogger(getClass()); | 392 | private final Logger log = getLogger(getClass()); |
| 365 | 393 | ||
| ... | @@ -368,15 +396,19 @@ abstract class State { | ... | @@ -368,15 +396,19 @@ abstract class State { |
| 368 | public void start() throws StateMachineInvalidTransitionException { | 396 | public void start() throws StateMachineInvalidTransitionException { |
| 369 | log.warn("START transition from this state is not allowed."); | 397 | log.warn("START transition from this state is not allowed."); |
| 370 | } | 398 | } |
| 399 | + | ||
| 371 | public void requestAccess() throws StateMachineInvalidTransitionException { | 400 | public void requestAccess() throws StateMachineInvalidTransitionException { |
| 372 | log.warn("REQUEST ACCESS transition from this state is not allowed."); | 401 | log.warn("REQUEST ACCESS transition from this state is not allowed."); |
| 373 | } | 402 | } |
| 403 | + | ||
| 374 | public void radiusAccepted() throws StateMachineInvalidTransitionException { | 404 | public void radiusAccepted() throws StateMachineInvalidTransitionException { |
| 375 | log.warn("AUTHORIZE ACCESS transition from this state is not allowed."); | 405 | log.warn("AUTHORIZE ACCESS transition from this state is not allowed."); |
| 376 | } | 406 | } |
| 407 | + | ||
| 377 | public void radiusDenied() throws StateMachineInvalidTransitionException { | 408 | public void radiusDenied() throws StateMachineInvalidTransitionException { |
| 378 | log.warn("DENY ACCESS transition from this state is not allowed."); | 409 | log.warn("DENY ACCESS transition from this state is not allowed."); |
| 379 | } | 410 | } |
| 411 | + | ||
| 380 | public void logoff() throws StateMachineInvalidTransitionException { | 412 | public void logoff() throws StateMachineInvalidTransitionException { |
| 381 | log.warn("LOGOFF transition from this state is not allowed."); | 413 | log.warn("LOGOFF transition from this state is not allowed."); |
| 382 | } | 414 | } |
| ... | @@ -457,6 +489,7 @@ class StateMachineException extends Exception { | ... | @@ -457,6 +489,7 @@ class StateMachineException extends Exception { |
| 457 | 489 | ||
| 458 | } | 490 | } |
| 459 | } | 491 | } |
| 492 | + | ||
| 460 | /** | 493 | /** |
| 461 | * Exception raised when the transition from one state to another is invalid. | 494 | * Exception raised when the transition from one state to another is invalid. |
| 462 | */ | 495 | */ | ... | ... |
| 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 | + * Prototype application for scanning the flow space for cycles and black holes. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.flowanalyzer; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -59,10 +59,11 @@ public class PolicyHandler { | ... | @@ -59,10 +59,11 @@ public class PolicyHandler { |
| 59 | /** | 59 | /** |
| 60 | * Creates a reference. | 60 | * Creates a reference. |
| 61 | * | 61 | * |
| 62 | - * @param appId segment routing application ID | 62 | + * @param appId segment routing application ID |
| 63 | - * @param deviceConfiguration DeviceConfiguration reference | 63 | + * @param deviceConfiguration DeviceConfiguration reference |
| 64 | * @param flowObjectiveService FlowObjectiveService reference | 64 | * @param flowObjectiveService FlowObjectiveService reference |
| 65 | - * @param policyStore policy store | 65 | + * @param tunnelHandler tunnel handler reference |
| 66 | + * @param policyStore policy store | ||
| 66 | */ | 67 | */ |
| 67 | public PolicyHandler(ApplicationId appId, | 68 | public PolicyHandler(ApplicationId appId, |
| 68 | DeviceConfiguration deviceConfiguration, | 69 | DeviceConfiguration deviceConfiguration, | ... | ... |
| 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 | + * Segment routing application CLI handlers. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.segmentrouting.cli; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -53,24 +53,24 @@ public interface VirtualPortService { | ... | @@ -53,24 +53,24 @@ public interface VirtualPortService { |
| 53 | /** | 53 | /** |
| 54 | * Returns the collection of the virtualPorts associated with the networkId. | 54 | * Returns the collection of the virtualPorts associated with the networkId. |
| 55 | * | 55 | * |
| 56 | - * @param networkId | 56 | + * @param networkId network identifier |
| 57 | - * @return collection of virtualPort. | 57 | + * @return collection of virtualPort |
| 58 | */ | 58 | */ |
| 59 | Collection<VirtualPort> getPorts(TenantNetworkId networkId); | 59 | Collection<VirtualPort> getPorts(TenantNetworkId networkId); |
| 60 | 60 | ||
| 61 | /** | 61 | /** |
| 62 | * Returns the collection of the virtualPorts associated with the tenantId. | 62 | * Returns the collection of the virtualPorts associated with the tenantId. |
| 63 | * | 63 | * |
| 64 | - * @param tenantId | 64 | + * @param tenantId tenant identifier |
| 65 | - * @return collection of virtualPort. | 65 | + * @return collection of virtualPort |
| 66 | */ | 66 | */ |
| 67 | Collection<VirtualPort> getPorts(TenantId tenantId); | 67 | Collection<VirtualPort> getPorts(TenantId tenantId); |
| 68 | 68 | ||
| 69 | /** | 69 | /** |
| 70 | * Returns the collection of the virtualPorts associated with the deviceId. | 70 | * Returns the collection of the virtualPorts associated with the deviceId. |
| 71 | * | 71 | * |
| 72 | - * @param deviceId | 72 | + * @param deviceId device identifier |
| 73 | - * @return collection of virtualPort. | 73 | + * @return collection of virtualPort |
| 74 | */ | 74 | */ |
| 75 | Collection<VirtualPort> getPorts(DeviceId deviceId); | 75 | Collection<VirtualPort> getPorts(DeviceId deviceId); |
| 76 | 76 | ||
| ... | @@ -86,7 +86,7 @@ public interface VirtualPortService { | ... | @@ -86,7 +86,7 @@ public interface VirtualPortService { |
| 86 | * Updates virtualPorts by virtualPorts. | 86 | * Updates virtualPorts by virtualPorts. |
| 87 | * | 87 | * |
| 88 | * @param virtualPorts the iterable collection of virtualPorts | 88 | * @param virtualPorts the iterable collection of virtualPorts |
| 89 | - * @return true if all given identifiers updated successfully. | 89 | + * @return true if all given identifiers updated successfully |
| 90 | */ | 90 | */ |
| 91 | boolean updatePorts(Iterable<VirtualPort> virtualPorts); | 91 | boolean updatePorts(Iterable<VirtualPort> virtualPorts); |
| 92 | 92 | ||
| ... | @@ -95,7 +95,7 @@ public interface VirtualPortService { | ... | @@ -95,7 +95,7 @@ public interface VirtualPortService { |
| 95 | * | 95 | * |
| 96 | * @param virtualPortIds the iterable collection of virtualPort identifiers | 96 | * @param virtualPortIds the iterable collection of virtualPort identifiers |
| 97 | * @return true or false if one with the given identifier to delete is | 97 | * @return true or false if one with the given identifier to delete is |
| 98 | - * successfully. | 98 | + * successfully |
| 99 | */ | 99 | */ |
| 100 | boolean removePorts(Iterable<VirtualPortId> virtualPortIds); | 100 | boolean removePorts(Iterable<VirtualPortId> virtualPortIds); |
| 101 | } | 101 | } | ... | ... |
| ... | @@ -63,7 +63,7 @@ public interface BridgeConfig extends HandlerBehaviour { | ... | @@ -63,7 +63,7 @@ public interface BridgeConfig extends HandlerBehaviour { |
| 63 | /** | 63 | /** |
| 64 | * Delete a logical/virtual port. | 64 | * Delete a logical/virtual port. |
| 65 | * | 65 | * |
| 66 | - * return collection of port | 66 | + * @return collection of port |
| 67 | */ | 67 | */ |
| 68 | Collection<PortDescription> getPorts(); | 68 | Collection<PortDescription> getPorts(); |
| 69 | } | 69 | } | ... | ... |
| ... | @@ -25,30 +25,30 @@ import org.onosproject.net.driver.HandlerBehaviour; | ... | @@ -25,30 +25,30 @@ import org.onosproject.net.driver.HandlerBehaviour; |
| 25 | public interface TunnelConfig extends HandlerBehaviour { | 25 | public interface TunnelConfig extends HandlerBehaviour { |
| 26 | 26 | ||
| 27 | /** | 27 | /** |
| 28 | - * Create a tunnel. | 28 | + * Creates a tunnel on this device. |
| 29 | * | 29 | * |
| 30 | - * @param tunnel tunnel entity | 30 | + * @param tunnel tunnel descriptor |
| 31 | */ | 31 | */ |
| 32 | void createTunnel(TunnelDescription tunnel); | 32 | void createTunnel(TunnelDescription tunnel); |
| 33 | 33 | ||
| 34 | /** | 34 | /** |
| 35 | - * Remove a tunnel. | 35 | + * Removes a tunnel on this device. |
| 36 | * | 36 | * |
| 37 | - * @param tunnel tunnel entity | 37 | + * @param tunnel tunnel descriptor |
| 38 | */ | 38 | */ |
| 39 | void removeTunnel(TunnelDescription tunnel); | 39 | void removeTunnel(TunnelDescription tunnel); |
| 40 | 40 | ||
| 41 | /** | 41 | /** |
| 42 | - * Update a tunnel. | 42 | + * Updates a tunnel on this device. |
| 43 | * | 43 | * |
| 44 | - * @param tunnel tunnel entity | 44 | + * @param tunnel tunnel descriptor |
| 45 | */ | 45 | */ |
| 46 | void updateTunnel(TunnelDescription tunnel); | 46 | void updateTunnel(TunnelDescription tunnel); |
| 47 | 47 | ||
| 48 | /** | 48 | /** |
| 49 | - * Gets tunnels. | 49 | + * Returns tunnels created on this device. |
| 50 | * | 50 | * |
| 51 | - * return collection of tunnel | 51 | + * @return collection of tunnels |
| 52 | */ | 52 | */ |
| 53 | Collection<TunnelDescription> getTunnels(); | 53 | Collection<TunnelDescription> getTunnels(); |
| 54 | 54 | ... | ... |
| ... | @@ -37,7 +37,8 @@ public class DefaultDriverData implements DriverData { | ... | @@ -37,7 +37,8 @@ public class DefaultDriverData implements DriverData { |
| 37 | /** | 37 | /** |
| 38 | * Creates new driver data. | 38 | * Creates new driver data. |
| 39 | * | 39 | * |
| 40 | - * @param driver parent driver type | 40 | + * @param driver parent driver type |
| 41 | + * @param deviceId device identifier | ||
| 41 | */ | 42 | */ |
| 42 | public DefaultDriverData(Driver driver, DeviceId deviceId) { | 43 | public DefaultDriverData(Driver driver, DeviceId deviceId) { |
| 43 | this.driver = driver; | 44 | this.driver = driver; | ... | ... |
| 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 | + * Flow meter model and related services. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.net.meter; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| 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 | + * Generic network resource model and services for resource allocation and | ||
| 19 | + * resource tracking. | ||
| 20 | + */ | ||
| 21 | +package org.onosproject.net.newresource; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -72,7 +72,7 @@ public final class UiExtension { | ... | @@ -72,7 +72,7 @@ public final class UiExtension { |
| 72 | * @return JavaScript inclusion statements | 72 | * @return JavaScript inclusion statements |
| 73 | */ | 73 | */ |
| 74 | public InputStream js() { | 74 | public InputStream js() { |
| 75 | - return getStream(resourcePath + JS_HTML); | 75 | + return getStream(resourcePath + JS_HTML); |
| 76 | } | 76 | } |
| 77 | 77 | ||
| 78 | /** | 78 | /** |
| ... | @@ -141,7 +141,8 @@ public final class UiExtension { | ... | @@ -141,7 +141,8 @@ public final class UiExtension { |
| 141 | * Views defaults to an empty list. | 141 | * Views defaults to an empty list. |
| 142 | * Both Message and TopoOverlay factories default to null. | 142 | * Both Message and TopoOverlay factories default to null. |
| 143 | * | 143 | * |
| 144 | - * @param cl the classloader | 144 | + * @param cl the class loader |
| 145 | + * @param views list of views contributed by this extension | ||
| 145 | */ | 146 | */ |
| 146 | public Builder(ClassLoader cl, List<UiView> views) { | 147 | public Builder(ClassLoader cl, List<UiView> views) { |
| 147 | checkNotNull(cl, "Must provide a class loader"); | 148 | checkNotNull(cl, "Must provide a class loader"); | ... | ... |
| 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 | + * Mechanism for dynamically extending topology view with information and | ||
| 19 | + * behaviour overlays. | ||
| 20 | + */ | ||
| 21 | +package org.onosproject.ui.topo; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
core/net/src/main/java/org/onosproject/net/flowobjective/impl/composition/package-info.java
0 → 100644
| 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 | + * Prototype of a composition mechanism for flow objective composition. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.net.flowobjective.impl.composition; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| 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 | + * Implementation of the generic network resource subsystem. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.net.newresource.impl; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| 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 | + * Implementation of the network resource distributed store. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.store.newresource.impl; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -49,7 +49,7 @@ | ... | @@ -49,7 +49,7 @@ |
| 49 | <version>2.10.1</version> | 49 | <version>2.10.1</version> |
| 50 | <configuration> | 50 | <configuration> |
| 51 | <show>package</show> | 51 | <show>package</show> |
| 52 | - <excludePackageNames>org.onlab.thirdparty:*.impl:*.impl.*:org.onosproject.provider.*:org.onosproject.rest:org.onosproject.cli*:org.onosproject.tvue:org.onosproject.foo:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.optical:org.onosproject.config:org.onosproject.calendar:org.onosproject.sdnip*:org.onosproject.oecfg:org.onosproject.metrics:org.onosproject.store.*:org.onosproject.openflow.*:org.onosproject.common.*:org.onosproject.net.group.impl:org.onosproject.routing*:org.onosproject.bgprouter:org.onosproject.intentperf:org.onosproject.maven:org.onosproject.cordfabric*:org.onosproject.driver*:org.onosproject.segmentrouting*:org.onosproject.reactive*:org.onosproject.distributedprimitives*:org.onosproject.messagingperf*.org.onosproject.virtualbng*.org.onosproject.election*:org.onosproject.demo*:org.onlab.jdvue*:org.onlab.stc*:org.onosproject.xosintegration*</excludePackageNames> | 52 | + <excludePackageNames>org.onlab.thirdparty:*.impl:*.impl.*:org.onosproject.provider.*:org.onosproject.rest:org.onosproject.cli*:org.onosproject.tvue:org.onosproject.foo:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.optical:org.onosproject.config:org.onosproject.calendar:org.onosproject.sdnip*:org.onosproject.oecfg:org.onosproject.metrics:org.onosproject.store.*:org.onosproject.openflow.*:org.onosproject.common.*:org.onosproject.net.group.impl:org.onosproject.routing*:org.onosproject.bgprouter:org.onosproject.intentperf:org.onosproject.maven:org.onosproject.cordfabric*:org.onosproject.driver*:org.onosproject.segmentrouting*:org.onosproject.reactive*:org.onosproject.distributedprimitives*:org.onosproject.messagingperf*.org.onosproject.virtualbng*.org.onosproject.election*:org.onosproject.demo*:org.onlab.jdvue*:org.onlab.stc*:org.onosproject.xosintegration*:org.onosproject.app.vtn*:org.onosproject.ovsdb*:org.onosproject.aaa:org.onosproject.acl*:org.onosproject.flowanalyzer</excludePackageNames> |
| 53 | <docfilessubdirs>true</docfilessubdirs> | 53 | <docfilessubdirs>true</docfilessubdirs> |
| 54 | <doctitle>ONOS Java API (1.3.0-SNAPSHOT)</doctitle> | 54 | <doctitle>ONOS Java API (1.3.0-SNAPSHOT)</doctitle> |
| 55 | <groups> | 55 | <groups> | ... | ... |
| ... | @@ -67,7 +67,7 @@ | ... | @@ -67,7 +67,7 @@ |
| 67 | <group> | 67 | <group> |
| 68 | <title>Core Subsystems</title> | 68 | <title>Core Subsystems</title> |
| 69 | <packages> | 69 | <packages> |
| 70 | - org.onosproject.impl:org.onosproject.core.impl:org.onosproject.cluster.impl:org.onosproject.net.device.impl:org.onosproject.net.link.impl:org.onosproject.net.host.impl:org.onosproject.net.topology.impl:org.onosproject.net.packet.impl:org.onosproject.net.flow.impl:org.onosproject.net.*.impl:org.onosproject.event.impl:org.onosproject.net.intent.impl*:org.onosproject.net.proxyarp.impl:org.onosproject.mastership.impl:org.onosproject.net.resource.impl:org.onosproject.json:org.onosproject.json.*:org.onosproject.provider.host.impl:org.onosproject.provider.lldp.impl:org.onosproject.net.statistic.impl:org.onosproject.app.impl:org.onosproject.common.*:org.onosproject.net.group.impl:org.onosproject.cfg.impl:org.onosproject.net.driver.impl:org.onosproject.net.flowobjective.impl:org.onosproject.net.flowext.impl:org.onosproject.net.tunnel.impl:org.onosproject.security.* | 70 | + org.onosproject.impl:org.onosproject.core.impl:org.onosproject.cluster.impl:org.onosproject.net.device.impl:org.onosproject.net.link.impl:org.onosproject.net.host.impl:org.onosproject.net.topology.impl:org.onosproject.net.packet.impl:org.onosproject.net.flow.impl:org.onosproject.net.*.impl:org.onosproject.event.impl:org.onosproject.net.intent.impl*:org.onosproject.net.proxyarp.impl:org.onosproject.mastership.impl:org.onosproject.net.resource.impl:org.onosproject.net.newresource.impl:org.onosproject.json:org.onosproject.json.*:org.onosproject.provider.host.impl:org.onosproject.provider.lldp.impl:org.onosproject.net.statistic.impl:org.onosproject.app.impl:org.onosproject.common.*:org.onosproject.net.group.impl:org.onosproject.cfg.impl:org.onosproject.net.driver.impl:org.onosproject.net.flowobjective.impl*:org.onosproject.net.flowext.impl:org.onosproject.net.tunnel.impl:org.onosproject.security.* |
| 71 | </packages> | 71 | </packages> |
| 72 | </group> | 72 | </group> |
| 73 | <group> | 73 | <group> |
| ... | @@ -79,7 +79,7 @@ | ... | @@ -79,7 +79,7 @@ |
| 79 | <group> | 79 | <group> |
| 80 | <title>Incubator for Core Subsystems & Distributed Stores</title> | 80 | <title>Incubator for Core Subsystems & Distributed Stores</title> |
| 81 | <packages> | 81 | <packages> |
| 82 | - org.onosproject.incubator.net.impl:org.onosproject.incubator.store.impl:org.onosproject.incubator.net.resource.label.impl:org.onosproject.incubator.store.resource.impl:org.onosproject.incubator.net.tunnel.impl:org.onosproject.incubator.store.tunnel.impl | 82 | + org.onosproject.incubator.net.impl:org.onosproject.incubator.store.impl:org.onosproject.incubator.net.resource.label.impl:org.onosproject.incubator.store.resource.impl:org.onosproject.incubator.net.tunnel.impl:org.onosproject.incubator.store.tunnel.impl:org.onosproject.incubator.net.config.impl:org.onosproject.incubator.net.domain.impl:org.onosproject.incubator.store.config.impl |
| 83 | </packages> | 83 | </packages> |
| 84 | </group> | 84 | </group> |
| 85 | <group> | 85 | <group> |
| ... | @@ -95,6 +95,12 @@ | ... | @@ -95,6 +95,12 @@ |
| 95 | </packages> | 95 | </packages> |
| 96 | </group> | 96 | </group> |
| 97 | <group> | 97 | <group> |
| 98 | + <title>OVSDB Providers</title> | ||
| 99 | + <packages> | ||
| 100 | + org.onosproject.provider.ovsdb*:org.onosproject.ovsdb* | ||
| 101 | + </packages> | ||
| 102 | + </group> | ||
| 103 | + <group> | ||
| 98 | <title>Other Providers</title> | 104 | <title>Other Providers</title> |
| 99 | <packages> | 105 | <packages> |
| 100 | org.onosproject.provider.* | 106 | org.onosproject.provider.* |
| ... | @@ -119,19 +125,19 @@ | ... | @@ -119,19 +125,19 @@ |
| 119 | </packages> | 125 | </packages> |
| 120 | </group> | 126 | </group> |
| 121 | <group> | 127 | <group> |
| 122 | - <title>Sample Applications</title> | 128 | + <title>Builtin Applications</title> |
| 123 | <packages> | 129 | <packages> |
| 124 | - org.onosproject.tvue:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.foo:org.onosproject.calendar:org.onosproject.optical:org.onosproject.optical.*:org.onosproject.sdnip:org.onosproject.sdnip.*:org.onosproject.config:org.onosproject.routing:org.onosproject.routing*:org.onosproject.bgprouter:org.onosproject.intentperf:org.onosproject.segmentrouting:org.onosproject.segmentrouting.*:org.onosproject.reactive.routing*:org.onosproject.messagingperf:org.onosproject.virtualbng:org.onosproject.demo*:org.onosproject.election*:org.onosproject.distributedprimitives*:org.onosproject.cordfabric*:org.onosproject.xosintegration*:org.onosproject.pcep* | 130 | + org.onosproject.app.*:org.onosproject.acl*:org.onosproject.aaa:org.onosproject.fwd:org.onosproject.flowanalyzer:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.calendar:org.onosproject.optical:org.onosproject.optical.*:org.onosproject.sdnip:org.onosproject.sdnip.*:org.onosproject.config:org.onosproject.routing:org.onosproject.routing*:org.onosproject.bgprouter:org.onosproject.segmentrouting:org.onosproject.segmentrouting.*:org.onosproject.reactive.routing*:org.onosproject.messagingperf:org.onosproject.virtualbng:org.onosproject.cordfabric*:org.onosproject.xosintegration*:org.onosproject.pcep* |
| 125 | </packages> | 131 | </packages> |
| 126 | </group> | 132 | </group> |
| 127 | <group> | 133 | <group> |
| 128 | - <title>Test Instrumentation</title> | 134 | + <title>Test Instrumentation & Applications</title> |
| 129 | <packages> | 135 | <packages> |
| 130 | - org.onosproject.metrics.* | 136 | + org.onosproject.metrics.*:org.onosproject.demo*:org.onosproject.election*:org.onosproject.distributedprimitives*:org.onosproject.intentperf*:org.onosproject.messagingperf*:org.onosproject.optical.testapp* |
| 131 | </packages> | 137 | </packages> |
| 132 | </group> | 138 | </group> |
| 133 | </groups> | 139 | </groups> |
| 134 | - <excludePackageNames>org.onlab.thirdparty:org.onosproject.oecfg:org.onosproject.maven:org.onlab.jdvue*</excludePackageNames> | 140 | + <excludePackageNames>org.onlab.thirdparty:org.onosproject.oecfg:org.onosproject.maven:org.onlab.jdvue*:org.onlab.stc*</excludePackageNames> |
| 135 | </configuration> | 141 | </configuration> |
| 136 | </plugin> | 142 | </plugin> |
| 137 | </plugins> | 143 | </plugins> | ... | ... |
| ... | @@ -243,6 +243,7 @@ public abstract class Config<S> { | ... | @@ -243,6 +243,7 @@ public abstract class Config<S> { |
| 243 | * @param name property name | 243 | * @param name property name |
| 244 | * @param defaultValue default value if property not set | 244 | * @param defaultValue default value if property not set |
| 245 | * @param enumClass the enum class | 245 | * @param enumClass the enum class |
| 246 | + * @param <E> type of enum | ||
| 246 | * @return property value or default value | 247 | * @return property value or default value |
| 247 | */ | 248 | */ |
| 248 | protected <E extends Enum<E>> E get(String name, E defaultValue, Class<E> enumClass) { | 249 | protected <E extends Enum<E>> E get(String name, E defaultValue, Class<E> enumClass) { |
| ... | @@ -254,6 +255,7 @@ public abstract class Config<S> { | ... | @@ -254,6 +255,7 @@ public abstract class Config<S> { |
| 254 | * | 255 | * |
| 255 | * @param name property name | 256 | * @param name property name |
| 256 | * @param value new value or null to clear the property | 257 | * @param value new value or null to clear the property |
| 258 | + * @param <E> type of enum | ||
| 257 | * @return self | 259 | * @return self |
| 258 | */ | 260 | */ |
| 259 | protected <E extends Enum> Config<S> setOrClear(String name, E value) { | 261 | protected <E extends Enum> Config<S> setOrClear(String name, E value) { |
| ... | @@ -268,9 +270,9 @@ public abstract class Config<S> { | ... | @@ -268,9 +270,9 @@ public abstract class Config<S> { |
| 268 | /** | 270 | /** |
| 269 | * Gets the specified array property as a list of items. | 271 | * Gets the specified array property as a list of items. |
| 270 | * | 272 | * |
| 271 | - * @param name property name | 273 | + * @param name property name |
| 272 | * @param function mapper from string to item | 274 | * @param function mapper from string to item |
| 273 | - * @param <T> type of item | 275 | + * @param <T> type of item |
| 274 | * @return list of items | 276 | * @return list of items |
| 275 | */ | 277 | */ |
| 276 | protected <T> List<T> getList(String name, Function<String, T> function) { | 278 | protected <T> List<T> getList(String name, Function<String, T> function) { |
| ... | @@ -284,9 +286,9 @@ public abstract class Config<S> { | ... | @@ -284,9 +286,9 @@ public abstract class Config<S> { |
| 284 | * Sets the specified property as an array of items in a given collection or | 286 | * Sets the specified property as an array of items in a given collection or |
| 285 | * clears it if null is given. | 287 | * clears it if null is given. |
| 286 | * | 288 | * |
| 287 | - * @param name propertyName | 289 | + * @param name propertyName |
| 288 | * @param collection collection of items | 290 | * @param collection collection of items |
| 289 | - * @param <T> type of items | 291 | + * @param <T> type of items |
| 290 | * @return self | 292 | * @return self |
| 291 | */ | 293 | */ |
| 292 | protected <T> Config<S> setOrClear(String name, Collection<T> collection) { | 294 | protected <T> Config<S> setOrClear(String name, Collection<T> collection) { | ... | ... |
| ... | @@ -28,7 +28,7 @@ import java.util.Set; | ... | @@ -28,7 +28,7 @@ import java.util.Set; |
| 28 | */ | 28 | */ |
| 29 | @Beta | 29 | @Beta |
| 30 | public interface NetworkConfigService | 30 | public interface NetworkConfigService |
| 31 | - extends ListenerService<NetworkConfigEvent, NetworkConfigListener> { | 31 | + extends ListenerService<NetworkConfigEvent, NetworkConfigListener> { |
| 32 | 32 | ||
| 33 | /** | 33 | /** |
| 34 | * Returns the set of subject classes for which configuration may be | 34 | * Returns the set of subject classes for which configuration may be |
| ... | @@ -57,7 +57,8 @@ public interface NetworkConfigService | ... | @@ -57,7 +57,8 @@ public interface NetworkConfigService |
| 57 | /** | 57 | /** |
| 58 | * Returns the configuration class with the specified key. | 58 | * Returns the configuration class with the specified key. |
| 59 | * | 59 | * |
| 60 | - * @param configKey subject class name | 60 | + * @param subjectKey subject class key |
| 61 | + * @param configKey subject class name | ||
| 61 | * @return subject class | 62 | * @return subject class |
| 62 | */ | 63 | */ |
| 63 | Class<? extends Config> getConfigClass(String subjectKey, String configKey); | 64 | Class<? extends Config> getConfigClass(String subjectKey, String configKey); | ... | ... |
| ... | @@ -44,7 +44,7 @@ public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkCon | ... | @@ -44,7 +44,7 @@ public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkCon |
| 44 | * | 44 | * |
| 45 | * @param configClass configuration class | 45 | * @param configClass configuration class |
| 46 | * @param <S> type of subject | 46 | * @param <S> type of subject |
| 47 | - * @param <C> type of configuration | 47 | + * @param <C> type of configuration |
| 48 | * @return configuration factory or null | 48 | * @return configuration factory or null |
| 49 | */ | 49 | */ |
| 50 | <S, C extends Config<S>> ConfigFactory<S, C> getConfigFactory(Class<C> configClass); | 50 | <S, C extends Config<S>> ConfigFactory<S, C> getConfigFactory(Class<C> configClass); |
| ... | @@ -112,6 +112,7 @@ public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkCon | ... | @@ -112,6 +112,7 @@ public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkCon |
| 112 | * @param json raw JSON node containing the configuration data | 112 | * @param json raw JSON node containing the configuration data |
| 113 | * @param <S> type of subject | 113 | * @param <S> type of subject |
| 114 | * @param <C> type of configuration | 114 | * @param <C> type of configuration |
| 115 | + * @return configuration object | ||
| 115 | */ | 116 | */ |
| 116 | <S, C extends Config<S>> C applyConfig(S subject, Class<C> configClass, | 117 | <S, C extends Config<S>> C applyConfig(S subject, Class<C> configClass, |
| 117 | ObjectNode json); | 118 | ObjectNode json); | ... | ... |
| ... | @@ -67,8 +67,9 @@ public abstract class SubjectFactory<S> { | ... | @@ -67,8 +67,9 @@ public abstract class SubjectFactory<S> { |
| 67 | /** | 67 | /** |
| 68 | * Creates a configuration subject from its key image. | 68 | * Creates a configuration subject from its key image. |
| 69 | * | 69 | * |
| 70 | + * @param subjectKey subject class key | ||
| 70 | * @return configuration subject | 71 | * @return configuration subject |
| 71 | */ | 72 | */ |
| 72 | - public abstract S createSubject(String key); | 73 | + public abstract S createSubject(String subjectKey); |
| 73 | 74 | ||
| 74 | } | 75 | } | ... | ... |
incubator/api/src/main/java/org/onosproject/incubator/net/config/basics/package-info.java
0 → 100644
| 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 | + * Various basic builtin network configurations. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.incubator.net.config.basics; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| 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 | + * Implementation of the network configuration subsystem. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.incubator.net.config.impl; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| 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 | + * Implementation of the intent domain subsystem. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.incubator.net.domain.impl; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
incubator/store/src/main/java/org/onosproject/incubator/store/config/impl/package-info.java
0 → 100644
| 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 | + * Implementation of the network configuration distributed store. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.incubator.store.config.impl; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -88,7 +88,7 @@ public class EAP extends BasePacket { | ... | @@ -88,7 +88,7 @@ public class EAP extends BasePacket { |
| 88 | /** | 88 | /** |
| 89 | * Sets the EAP identifier. | 89 | * Sets the EAP identifier. |
| 90 | * | 90 | * |
| 91 | - * @param identifier | 91 | + * @param identifier EAP identifier |
| 92 | * @return this | 92 | * @return this |
| 93 | */ | 93 | */ |
| 94 | public EAP setIdentifier(final byte identifier) { | 94 | public EAP setIdentifier(final byte identifier) { | ... | ... |
| ... | @@ -389,6 +389,7 @@ public abstract class Tools { | ... | @@ -389,6 +389,7 @@ public abstract class Tools { |
| 389 | /** | 389 | /** |
| 390 | * Returns the future value when complete or if future | 390 | * Returns the future value when complete or if future |
| 391 | * completes exceptionally returns the defaultValue. | 391 | * completes exceptionally returns the defaultValue. |
| 392 | + * | ||
| 392 | * @param future future | 393 | * @param future future |
| 393 | * @param defaultValue default value | 394 | * @param defaultValue default value |
| 394 | * @param <T> future value type | 395 | * @param <T> future value type |
| ... | @@ -409,6 +410,7 @@ public abstract class Tools { | ... | @@ -409,6 +410,7 @@ public abstract class Tools { |
| 409 | /** | 410 | /** |
| 410 | * Returns the future value when complete or if future | 411 | * Returns the future value when complete or if future |
| 411 | * completes exceptionally returns the defaultValue. | 412 | * completes exceptionally returns the defaultValue. |
| 413 | + * | ||
| 412 | * @param future future | 414 | * @param future future |
| 413 | * @param timeout time to wait for successful completion | 415 | * @param timeout time to wait for successful completion |
| 414 | * @param timeUnit time unit | 416 | * @param timeUnit time unit |
| ... | @@ -433,6 +435,7 @@ public abstract class Tools { | ... | @@ -433,6 +435,7 @@ public abstract class Tools { |
| 433 | 435 | ||
| 434 | /** | 436 | /** |
| 435 | * Returns a future that is completed exceptionally. | 437 | * Returns a future that is completed exceptionally. |
| 438 | + * | ||
| 436 | * @param t exception | 439 | * @param t exception |
| 437 | * @param <T> future value type | 440 | * @param <T> future value type |
| 438 | * @return future | 441 | * @return future |
| ... | @@ -448,6 +451,7 @@ public abstract class Tools { | ... | @@ -448,6 +451,7 @@ public abstract class Tools { |
| 448 | * <p> | 451 | * <p> |
| 449 | * WARNING: There is a performance cost due to array copy | 452 | * WARNING: There is a performance cost due to array copy |
| 450 | * when using this method. | 453 | * when using this method. |
| 454 | + * | ||
| 451 | * @param buffer byte buffer | 455 | * @param buffer byte buffer |
| 452 | * @return byte array containing the byte buffer contents | 456 | * @return byte array containing the byte buffer contents |
| 453 | */ | 457 | */ |
| ... | @@ -463,10 +467,11 @@ public abstract class Tools { | ... | @@ -463,10 +467,11 @@ public abstract class Tools { |
| 463 | } | 467 | } |
| 464 | 468 | ||
| 465 | /** | 469 | /** |
| 466 | - * Converts an Iterable to a Stream. | 470 | + * Converts an iterable to a stream. |
| 467 | * | 471 | * |
| 468 | - * @param it Iterable to convert | 472 | + * @param it iterable to convert |
| 469 | - * @return Iterable as a Stream | 473 | + * @param <T> type if item |
| 474 | + * @return iterable as a stream | ||
| 470 | */ | 475 | */ |
| 471 | public static <T> Stream<T> stream(Iterable<T> it) { | 476 | public static <T> Stream<T> stream(Iterable<T> it) { |
| 472 | return StreamSupport.stream(it.spliterator(), false); | 477 | return StreamSupport.stream(it.spliterator(), false); | ... | ... |
| ... | @@ -129,7 +129,7 @@ public class NetworkConfigWebResource extends AbstractWebResource { | ... | @@ -129,7 +129,7 @@ public class NetworkConfigWebResource extends AbstractWebResource { |
| 129 | * Uploads network configuration in bulk. | 129 | * Uploads network configuration in bulk. |
| 130 | * | 130 | * |
| 131 | * @param request network configuration JSON rooted at the top node | 131 | * @param request network configuration JSON rooted at the top node |
| 132 | - * @throws IOException | 132 | + * @throws IOException if unable to parse the request |
| 133 | * @return empty response | 133 | * @return empty response |
| 134 | */ | 134 | */ |
| 135 | @POST | 135 | @POST |
| ... | @@ -150,7 +150,7 @@ public class NetworkConfigWebResource extends AbstractWebResource { | ... | @@ -150,7 +150,7 @@ public class NetworkConfigWebResource extends AbstractWebResource { |
| 150 | * @param subjectKey subject class key | 150 | * @param subjectKey subject class key |
| 151 | * @param request network configuration JSON rooted at the top node | 151 | * @param request network configuration JSON rooted at the top node |
| 152 | * @return empty response | 152 | * @return empty response |
| 153 | - * @throws IOException | 153 | + * @throws IOException if unable to parse the request |
| 154 | */ | 154 | */ |
| 155 | @POST | 155 | @POST |
| 156 | @Path("{subjectKey}") | 156 | @Path("{subjectKey}") |
| ... | @@ -171,7 +171,7 @@ public class NetworkConfigWebResource extends AbstractWebResource { | ... | @@ -171,7 +171,7 @@ public class NetworkConfigWebResource extends AbstractWebResource { |
| 171 | * @param subject subject key | 171 | * @param subject subject key |
| 172 | * @param request network configuration JSON rooted at the top node | 172 | * @param request network configuration JSON rooted at the top node |
| 173 | * @return empty response | 173 | * @return empty response |
| 174 | - * @throws IOException | 174 | + * @throws IOException if unable to parse the request |
| 175 | */ | 175 | */ |
| 176 | @POST | 176 | @POST |
| 177 | @Path("{subjectKey}/{subject}") | 177 | @Path("{subjectKey}/{subject}") |
| ... | @@ -197,7 +197,7 @@ public class NetworkConfigWebResource extends AbstractWebResource { | ... | @@ -197,7 +197,7 @@ public class NetworkConfigWebResource extends AbstractWebResource { |
| 197 | * @param configKey configuration class key | 197 | * @param configKey configuration class key |
| 198 | * @param request network configuration JSON rooted at the top node | 198 | * @param request network configuration JSON rooted at the top node |
| 199 | * @return empty response | 199 | * @return empty response |
| 200 | - * @throws IOException | 200 | + * @throws IOException if unable to parse the request |
| 201 | */ | 201 | */ |
| 202 | @POST | 202 | @POST |
| 203 | @Path("{subjectKey}/{subject}/{configKey}") | 203 | @Path("{subjectKey}/{subject}/{configKey}") | ... | ... |
-
Please register or login to post a comment