Fixing javadoc warnings, provided missing package javadocs and corrected group structure.
Change-Id: I2637afe49b81e8e6d10ef3bb0f2a1cf50b2564cc
diff --git a/apps/aaa/src/main/java/org/onosproject/aaa/StateMachine.java b/apps/aaa/src/main/java/org/onosproject/aaa/StateMachine.java
index 4c595ed..60959ad 100644
--- a/apps/aaa/src/main/java/org/onosproject/aaa/StateMachine.java
+++ b/apps/aaa/src/main/java/org/onosproject/aaa/StateMachine.java
@@ -23,6 +23,7 @@
import org.onosproject.xosintegration.VoltTenant;
import org.onosproject.xosintegration.VoltTenantService;
import org.slf4j.Logger;
+
import java.util.BitSet;
import static org.slf4j.LoggerFactory.getLogger;
@@ -111,7 +112,9 @@
/**
* 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) {
log.info("Creating a new state machine for {}", sessionId);
@@ -122,6 +125,7 @@
/**
* Get the client id that is requesting for access.
+ *
* @return The client id.
*/
public String getSessionId() {
@@ -154,15 +158,18 @@
/**
* 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 challengeState The challenge state from the RADIUS.
+ * @param challengeState The challenge state from the RADIUS.
*/
protected void setChallengeInfo(byte challengeIdentifier, byte[] challengeState) {
this.challengeIdentifier = challengeIdentifier;
this.challengeState = challengeState;
}
+
/**
* 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.
*/
protected void setChallengeIdentifier(byte challengeIdentifier) {
@@ -172,6 +179,7 @@
/**
* Get the challenge EAP identifier set by the RADIUS.
+ *
* @return The challenge EAP identifier.
*/
protected byte getChallengeIdentifier() {
@@ -181,6 +189,7 @@
/**
* Set the challenge state info issued by the RADIUS.
+ *
* @param challengeState The challenge state from the RADIUS.
*/
protected void setChallengeState(byte[] challengeState) {
@@ -190,6 +199,7 @@
/**
* Get the challenge state set by the RADIUS.
+ *
* @return The challenge state.
*/
protected byte[] getChallengeState() {
@@ -198,6 +208,7 @@
/**
* Set the username.
+ *
* @param username The username sent to the RADIUS upon access request.
*/
protected void setUsername(byte[] username) {
@@ -207,6 +218,7 @@
/**
* Get the username.
+ *
* @return The requestAuthenticator.
*/
protected byte[] getReqeustAuthenticator() {
@@ -215,6 +227,7 @@
/**
* Set the username.
+ *
* @param authenticator The username sent to the RADIUS upon access request.
*/
protected void setRequestAuthenticator(byte[] authenticator) {
@@ -224,6 +237,7 @@
/**
* Get the username.
+ *
* @return The username.
*/
protected byte[] getUsername() {
@@ -232,6 +246,7 @@
/**
* Return the identifier of the state machine.
+ *
* @return The state machine identifier.
*/
public byte getIdentifier() {
@@ -251,15 +266,18 @@
/**
* Move to the next state.
+ *
* @param msg
*/
- private void next(int msg) {
+ private void next(int msg) {
currentState = transition[currentState][msg];
log.info("Current State " + currentState);
}
/**
* Client has requested the start action to allow network access.
+ *
+ * @throws StateMachineException if authentication protocol is violated
*/
public void start() throws StateMachineException {
try {
@@ -275,6 +293,8 @@
/**
* An Identification information has been sent by the supplicant.
* Move to the next state if possible.
+ *
+ * @throws StateMachineException if authentication protocol is violated
*/
public void requestAccess() throws StateMachineException {
try {
@@ -289,6 +309,8 @@
/**
* RADIUS has accepted the identification.
* Move to the next state if possible.
+ *
+ * @throws StateMachineException if authentication protocol is violated
*/
public void authorizeAccess() throws StateMachineException {
try {
@@ -317,6 +339,8 @@
/**
* RADIUS has denied the identification.
* Move to the next state if possible.
+ *
+ * @throws StateMachineException if authentication protocol is violated
*/
public void denyAccess() throws StateMachineException {
try {
@@ -332,6 +356,8 @@
/**
* Logoff request has been requested.
* Move to the next state if possible.
+ *
+ * @throws StateMachineException if authentication protocol is violated
*/
public void logoff() throws StateMachineException {
try {
@@ -345,6 +371,7 @@
/**
* Get the current state.
+ *
* @return The current state. Could be STATE_IDLE, STATE_STARTED, STATE_PENDING, STATE_AUTHORIZED,
* STATE_UNAUTHORIZED.
*/
@@ -353,13 +380,14 @@
}
-
public String toString() {
return ("sessionId: " + this.sessionId) + "\t" + ("identifier: " + this.identifier) + "\t" +
("state: " + this.currentState);
}
}
+// FIXME: A source file should contain no more than one top-level entity!
+
abstract class State {
private final Logger log = getLogger(getClass());
@@ -368,15 +396,19 @@
public void start() throws StateMachineInvalidTransitionException {
log.warn("START transition from this state is not allowed.");
}
+
public void requestAccess() throws StateMachineInvalidTransitionException {
log.warn("REQUEST ACCESS transition from this state is not allowed.");
}
+
public void radiusAccepted() throws StateMachineInvalidTransitionException {
log.warn("AUTHORIZE ACCESS transition from this state is not allowed.");
}
+
public void radiusDenied() throws StateMachineInvalidTransitionException {
log.warn("DENY ACCESS transition from this state is not allowed.");
}
+
public void logoff() throws StateMachineInvalidTransitionException {
log.warn("LOGOFF transition from this state is not allowed.");
}
@@ -457,6 +489,7 @@
}
}
+
/**
* Exception raised when the transition from one state to another is invalid.
*/
diff --git a/apps/flowanalyzer/src/main/java/org/onosproject/flowanalyzer/package-info.java b/apps/flowanalyzer/src/main/java/org/onosproject/flowanalyzer/package-info.java
new file mode 100644
index 0000000..5572f8c
--- /dev/null
+++ b/apps/flowanalyzer/src/main/java/org/onosproject/flowanalyzer/package-info.java
@@ -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;
\ No newline at end of file
diff --git a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/PolicyHandler.java b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/PolicyHandler.java
index 0fcfee4..9a2a891 100644
--- a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/PolicyHandler.java
+++ b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/PolicyHandler.java
@@ -59,10 +59,11 @@
/**
* Creates a reference.
*
- * @param appId segment routing application ID
- * @param deviceConfiguration DeviceConfiguration reference
+ * @param appId segment routing application ID
+ * @param deviceConfiguration DeviceConfiguration reference
* @param flowObjectiveService FlowObjectiveService reference
- * @param policyStore policy store
+ * @param tunnelHandler tunnel handler reference
+ * @param policyStore policy store
*/
public PolicyHandler(ApplicationId appId,
DeviceConfiguration deviceConfiguration,
diff --git a/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/cli/package-info.java b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/cli/package-info.java
new file mode 100644
index 0000000..1a9d3c7
--- /dev/null
+++ b/apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/cli/package-info.java
@@ -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;
\ No newline at end of file
diff --git a/apps/vtnrsc/src/main/java/org/onosproject/app/vtnrsc/virtualport/VirtualPortService.java b/apps/vtnrsc/src/main/java/org/onosproject/app/vtnrsc/virtualport/VirtualPortService.java
index 51d3001..9b6c7d2 100644
--- a/apps/vtnrsc/src/main/java/org/onosproject/app/vtnrsc/virtualport/VirtualPortService.java
+++ b/apps/vtnrsc/src/main/java/org/onosproject/app/vtnrsc/virtualport/VirtualPortService.java
@@ -53,24 +53,24 @@
/**
* Returns the collection of the virtualPorts associated with the networkId.
*
- * @param networkId
- * @return collection of virtualPort.
+ * @param networkId network identifier
+ * @return collection of virtualPort
*/
Collection<VirtualPort> getPorts(TenantNetworkId networkId);
/**
* Returns the collection of the virtualPorts associated with the tenantId.
*
- * @param tenantId
- * @return collection of virtualPort.
+ * @param tenantId tenant identifier
+ * @return collection of virtualPort
*/
Collection<VirtualPort> getPorts(TenantId tenantId);
/**
* Returns the collection of the virtualPorts associated with the deviceId.
*
- * @param deviceId
- * @return collection of virtualPort.
+ * @param deviceId device identifier
+ * @return collection of virtualPort
*/
Collection<VirtualPort> getPorts(DeviceId deviceId);
@@ -86,7 +86,7 @@
* Updates virtualPorts by 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);
@@ -95,7 +95,7 @@
*
* @param virtualPortIds the iterable collection of virtualPort identifiers
* @return true or false if one with the given identifier to delete is
- * successfully.
+ * successfully
*/
boolean removePorts(Iterable<VirtualPortId> virtualPortIds);
}