Ray Milkey
Committed by Gerrit Code Review

Javadoc fixes

Change-Id: Id23ed2d576b2222194153be9d043ca5acafe67ae
......@@ -37,6 +37,7 @@ public interface DhcpStore {
* Returns an IP Address for a Mac ID, in response to a DHCP DISCOVER message.
*
* @param macID Mac ID of the client requesting an IP
* @param requestedIP requested IP address
* @return IP address assigned to the Mac ID
*/
Ip4Address suggestIP(MacAddress macID, Ip4Address requestedIP);
......
......@@ -128,6 +128,7 @@ public final class IpAssignment {
/**
* Creates and returns a new builder instance that clones an existing IPAssignment.
*
* @param assignment ip address assignment
* @return new builder
*/
public static Builder builder(IpAssignment assignment) {
......
......@@ -104,6 +104,7 @@ public class DHCPWebResource extends AbstractWebResource {
* Post a new static MAC/IP binding.
* Registers a static binding to the DHCP server, and displays the current set of bindings.
*
* @param stream JSON stream
* @return 200 OK
*/
@POST
......@@ -139,6 +140,7 @@ public class DHCPWebResource extends AbstractWebResource {
* Delete a static MAC/IP binding.
* Removes a static binding from the DHCP Server, and displays the current set of bindings.
*
* @param macID mac address identifier
* @return 200 OK
*/
@DELETE
......
......@@ -102,6 +102,7 @@ public class IntentSynchronizer implements FibListener, IntentRequestListener {
* @param intentService the intent service
* @param hostService the host service
* @param configService the SDN-IP configuration service
* @param interfaceService the interface service
*/
IntentSynchronizer(ApplicationId appId, IntentService intentService,
HostService hostService,
......
......@@ -67,6 +67,8 @@ public class PeerConnectivityManager {
* @param appId the application ID
* @param intentSynchronizer the intent synchronizer
* @param configService the SDN-IP config service
* @param interfaceService the interface service
* @param routerAppId application ID
*/
public PeerConnectivityManager(ApplicationId appId,
IntentSynchronizer intentSynchronizer,
......
......@@ -65,7 +65,7 @@ public class PolicyWebResource extends AbstractWebResource {
* @param input JSON stream for policy to create
* @return status of the request - OK if the policy is created,
* INTERNAL_SERVER_ERROR if the JSON is invalid or the policy cannot be created
* @throws IOException
* @throws IOException if JSON processing fails
*/
@POST
@Consumes(MediaType.APPLICATION_JSON)
......
......@@ -344,6 +344,7 @@ public abstract class L2ModificationInstruction implements Instruction {
/**
* @deprecated in Drake Release.
* @return integer value of label
*/
// Consider changing return value to MplsLabel
// after deprecation process so that it'll be symmetric to
......
......@@ -90,6 +90,7 @@ public class Controller {
/**
* Tells controller that we're ready to accept ovsdb node loop.
* @throws InterruptedException if thread is interrupted
*/
public void run() throws InterruptedException {
initEventLoopGroup();
......
......@@ -181,6 +181,7 @@ public class RemoteTENodeDescriptorsTlv implements PcepValueType {
* Reads channel buffer and returns object of Remote TE Node Descriptors TLV.
*
* @param c input channel buffer
* @param length length of buffer
* @return object of RemoteTENodeDescriptorsTLV
* @throws PcepParseException if mandatory fields are missing
*/
......
......@@ -43,6 +43,11 @@ public class NetconfOperation {
/**
* This will send a Xml message to the device.
* @param xmlMsg XML to send
* @param username user name
* @param password pass word
* @param deviceIp ip address of the device
* @param devicePort port on the device
*/
protected void sendXmlMessage(String xmlMsg, String username,
String password, String deviceIp,
......@@ -105,10 +110,18 @@ public class NetconfOperation {
/**
* To establish SSH Connection.
*
* @param username user name
* @param password pass word
* @param sshHost host
* @param sshPort port
* @return new SSH connection
* @throws IOException if connection fails
* @throws JNCException if connection causes an error
*/
public SSHConnection getConnection(String username, String password,
String sshHost, Integer sshPort)
throws Exception {
throws IOException, JNCException {
SSHConnection sshConnection;
try {
sshConnection = new SSHConnection(sshHost, sshPort);
......
......@@ -78,8 +78,8 @@ public class IGMPMembership extends IGMPGroup {
*
* @param bb the ByteBuffer wrapping the serialized message. The position of the
* ByteBuffer should be pointing at the head of either message type.
* @return
* @throws DeserializationException
* @return IGMP Group
* @throws DeserializationException if deserialization fails
*/
public IGMPGroup deserialize(ByteBuffer bb) throws DeserializationException {
......@@ -155,4 +155,4 @@ public class IGMPMembership extends IGMPGroup {
result = prime * result + this.sources.hashCode();
return result;
}
}
\ No newline at end of file
}
......
......@@ -63,7 +63,7 @@ public class IGMPQuery extends IGMPGroup {
/**
* Get the Querier Robustness Variable.
*
* @return
* @return querier robustness value
*/
public byte getQrv() {
return qrv;
......@@ -72,7 +72,7 @@ public class IGMPQuery extends IGMPGroup {
/**
* Set the Querier Robustness Variable. Default is 2.
*
* @param qrv
* @param qrv new querier robustness value
*/
public void setQrv(byte qrv) {
this.qrv = qrv;
......@@ -199,4 +199,4 @@ public class IGMPQuery extends IGMPGroup {
result = prime * result + this.sources.hashCode();
return result;
}
}
\ No newline at end of file
}
......
......@@ -15,15 +15,7 @@
*/
package org.onosproject.rest.resources;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.onosproject.net.device.DeviceProviderRegistry;
import org.onosproject.net.device.DeviceService;
import org.onosproject.net.host.HostProviderRegistry;
import org.onosproject.net.link.LinkProviderRegistry;
import org.onlab.rest.BaseResource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.InputStream;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
......@@ -31,8 +23,17 @@ import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.io.IOException;
import java.io.InputStream;
import org.onlab.rest.BaseResource;
import org.onosproject.net.device.DeviceProviderRegistry;
import org.onosproject.net.device.DeviceService;
import org.onosproject.net.host.HostProviderRegistry;
import org.onosproject.net.link.LinkProviderRegistry;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import static javax.ws.rs.core.Response.Status.INTERNAL_SERVER_ERROR;
......@@ -49,13 +50,12 @@ public class ConfigWebResource extends BaseResource {
*
* @param input JSON blob
* @return 200 OK
* @throws IOException
*/
@POST
@Path("topology")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public Response topology(InputStream input) throws IOException {
public Response topology(InputStream input) {
try {
ObjectMapper mapper = new ObjectMapper();
JsonNode cfg = mapper.readTree(input);
......
......@@ -181,6 +181,7 @@ public class TrafficMonitor {
* </ul>
*
* @param mode monitoring mode
* @param nodeSelection how to select a node
*/
public synchronized void monitor(Mode mode, NodeSelection nodeSelection) {
log.debug("monitor: {} -- {}", mode, nodeSelection);
......