Skip to content

Commit

Permalink
REST API Support for DHCP Relay
Browse files Browse the repository at this point in the history 
Change-Id: Ib2ab8990a077f316c6292cc439452e671751b29a
  • Loading branch information
@tomikazi
anjalikk authored and tomikazi committed Nov 8, 2018
1 parent 84bbd85 commit 072e791
Show file tree
Hide file tree
Showing 3 changed files with 204 additions and 3 deletions.
17 changes: 15 additions & 2 deletions apps/dhcprelay/app/src/main/java/org/onosproject/dhcprelay/cli/DhcpRelayCommand.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,13 @@ private void listServers(List<DhcpServerInfo> dhcpServerInfoList) {
});
}

private String ip4State(DhcpRecord record) {
/**
* To return ipv4state.
*
* @param record DhcpRecord object
* @return ipState type String
*/
public String ip4State(DhcpRecord record) {
String nextHopIp = findNextHopIp(IpAddress::isIp4,
record.nextHop().orElse(null),
record.vlanId());
Expand All @@ -204,7 +210,14 @@ private String ip4State(DhcpRecord record) {
nextHopIp);
}

private String ip6State(DhcpRecord record) {
/**
* To return ipv6state.
*
* @param record DhcpRecord object
* @return ipState type String
*/

public String ip6State(DhcpRecord record) {
String nextHopIp = findNextHopIp6(IpAddress::isIp6,
record.nextHop().orElse(null),
record.vlanId());
Expand Down
3 changes: 2 additions & 1 deletion apps/dhcprelay/web/BUCK
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ COMPILE_DEPS = [
'//utils/rest:onlab-rest',
'//lib:javax.ws.rs-api',
'//lib:jersey-server',
'//lib:jackson-databind',
'//core/store/serializers:onos-core-serializers',
'//apps/route-service/api:onos-apps-route-service-api',
'//apps/dhcprelay/app:onos-apps-dhcprelay-app',
Expand All @@ -20,4 +21,4 @@ osgi_jar (
api_version = '1.0',
api_description = 'REST API for DHCPRelay',
api_package = 'org.onosproject.dhcprelay.rest',
)
)
187 changes: 187 additions & 0 deletions apps/dhcprelay/web/src/main/java/org/onosproject/dhcprelay/rest/DhcpRelayWebResource.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,19 +19,34 @@

import org.onlab.packet.IpAddress;
import org.onlab.packet.IpPrefix;
import org.onlab.util.Tools;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.fasterxml.jackson.databind.node.ObjectNode;
import org.onosproject.dhcprelay.api.DhcpRelayService;
import org.onosproject.dhcprelay.api.DhcpServerInfo;
import org.onosproject.dhcprelay.cli.DhcpRelayCommand;
import org.onosproject.dhcprelay.store.DhcpRecord;
import org.onosproject.dhcprelay.store.DhcpRelayCounters;
import org.onosproject.rest.AbstractWebResource;
import org.onosproject.routeservice.Route;
import org.onosproject.routeservice.RouteStore;
import org.onosproject.routing.fpm.api.FpmRecord;
import org.slf4j.Logger;

import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import java.io.IOException;
import java.util.Collection;
import java.util.Map;
import java.util.List;
import java.util.Optional;

import static org.slf4j.LoggerFactory.getLogger;
Expand All @@ -42,6 +57,13 @@
@Path("fpm-delete")
public class DhcpRelayWebResource extends AbstractWebResource {
private static final Logger LOG = getLogger(DhcpRelayWebResource.class);
private final ObjectMapper mapper = new ObjectMapper();
private final DhcpRelayService dhcpDelayService = get(DhcpRelayService.class);
private static final String NA = "N/A";
List<DhcpServerInfo> defaultDhcpServerInfoList = dhcpDelayService.getDefaultDhcpServerInfoList();
List<DhcpServerInfo> indirectDhcpServerInfoList = dhcpDelayService.getIndirectDhcpServerInfoList();
Collection<DhcpRecord> records = dhcpDelayService.getDhcpRecords();


/**
* Deletes the fpm route from fpm record.
Expand Down Expand Up @@ -74,5 +96,170 @@ public Response dhcpFpmDelete(@PathParam("prefix") String prefix) {

return Response.noContent().build();
}
/**
* Returns the response object with list of dhcp servers without counters.
*
* @return 200 OK with component properties of given component and variable
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Path("dhcp-relay")
public Response getDhcpServers() {
ObjectNode node = getdhcpRelayJsonOutput(null, null);
return Response.status(200).entity(node).build();
}

/**
* Returns dhcp servers details with counters.
*
* @param counter source ip identifier
* @return 200 OK with component properties of given component and variable
*/
@GET
@Produces(MediaType.APPLICATION_JSON)
@Path("dhcp-relay/{counter}")
public Response getDhcpRelayCounter(@PathParam("counter") String counter) {
ObjectNode node = getdhcpRelayJsonOutput(counter, null);
return Response.status(200).entity(node).build();
}

/**
* To reset the dhcp relay counters.
*
* @param counter type String
* @param reset type String
* @return 200 OK with component properties of given component and variable
*/
@PUT
@Produces(MediaType.APPLICATION_JSON)
@Path("dhcp-relay/{counter}/{reset}")
public Response resetDhcpRelayCounter(@PathParam("counter") String counter, @PathParam("reset") String reset) {
ObjectNode node = getdhcpRelayJsonOutput(counter, reset);
return Response.status(200).entity(node).build();
}


/**
* To create json output.
*
* @param counter type String
* @param reset type String
* @return node type ObjectNode.
*/
private ObjectNode getdhcpRelayJsonOutput(String counter, String reset) {
ObjectNode node = mapper.createObjectNode();
ObjectNode dhcpRelayServerNode = mapper.createObjectNode();
if (!defaultDhcpServerInfoList.isEmpty()) {
ArrayNode defaultDhcpServers = listServers(defaultDhcpServerInfoList);
dhcpRelayServerNode.put("Default-DHCP-Server", defaultDhcpServers);
}
if (!indirectDhcpServerInfoList.isEmpty()) {
ArrayNode indirectDhcpServers = listServers(indirectDhcpServerInfoList);
dhcpRelayServerNode.put("Indirect-DHCP-Server", indirectDhcpServers);
}

ArrayNode dhcpRecords = dhcpRelayRecords(records);
dhcpRelayServerNode.put("DHCP-Relay-Records([D]:Directly-Connected)", dhcpRecords);
if (counter != null && !counter.equals("counter")) {
ArrayNode counterArray = dhcpRelayCounters(reset);
dhcpRelayServerNode.put("DHCP-Relay-Counter", counterArray);
}
node.put("Default-DHCP-Servers", dhcpRelayServerNode);

return node;

}
/**
* To get the liset of dhcp servers.
*
* @param dhcpServerInfoList type List
* @return servers type ArrayNode.
*/
private ArrayNode listServers(List<DhcpServerInfo> dhcpServerInfoList) {
ArrayNode servers = mapper.createArrayNode();
dhcpServerInfoList.forEach(dhcpServerInfo -> {
ObjectNode serverNode = mapper.createObjectNode();
String connectPoint = dhcpServerInfo.getDhcpServerConnectPoint()
.map(cp -> cp.toString()).orElse(NA);
String serverMac = dhcpServerInfo.getDhcpConnectMac()
.map(mac -> mac.toString()).orElse(NA);
String gatewayAddress;
String serverIp;

switch (dhcpServerInfo.getVersion()) {
case DHCP_V4:
gatewayAddress = dhcpServerInfo.getDhcpGatewayIp4()
.map(gw -> gw.toString()).orElse(null);
serverIp = dhcpServerInfo.getDhcpServerIp4()
.map(ip -> ip.toString()).orElse(NA);
break;
case DHCP_V6:
gatewayAddress = dhcpServerInfo.getDhcpGatewayIp6()
.map(gw -> gw.toString()).orElse(null);
serverIp = dhcpServerInfo.getDhcpServerIp6()
.map(ip -> ip.toString()).orElse(NA);
break;
default:
return;
}

serverNode.put("connectPoint", connectPoint);
if (gatewayAddress != null) {
serverNode.put("server", serverIp.concat(" via ").concat(gatewayAddress));
} else {
serverNode.put("server", serverIp);
}
serverNode.put("mac", serverMac);
servers.add(serverNode);
});
return servers;
}

/**
* To get the list of dhcp relay records.
*
* @param records type Collections
* @return dhcpRelayRecords type ArrayNode.
*/
private ArrayNode dhcpRelayRecords(Collection<DhcpRecord> records) {
DhcpRelayCommand dhcpRelayCommand = new DhcpRelayCommand();
ArrayNode dhcpRelayRecords = mapper.createArrayNode();
records.forEach(record -> {
ObjectNode dhcpRecord = mapper.createObjectNode();
dhcpRecord.put("id", record.macAddress() + "/" + record.vlanId());
dhcpRecord.put("locations", record.locations().toString());
dhcpRecord.put("last-seen", Tools.timeAgo(record.lastSeen()));
dhcpRecord.put("IPv4", dhcpRelayCommand.ip4State(record));
dhcpRecord.put("IPv6", dhcpRelayCommand.ip6State(record));
dhcpRelayRecords.add(dhcpRecord);
});
return dhcpRelayRecords;
}

/**
* To get the details of dhcp relay counters.
*
* @param reset type String
* @return counterArray type ArrayNode.
*/
private ArrayNode dhcpRelayCounters(String reset) {
ObjectNode counters = mapper.createObjectNode();
ObjectNode counterPackets = mapper.createObjectNode();
ArrayNode counterArray = mapper.createArrayNode();
records.forEach(record -> {
DhcpRelayCounters v6Counters = record.getV6Counters();
if (reset != null && reset.equals("reset")) {
v6Counters.resetCounters();
}
Map<String, Integer> countersMap = v6Counters.getCounters();
countersMap.forEach((name, value) -> {
counterPackets.put(name, value);

});
counters.put(record.locations().toString(), counterPackets);
counterArray.add(counters);
});
return counterArray;
}

}

0 comments on commit 072e791

Please sign in to comment.