Fixing javadoc warnings, provided missing package javadocs and corrected group structure.

Change-Id: I2637afe49b81e8e6d10ef3bb0f2a1cf50b2564cc
This commit is contained in:
Thomas Vachuska 2015-07-30 11:59:07 -07:00 committed by Gerrit Code Review
parent bc37196828
commit d894b5d5f7
28 changed files with 345 additions and 51 deletions

View File

@ -23,6 +23,7 @@ import org.onosproject.net.ConnectPoint;
import org.onosproject.xosintegration.VoltTenant; import org.onosproject.xosintegration.VoltTenant;
import org.onosproject.xosintegration.VoltTenantService; import org.onosproject.xosintegration.VoltTenantService;
import org.slf4j.Logger; import org.slf4j.Logger;
import java.util.BitSet; import java.util.BitSet;
import static org.slf4j.LoggerFactory.getLogger; import static org.slf4j.LoggerFactory.getLogger;
@ -111,7 +112,9 @@ class StateMachine {
/** /**
* State Machine Constructor. * State Machine Constructor.
* @param sessionId Session Id represented by the switch dpid + port number *
* @param sessionId session Id represented by the switch dpid + port number
* @param voltService volt service reference
*/ */
public StateMachine(String sessionId, VoltTenantService voltService) { public StateMachine(String sessionId, VoltTenantService voltService) {
log.info("Creating a new state machine for {}", sessionId); log.info("Creating a new state machine for {}", sessionId);
@ -122,6 +125,7 @@ class StateMachine {
/** /**
* Get the client id that is requesting for access. * Get the client id that is requesting for access.
*
* @return The client id. * @return The client id.
*/ */
public String getSessionId() { public String getSessionId() {
@ -154,15 +158,18 @@ class StateMachine {
/** /**
* Set the challenge identifier and the state issued by the RADIUS. * Set the challenge identifier and the state issued by the RADIUS.
*
* @param challengeIdentifier The challenge identifier set into the EAP packet from the RADIUS message. * @param challengeIdentifier The challenge identifier set into the EAP packet from the RADIUS message.
* @param challengeState The challenge state from the RADIUS. * @param challengeState The challenge state from the RADIUS.
*/ */
protected void setChallengeInfo(byte challengeIdentifier, byte[] challengeState) { protected void setChallengeInfo(byte challengeIdentifier, byte[] challengeState) {
this.challengeIdentifier = challengeIdentifier; this.challengeIdentifier = challengeIdentifier;
this.challengeState = challengeState; this.challengeState = challengeState;
} }
/** /**
* Set the challenge identifier issued by the RADIUS on the access challenge request. * Set the challenge identifier issued by the RADIUS on the access challenge request.
*
* @param challengeIdentifier The challenge identifier set into the EAP packet from the RADIUS message. * @param challengeIdentifier The challenge identifier set into the EAP packet from the RADIUS message.
*/ */
protected void setChallengeIdentifier(byte challengeIdentifier) { protected void setChallengeIdentifier(byte challengeIdentifier) {
@ -172,6 +179,7 @@ class StateMachine {
/** /**
* Get the challenge EAP identifier set by the RADIUS. * Get the challenge EAP identifier set by the RADIUS.
*
* @return The challenge EAP identifier. * @return The challenge EAP identifier.
*/ */
protected byte getChallengeIdentifier() { protected byte getChallengeIdentifier() {
@ -181,6 +189,7 @@ class StateMachine {
/** /**
* Set the challenge state info issued by the RADIUS. * Set the challenge state info issued by the RADIUS.
*
* @param challengeState The challenge state from the RADIUS. * @param challengeState The challenge state from the RADIUS.
*/ */
protected void setChallengeState(byte[] challengeState) { protected void setChallengeState(byte[] challengeState) {
@ -190,6 +199,7 @@ class StateMachine {
/** /**
* Get the challenge state set by the RADIUS. * Get the challenge state set by the RADIUS.
*
* @return The challenge state. * @return The challenge state.
*/ */
protected byte[] getChallengeState() { protected byte[] getChallengeState() {
@ -198,6 +208,7 @@ class StateMachine {
/** /**
* Set the username. * Set the username.
*
* @param username The username sent to the RADIUS upon access request. * @param username The username sent to the RADIUS upon access request.
*/ */
protected void setUsername(byte[] username) { protected void setUsername(byte[] username) {
@ -207,6 +218,7 @@ class StateMachine {
/** /**
* Get the username. * Get the username.
*
* @return The requestAuthenticator. * @return The requestAuthenticator.
*/ */
protected byte[] getReqeustAuthenticator() { protected byte[] getReqeustAuthenticator() {
@ -215,6 +227,7 @@ class StateMachine {
/** /**
* Set the username. * Set the username.
*
* @param authenticator The username sent to the RADIUS upon access request. * @param authenticator The username sent to the RADIUS upon access request.
*/ */
protected void setRequestAuthenticator(byte[] authenticator) { protected void setRequestAuthenticator(byte[] authenticator) {
@ -224,6 +237,7 @@ class StateMachine {
/** /**
* Get the username. * Get the username.
*
* @return The username. * @return The username.
*/ */
protected byte[] getUsername() { protected byte[] getUsername() {
@ -232,6 +246,7 @@ class StateMachine {
/** /**
* Return the identifier of the state machine. * Return the identifier of the state machine.
*
* @return The state machine identifier. * @return The state machine identifier.
*/ */
public byte getIdentifier() { public byte getIdentifier() {
@ -251,15 +266,18 @@ class StateMachine {
/** /**
* Move to the next state. * Move to the next state.
*
* @param msg * @param msg
*/ */
private void next(int msg) { private void next(int msg) {
currentState = transition[currentState][msg]; currentState = transition[currentState][msg];
log.info("Current State " + currentState); log.info("Current State " + currentState);
} }
/** /**
* Client has requested the start action to allow network access. * Client has requested the start action to allow network access.
*
* @throws StateMachineException if authentication protocol is violated
*/ */
public void start() throws StateMachineException { public void start() throws StateMachineException {
try { try {
@ -275,6 +293,8 @@ class StateMachine {
/** /**
* An Identification information has been sent by the supplicant. * An Identification information has been sent by the supplicant.
* Move to the next state if possible. * Move to the next state if possible.
*
* @throws StateMachineException if authentication protocol is violated
*/ */
public void requestAccess() throws StateMachineException { public void requestAccess() throws StateMachineException {
try { try {
@ -289,6 +309,8 @@ class StateMachine {
/** /**
* RADIUS has accepted the identification. * RADIUS has accepted the identification.
* Move to the next state if possible. * Move to the next state if possible.
*
* @throws StateMachineException if authentication protocol is violated
*/ */
public void authorizeAccess() throws StateMachineException { public void authorizeAccess() throws StateMachineException {
try { try {
@ -317,6 +339,8 @@ class StateMachine {
/** /**
* RADIUS has denied the identification. * RADIUS has denied the identification.
* Move to the next state if possible. * Move to the next state if possible.
*
* @throws StateMachineException if authentication protocol is violated
*/ */
public void denyAccess() throws StateMachineException { public void denyAccess() throws StateMachineException {
try { try {
@ -332,6 +356,8 @@ class StateMachine {
/** /**
* Logoff request has been requested. * Logoff request has been requested.
* Move to the next state if possible. * Move to the next state if possible.
*
* @throws StateMachineException if authentication protocol is violated
*/ */
public void logoff() throws StateMachineException { public void logoff() throws StateMachineException {
try { try {
@ -345,6 +371,7 @@ class StateMachine {
/** /**
* Get the current state. * Get the current state.
*
* @return The current state. Could be STATE_IDLE, STATE_STARTED, STATE_PENDING, STATE_AUTHORIZED, * @return The current state. Could be STATE_IDLE, STATE_STARTED, STATE_PENDING, STATE_AUTHORIZED,
* STATE_UNAUTHORIZED. * STATE_UNAUTHORIZED.
*/ */
@ -353,13 +380,14 @@ class StateMachine {
} }
public String toString() { public String toString() {
return ("sessionId: " + this.sessionId) + "\t" + ("identifier: " + this.identifier) + "\t" + return ("sessionId: " + this.sessionId) + "\t" + ("identifier: " + this.identifier) + "\t" +
("state: " + this.currentState); ("state: " + this.currentState);
} }
} }
// FIXME: A source file should contain no more than one top-level entity!
abstract class State { abstract class State {
private final Logger log = getLogger(getClass()); private final Logger log = getLogger(getClass());
@ -368,15 +396,19 @@ abstract class State {
public void start() throws StateMachineInvalidTransitionException { public void start() throws StateMachineInvalidTransitionException {
log.warn("START transition from this state is not allowed."); log.warn("START transition from this state is not allowed.");
} }
public void requestAccess() throws StateMachineInvalidTransitionException { public void requestAccess() throws StateMachineInvalidTransitionException {
log.warn("REQUEST ACCESS transition from this state is not allowed."); log.warn("REQUEST ACCESS transition from this state is not allowed.");
} }
public void radiusAccepted() throws StateMachineInvalidTransitionException { public void radiusAccepted() throws StateMachineInvalidTransitionException {
log.warn("AUTHORIZE ACCESS transition from this state is not allowed."); log.warn("AUTHORIZE ACCESS transition from this state is not allowed.");
} }
public void radiusDenied() throws StateMachineInvalidTransitionException { public void radiusDenied() throws StateMachineInvalidTransitionException {
log.warn("DENY ACCESS transition from this state is not allowed."); log.warn("DENY ACCESS transition from this state is not allowed.");
} }
public void logoff() throws StateMachineInvalidTransitionException { public void logoff() throws StateMachineInvalidTransitionException {
log.warn("LOGOFF transition from this state is not allowed."); log.warn("LOGOFF transition from this state is not allowed.");
} }
@ -457,6 +489,7 @@ class StateMachineException extends Exception {
} }
} }
/** /**
* Exception raised when the transition from one state to another is invalid. * Exception raised when the transition from one state to another is invalid.
*/ */

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Prototype application for scanning the flow space for cycles and black holes.
*/
package org.onosproject.flowanalyzer;

View File

@ -59,10 +59,11 @@ public class PolicyHandler {
/** /**
* Creates a reference. * Creates a reference.
* *
* @param appId segment routing application ID * @param appId segment routing application ID
* @param deviceConfiguration DeviceConfiguration reference * @param deviceConfiguration DeviceConfiguration reference
* @param flowObjectiveService FlowObjectiveService reference * @param flowObjectiveService FlowObjectiveService reference
* @param policyStore policy store * @param tunnelHandler tunnel handler reference
* @param policyStore policy store
*/ */
public PolicyHandler(ApplicationId appId, public PolicyHandler(ApplicationId appId,
DeviceConfiguration deviceConfiguration, DeviceConfiguration deviceConfiguration,

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Segment routing application CLI handlers.
*/
package org.onosproject.segmentrouting.cli;

View File

@ -53,24 +53,24 @@ public interface VirtualPortService {
/** /**
* Returns the collection of the virtualPorts associated with the networkId. * Returns the collection of the virtualPorts associated with the networkId.
* *
* @param networkId * @param networkId network identifier
* @return collection of virtualPort. * @return collection of virtualPort
*/ */
Collection<VirtualPort> getPorts(TenantNetworkId networkId); Collection<VirtualPort> getPorts(TenantNetworkId networkId);
/** /**
* Returns the collection of the virtualPorts associated with the tenantId. * Returns the collection of the virtualPorts associated with the tenantId.
* *
* @param tenantId * @param tenantId tenant identifier
* @return collection of virtualPort. * @return collection of virtualPort
*/ */
Collection<VirtualPort> getPorts(TenantId tenantId); Collection<VirtualPort> getPorts(TenantId tenantId);
/** /**
* Returns the collection of the virtualPorts associated with the deviceId. * Returns the collection of the virtualPorts associated with the deviceId.
* *
* @param deviceId * @param deviceId device identifier
* @return collection of virtualPort. * @return collection of virtualPort
*/ */
Collection<VirtualPort> getPorts(DeviceId deviceId); Collection<VirtualPort> getPorts(DeviceId deviceId);
@ -86,7 +86,7 @@ public interface VirtualPortService {
* Updates virtualPorts by virtualPorts. * Updates virtualPorts by virtualPorts.
* *
* @param virtualPorts the iterable collection of virtualPorts * @param virtualPorts the iterable collection of virtualPorts
* @return true if all given identifiers updated successfully. * @return true if all given identifiers updated successfully
*/ */
boolean updatePorts(Iterable<VirtualPort> virtualPorts); boolean updatePorts(Iterable<VirtualPort> virtualPorts);
@ -95,7 +95,7 @@ public interface VirtualPortService {
* *
* @param virtualPortIds the iterable collection of virtualPort identifiers * @param virtualPortIds the iterable collection of virtualPort identifiers
* @return true or false if one with the given identifier to delete is * @return true or false if one with the given identifier to delete is
* successfully. * successfully
*/ */
boolean removePorts(Iterable<VirtualPortId> virtualPortIds); boolean removePorts(Iterable<VirtualPortId> virtualPortIds);
} }

View File

@ -63,7 +63,7 @@ public interface BridgeConfig extends HandlerBehaviour {
/** /**
* Delete a logical/virtual port. * Delete a logical/virtual port.
* *
* return collection of port * @return collection of port
*/ */
Collection<PortDescription> getPorts(); Collection<PortDescription> getPorts();
} }

View File

@ -25,30 +25,30 @@ import org.onosproject.net.driver.HandlerBehaviour;
public interface TunnelConfig extends HandlerBehaviour { public interface TunnelConfig extends HandlerBehaviour {
/** /**
* Create a tunnel. * Creates a tunnel on this device.
* *
* @param tunnel tunnel entity * @param tunnel tunnel descriptor
*/ */
void createTunnel(TunnelDescription tunnel); void createTunnel(TunnelDescription tunnel);
/** /**
* Remove a tunnel. * Removes a tunnel on this device.
* *
* @param tunnel tunnel entity * @param tunnel tunnel descriptor
*/ */
void removeTunnel(TunnelDescription tunnel); void removeTunnel(TunnelDescription tunnel);
/** /**
* Update a tunnel. * Updates a tunnel on this device.
* *
* @param tunnel tunnel entity * @param tunnel tunnel descriptor
*/ */
void updateTunnel(TunnelDescription tunnel); void updateTunnel(TunnelDescription tunnel);
/** /**
* Gets tunnels. * Returns tunnels created on this device.
* *
* return collection of tunnel * @return collection of tunnels
*/ */
Collection<TunnelDescription> getTunnels(); Collection<TunnelDescription> getTunnels();

View File

@ -37,7 +37,8 @@ public class DefaultDriverData implements DriverData {
/** /**
* Creates new driver data. * Creates new driver data.
* *
* @param driver parent driver type * @param driver parent driver type
* @param deviceId device identifier
*/ */
public DefaultDriverData(Driver driver, DeviceId deviceId) { public DefaultDriverData(Driver driver, DeviceId deviceId) {
this.driver = driver; this.driver = driver;

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Flow meter model and related services.
*/
package org.onosproject.net.meter;

View File

@ -0,0 +1,21 @@
/*
* Copyright 2015 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.
*/
/**
* Generic network resource model and services for resource allocation and
* resource tracking.
*/
package org.onosproject.net.newresource;

View File

@ -72,7 +72,7 @@ public final class UiExtension {
* @return JavaScript inclusion statements * @return JavaScript inclusion statements
*/ */
public InputStream js() { public InputStream js() {
return getStream(resourcePath + JS_HTML); return getStream(resourcePath + JS_HTML);
} }
/** /**
@ -141,7 +141,8 @@ public final class UiExtension {
* Views defaults to an empty list. * Views defaults to an empty list.
* Both Message and TopoOverlay factories default to null. * Both Message and TopoOverlay factories default to null.
* *
* @param cl the classloader * @param cl the class loader
* @param views list of views contributed by this extension
*/ */
public Builder(ClassLoader cl, List<UiView> views) { public Builder(ClassLoader cl, List<UiView> views) {
checkNotNull(cl, "Must provide a class loader"); checkNotNull(cl, "Must provide a class loader");

View File

@ -0,0 +1,21 @@
/*
* Copyright 2015 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.
*/
/**
* Mechanism for dynamically extending topology view with information and
* behaviour overlays.
*/
package org.onosproject.ui.topo;

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Prototype of a composition mechanism for flow objective composition.
*/
package org.onosproject.net.flowobjective.impl.composition;

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Implementation of the generic network resource subsystem.
*/
package org.onosproject.net.newresource.impl;

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Implementation of the network resource distributed store.
*/
package org.onosproject.store.newresource.impl;

View File

@ -49,7 +49,7 @@
<version>2.10.1</version> <version>2.10.1</version>
<configuration> <configuration>
<show>package</show> <show>package</show>
<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> <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>
<docfilessubdirs>true</docfilessubdirs> <docfilessubdirs>true</docfilessubdirs>
<doctitle>ONOS Java API (1.3.0-SNAPSHOT)</doctitle> <doctitle>ONOS Java API (1.3.0-SNAPSHOT)</doctitle>
<groups> <groups>

View File

@ -67,7 +67,7 @@
<group> <group>
<title>Core Subsystems</title> <title>Core Subsystems</title>
<packages> <packages>
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.* 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.*
</packages> </packages>
</group> </group>
<group> <group>
@ -79,7 +79,7 @@
<group> <group>
<title>Incubator for Core Subsystems &amp; Distributed Stores</title> <title>Incubator for Core Subsystems &amp; Distributed Stores</title>
<packages> <packages>
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.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
</packages> </packages>
</group> </group>
<group> <group>
@ -94,6 +94,12 @@
org.onosproject.provider.netconf:org.onosproject.provider.netconf* org.onosproject.provider.netconf:org.onosproject.provider.netconf*
</packages> </packages>
</group> </group>
<group>
<title>OVSDB Providers</title>
<packages>
org.onosproject.provider.ovsdb*:org.onosproject.ovsdb*
</packages>
</group>
<group> <group>
<title>Other Providers</title> <title>Other Providers</title>
<packages> <packages>
@ -119,19 +125,19 @@
</packages> </packages>
</group> </group>
<group> <group>
<title>Sample Applications</title> <title>Builtin Applications</title>
<packages> <packages>
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* 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*
</packages> </packages>
</group> </group>
<group> <group>
<title>Test Instrumentation</title> <title>Test Instrumentation &amp; Applications</title>
<packages> <packages>
org.onosproject.metrics.* org.onosproject.metrics.*:org.onosproject.demo*:org.onosproject.election*:org.onosproject.distributedprimitives*:org.onosproject.intentperf*:org.onosproject.messagingperf*:org.onosproject.optical.testapp*
</packages> </packages>
</group> </group>
</groups> </groups>
<excludePackageNames>org.onlab.thirdparty:org.onosproject.oecfg:org.onosproject.maven:org.onlab.jdvue*</excludePackageNames> <excludePackageNames>org.onlab.thirdparty:org.onosproject.oecfg:org.onosproject.maven:org.onlab.jdvue*:org.onlab.stc*</excludePackageNames>
</configuration> </configuration>
</plugin> </plugin>
</plugins> </plugins>

View File

@ -243,6 +243,7 @@ public abstract class Config<S> {
* @param name property name * @param name property name
* @param defaultValue default value if property not set * @param defaultValue default value if property not set
* @param enumClass the enum class * @param enumClass the enum class
* @param <E> type of enum
* @return property value or default value * @return property value or default value
*/ */
protected <E extends Enum<E>> E get(String name, E defaultValue, Class<E> enumClass) { protected <E extends Enum<E>> E get(String name, E defaultValue, Class<E> enumClass) {
@ -254,6 +255,7 @@ public abstract class Config<S> {
* *
* @param name property name * @param name property name
* @param value new value or null to clear the property * @param value new value or null to clear the property
* @param <E> type of enum
* @return self * @return self
*/ */
protected <E extends Enum> Config<S> setOrClear(String name, E value) { protected <E extends Enum> Config<S> setOrClear(String name, E value) {
@ -268,9 +270,9 @@ public abstract class Config<S> {
/** /**
* Gets the specified array property as a list of items. * Gets the specified array property as a list of items.
* *
* @param name property name * @param name property name
* @param function mapper from string to item * @param function mapper from string to item
* @param <T> type of item * @param <T> type of item
* @return list of items * @return list of items
*/ */
protected <T> List<T> getList(String name, Function<String, T> function) { protected <T> List<T> getList(String name, Function<String, T> function) {
@ -284,9 +286,9 @@ public abstract class Config<S> {
* Sets the specified property as an array of items in a given collection or * Sets the specified property as an array of items in a given collection or
* clears it if null is given. * clears it if null is given.
* *
* @param name propertyName * @param name propertyName
* @param collection collection of items * @param collection collection of items
* @param <T> type of items * @param <T> type of items
* @return self * @return self
*/ */
protected <T> Config<S> setOrClear(String name, Collection<T> collection) { protected <T> Config<S> setOrClear(String name, Collection<T> collection) {

View File

@ -28,7 +28,7 @@ import java.util.Set;
*/ */
@Beta @Beta
public interface NetworkConfigService public interface NetworkConfigService
extends ListenerService<NetworkConfigEvent, NetworkConfigListener> { extends ListenerService<NetworkConfigEvent, NetworkConfigListener> {
/** /**
* Returns the set of subject classes for which configuration may be * Returns the set of subject classes for which configuration may be
@ -57,7 +57,8 @@ public interface NetworkConfigService
/** /**
* Returns the configuration class with the specified key. * Returns the configuration class with the specified key.
* *
* @param configKey subject class name * @param subjectKey subject class key
* @param configKey subject class name
* @return subject class * @return subject class
*/ */
Class<? extends Config> getConfigClass(String subjectKey, String configKey); Class<? extends Config> getConfigClass(String subjectKey, String configKey);

View File

@ -44,7 +44,7 @@ public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkCon
* *
* @param configClass configuration class * @param configClass configuration class
* @param <S> type of subject * @param <S> type of subject
* @param <C> type of configuration * @param <C> type of configuration
* @return configuration factory or null * @return configuration factory or null
*/ */
<S, C extends Config<S>> ConfigFactory<S, C> getConfigFactory(Class<C> configClass); <S, C extends Config<S>> ConfigFactory<S, C> getConfigFactory(Class<C> configClass);
@ -112,6 +112,7 @@ public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkCon
* @param json raw JSON node containing the configuration data * @param json raw JSON node containing the configuration data
* @param <S> type of subject * @param <S> type of subject
* @param <C> type of configuration * @param <C> type of configuration
* @return configuration object
*/ */
<S, C extends Config<S>> C applyConfig(S subject, Class<C> configClass, <S, C extends Config<S>> C applyConfig(S subject, Class<C> configClass,
ObjectNode json); ObjectNode json);

View File

@ -67,8 +67,9 @@ public abstract class SubjectFactory<S> {
/** /**
* Creates a configuration subject from its key image. * Creates a configuration subject from its key image.
* *
* @param subjectKey subject class key
* @return configuration subject * @return configuration subject
*/ */
public abstract S createSubject(String key); public abstract S createSubject(String subjectKey);
} }

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Various basic builtin network configurations.
*/
package org.onosproject.incubator.net.config.basics;

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Implementation of the network configuration subsystem.
*/
package org.onosproject.incubator.net.config.impl;

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Implementation of the intent domain subsystem.
*/
package org.onosproject.incubator.net.domain.impl;

View File

@ -0,0 +1,20 @@
/*
* Copyright 2015 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.
*/
/**
* Implementation of the network configuration distributed store.
*/
package org.onosproject.incubator.store.config.impl;

View File

@ -88,7 +88,7 @@ public class EAP extends BasePacket {
/** /**
* Sets the EAP identifier. * Sets the EAP identifier.
* *
* @param identifier * @param identifier EAP identifier
* @return this * @return this
*/ */
public EAP setIdentifier(final byte identifier) { public EAP setIdentifier(final byte identifier) {

View File

@ -389,6 +389,7 @@ public abstract class Tools {
/** /**
* Returns the future value when complete or if future * Returns the future value when complete or if future
* completes exceptionally returns the defaultValue. * completes exceptionally returns the defaultValue.
*
* @param future future * @param future future
* @param defaultValue default value * @param defaultValue default value
* @param <T> future value type * @param <T> future value type
@ -409,6 +410,7 @@ public abstract class Tools {
/** /**
* Returns the future value when complete or if future * Returns the future value when complete or if future
* completes exceptionally returns the defaultValue. * completes exceptionally returns the defaultValue.
*
* @param future future * @param future future
* @param timeout time to wait for successful completion * @param timeout time to wait for successful completion
* @param timeUnit time unit * @param timeUnit time unit
@ -433,6 +435,7 @@ public abstract class Tools {
/** /**
* Returns a future that is completed exceptionally. * Returns a future that is completed exceptionally.
*
* @param t exception * @param t exception
* @param <T> future value type * @param <T> future value type
* @return future * @return future
@ -448,6 +451,7 @@ public abstract class Tools {
* <p> * <p>
* WARNING: There is a performance cost due to array copy * WARNING: There is a performance cost due to array copy
* when using this method. * when using this method.
*
* @param buffer byte buffer * @param buffer byte buffer
* @return byte array containing the byte buffer contents * @return byte array containing the byte buffer contents
*/ */
@ -463,10 +467,11 @@ public abstract class Tools {
} }
/** /**
* Converts an Iterable to a Stream. * Converts an iterable to a stream.
* *
* @param it Iterable to convert * @param it iterable to convert
* @return Iterable as a Stream * @param <T> type if item
* @return iterable as a stream
*/ */
public static <T> Stream<T> stream(Iterable<T> it) { public static <T> Stream<T> stream(Iterable<T> it) {
return StreamSupport.stream(it.spliterator(), false); return StreamSupport.stream(it.spliterator(), false);

View File

@ -129,7 +129,7 @@ public class NetworkConfigWebResource extends AbstractWebResource {
* Uploads network configuration in bulk. * Uploads network configuration in bulk.
* *
* @param request network configuration JSON rooted at the top node * @param request network configuration JSON rooted at the top node
* @throws IOException * @throws IOException if unable to parse the request
* @return empty response * @return empty response
*/ */
@POST @POST
@ -150,7 +150,7 @@ public class NetworkConfigWebResource extends AbstractWebResource {
* @param subjectKey subject class key * @param subjectKey subject class key
* @param request network configuration JSON rooted at the top node * @param request network configuration JSON rooted at the top node
* @return empty response * @return empty response
* @throws IOException * @throws IOException if unable to parse the request
*/ */
@POST @POST
@Path("{subjectKey}") @Path("{subjectKey}")
@ -171,7 +171,7 @@ public class NetworkConfigWebResource extends AbstractWebResource {
* @param subject subject key * @param subject subject key
* @param request network configuration JSON rooted at the top node * @param request network configuration JSON rooted at the top node
* @return empty response * @return empty response
* @throws IOException * @throws IOException if unable to parse the request
*/ */
@POST @POST
@Path("{subjectKey}/{subject}") @Path("{subjectKey}/{subject}")
@ -197,7 +197,7 @@ public class NetworkConfigWebResource extends AbstractWebResource {
* @param configKey configuration class key * @param configKey configuration class key
* @param request network configuration JSON rooted at the top node * @param request network configuration JSON rooted at the top node
* @return empty response * @return empty response
* @throws IOException * @throws IOException if unable to parse the request
*/ */
@POST @POST
@Path("{subjectKey}/{subject}/{configKey}") @Path("{subjectKey}/{subject}/{configKey}")