-
/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
import java.net.InetAddress;
import java.net.UnknownHostException;
+import java.util.HashSet;
import java.util.List;
import java.util.Set;
-import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
-import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
-import javax.ws.rs.POST;
+import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
-import javax.ws.rs.QueryParam;
+import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
+import javax.ws.rs.core.SecurityContext;
+import javax.xml.bind.JAXBElement;
import org.codehaus.enunciate.jaxrs.ResponseCode;
import org.codehaus.enunciate.jaxrs.StatusCodes;
import org.opendaylight.controller.northbound.commons.exception.ResourceConflictException;
import org.opendaylight.controller.northbound.commons.exception.ResourceNotFoundException;
import org.opendaylight.controller.northbound.commons.exception.ServiceUnavailableException;
+import org.opendaylight.controller.northbound.commons.exception.UnauthorizedException;
import org.opendaylight.controller.northbound.commons.exception.UnsupportedMediaTypeException;
+import org.opendaylight.controller.northbound.commons.utils.NorthboundUtils;
+import org.opendaylight.controller.sal.authorization.Privilege;
import org.opendaylight.controller.sal.core.Node;
import org.opendaylight.controller.sal.core.NodeConnector;
import org.opendaylight.controller.sal.utils.GlobalConstants;
/**
* Host Tracker Northbound REST APIs.<br>
- * This class provides REST APIs to track host location in a network. Host Location is represented by Host node connector
- * which is essentially a logical entity that represents a Switch/Port. A host is represented by it's IP-address
- * and mac-address.
+ * This class provides REST APIs to track host location in a network. Host
+ * Location is represented by Host node connector which is essentially a logical
+ * entity that represents a Switch/Port. A host is represented by it's
+ * IP-address and mac-address.
*
- * <br><br>
+ * <br>
+ * <br>
* Authentication scheme : <b>HTTP Basic</b><br>
* Authentication realm : <b>opendaylight</b><br>
* Transport : <b>HTTP and HTTPS</b><br>
* <br>
- * HTTPS Authentication is disabled by default. Administrator can enable it in tomcat-server.xml after adding
- * a proper keystore / SSL certificate from a trusted authority.<br>
- * More info : http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
+ * HTTPS Authentication is disabled by default. Administrator can enable it in
+ * tomcat-server.xml after adding a proper keystore / SSL certificate from a
+ * trusted authority.<br>
+ * More info :
+ * http://tomcat.apache.org/tomcat-7.0-doc/ssl-howto.html#Configuration
*
*/
@Path("/")
public class HostTrackerNorthbound {
+ private String username;
+
+ @Context
+ public void setSecurityContext(SecurityContext context) {
+ if (context != null && context.getUserPrincipal() != null) username = context.getUserPrincipal().getName();
+ }
+
+ protected String getUserName() {
+ return username;
+ }
+
private IfIptoHost getIfIpToHostService(String containerName) {
IContainerManager containerManager = (IContainerManager) ServiceHelper
.getGlobalInstance(IContainerManager.class, this);
return hostTracker;
}
+ private Hosts convertHosts(Set<HostNodeConnector> hostNodeConnectors) {
+ if(hostNodeConnectors == null) {
+ return null;
+ }
+ Set<HostConfig> hosts = new HashSet<HostConfig>();
+ for(HostNodeConnector hnc : hostNodeConnectors) {
+ hosts.add(HostConfig.convert(hnc));
+ }
+ return new Hosts(hosts);
+ }
+
/**
- * Returns a list of all Hosts : both configured via PUT API and dynamically learnt on the network.
+ * Returns a list of all Hosts : both configured via PUT API and dynamically
+ * learnt on the network.
*
- * @param containerName Name of the Container. The Container name for the base controller is "default".
+ * @param containerName
+ * Name of the Container. The Container name for the base
+ * controller is "default".
* @return List of Active Hosts.
+ * <pre>
+ *
+ * Example:
+ *
+ * RequestURL:
+ *
+ * http://localhost:8080/controller/nb/v2/host/default
+ *
+ * Response in XML
+ *
+ * <list>
+ *  <hostConfig>
+ *   <dataLayerAddress>00:00:00:00:01:01</dataLayerAddress>
+ *   <networkAddress>1.1.1.1</networkAddress>
+ *   <nodeType>OF</nodeType>
+ *   <nodeId>00:00:00:00:00:00:00:01</nodeId>
+ *   <nodeConnectorType>OF</nodeConnectorType>
+ *   <nodeConnectorId>9</nodeConnectorId>
+ *   <vlan>0</vlan>
+ *   <staticHost>false</staticHost>
+ *  </hostConfig>
+ *  <hostConfig>
+ *   <dataLayerAddress>00:00:00:00:02:02</dataLayerAddress>
+ *   <networkAddress>2.2.2.2</networkAddress>
+ *   <nodeType>OF</nodeType>
+ *   <nodeId>00:00:00:00:00:00:00:02</nodeId>
+ *   <nodeConnectorType>OF</nodeConnectorType>
+ *   <nodeConnectorId>5</nodeConnectorId>
+ *   <vlan>0</vlan>
+ *   <staticHost>false</staticHost>
+ *  </hostConfig>
+ * </list>
+ *
+ * Response in JSON:
+ *
+ * {
+ *  "hostConfig":[
+ *   {
+ *    "dataLayerAddress":"00:00:00:00:01:01",
+ *    "nodeType":"OF",
+ *    "nodeId":"00:00:00:00:00:00:00:01",
+ *    "nodeConnectorType":"OF",
+ *    "nodeConnectorId":"9",
+ *    "vlan":"0",
+ *    "staticHost":"false",
+ *    "networkAddress":"1.1.1.1"
+ *   },
+ *   {
+ *    "dataLayerAddress":"00:00:00:00:02:02",
+ *    "nodeType":"OF",
+ *    "nodeId":"00:00:00:00:00:00:00:02",
+ *    "nodeConnectorType":"OF",
+ *    "nodeConnectorId":"5",
+ *    "vlan":"0",
+ *    "staticHost":"false",
+ *    "networkAddress":"2.2.2.2"
+ *   }
+ *  ]
+ * }
+ * </pre>
*/
@Path("/{containerName}")
@GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@TypeHint(Hosts.class)
- @StatusCodes( {
+ @StatusCodes({
@ResponseCode(code = 200, condition = "Operation successful"),
@ResponseCode(code = 404, condition = "The containerName is not found"),
@ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
- public Hosts getActiveHosts(
- @PathParam("containerName") String containerName) {
+ public Hosts getActiveHosts(@PathParam("containerName") String containerName) {
+
+ if (!NorthboundUtils.isAuthorized(
+ getUserName(), containerName, Privilege.READ, this)) {
+ throw new UnauthorizedException(
+ "User is not authorized to perform this operation on container "
+ + containerName);
+ }
IfIptoHost hostTracker = getIfIpToHostService(containerName);
if (hostTracker == null) {
throw new ServiceUnavailableException("Host Tracker "
+ RestMessages.SERVICEUNAVAILABLE.toString());
}
-
- return new Hosts(hostTracker.getAllHosts());
+ return convertHosts(hostTracker.getAllHosts());
}
/**
- * Returns a list of Hosts that are statically configured and are connected to a NodeConnector that is down.
+ * Returns a list of Hosts that are statically configured and are connected
+ * to a NodeConnector that is down.
*
- * @param containerName Name of the Container. The Container name for the base controller is "default".
+ * @param containerName
+ * Name of the Container. The Container name for the base
+ * controller is "default".
* @return List of inactive Hosts.
+ * <pre>
+ *
+ * Example:
+ *
+ * RequestURL:
+ *
+ * http://localhost:8080/controller/nb/v2/host/default/inactive
+ *
+ * Response in XML
+ *
+ * <list>
+ *  <hostConfig>
+ *   <dataLayerAddress>00:00:00:00:01:01</dataLayerAddress>
+ *   <networkAddress>1.1.1.1</networkAddress>
+ *   <nodeType>OF</nodeType>
+ *   <nodeId>00:00:00:00:00:00:00:01</nodeId>
+ *   <nodeConnectorType>OF</nodeConnectorType>
+ *   <nodeConnectorId>9</nodeConnectorId>
+ *   <vlan>0</vlan>
+ *   <staticHost>false</staticHost>
+ *  </hostConfig>
+ *  <hostConfig>
+ *   <dataLayerAddress>00:00:00:00:02:02</dataLayerAddress>
+ *   <networkAddress>2.2.2.2</networkAddress>
+ *   <nodeType>OF</nodeType>
+ *   <nodeId>00:00:00:00:00:00:00:02</nodeId>
+ *   <nodeConnectorType>OF</nodeConnectorType>
+ *   <nodeConnectorId>5</nodeConnectorId>
+ *   <vlan>0</vlan>
+ *   <staticHost>false</staticHost>
+ *  </hostConfig>
+ * </list>
+ *
+ * Response in JSON:
+ *
+ * {
+ *  "hostConfig":[
+ *   {
+ *    "dataLayerAddress":"00:00:00:00:01:01",
+ *    "nodeType":"OF",
+ *    "nodeId":"00:00:00:00:00:00:00:01",
+ *    "nodeConnectorType":"OF",
+ *    "nodeConnectorId":"9",
+ *    "vlan":"0",
+ *    "staticHost":"false",
+ *    "networkAddress":"1.1.1.1"
+ *   },
+ *   {
+ *    "dataLayerAddress":"00:00:00:00:02:02",
+ *    "nodeType":"OF",
+ *    "nodeId":"00:00:00:00:00:00:00:02",
+ *    "nodeConnectorType":"OF",
+ *    "nodeConnectorId":"5",
+ *    "vlan":"0",
+ *    "staticHost":"false",
+ *    "networkAddress":"2.2.2.2"
+ *   }
+ *  ]
+ * }
+ * </pre>
*/
@Path("/{containerName}/inactive")
@GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
@TypeHint(Hosts.class)
- @StatusCodes( {
+ @StatusCodes({
@ResponseCode(code = 200, condition = "Operation successful"),
@ResponseCode(code = 404, condition = "The containerName is not found"),
@ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
public Hosts getInactiveHosts(
@PathParam("containerName") String containerName) {
+ if (!NorthboundUtils.isAuthorized(
+ getUserName(), containerName, Privilege.READ, this)) {
+ throw new UnauthorizedException(
+ "User is not authorized to perform this operation on container "
+ + containerName);
+ }
IfIptoHost hostTracker = getIfIpToHostService(containerName);
if (hostTracker == null) {
throw new ServiceUnavailableException("Host Tracker "
+ RestMessages.SERVICEUNAVAILABLE.toString());
}
-
- return new Hosts(hostTracker.getInactiveStaticHosts());
+ return convertHosts(hostTracker.getInactiveStaticHosts());
}
/**
* Returns a host that matches the IP Address value passed as parameter.
*
- * @param containerName Name of the Container. The Container name for the base controller is "default".
- * @param networkAddress IP Address being looked up
+ * @param containerName
+ * Name of the Container. The Container name for the base
+ * controller is "default".
+ * @param networkAddress
+ * IP Address being looked up
* @return host that matches the IP Address
+ * <pre>
+ *
+ * Example:
+ *
+ * RequestURL:
+ *
+ * http://localhost:8080/controller/nb/v2/host/default/1.1.1.1
+ *
+ * Response in XML
+ *
+ * <hostConfig>
+ *  <dataLayerAddress>00:00:00:00:01:01</dataLayerAddress>
+ *  <networkAddress>1.1.1.1</networkAddress>
+ *  <nodeType>OF</nodeType>
+ *  <nodeId>00:00:00:00:00:00:00:01</nodeId>
+ *  <nodeConnectorType>OF</nodeConnectorType>
+ *  <nodeConnectorId>9</nodeConnectorId>
+ *  <vlan>0</vlan>
+ *  <staticHost>false</staticHost>
+ * </hostConfig>
+ *
+ * Response in JSON:
+ *
+ * {
+ *  "dataLayerAddress":"00:00:00:00:01:01",
+ *  "nodeType":"OF",
+ *  "nodeId":"00:00:00:00:00:00:00:01",
+ *  "nodeConnectorType":"OF",
+ *  "nodeConnectorId":"9",
+ *  "vlan":"0",
+ *  "staticHost":"false",
+ *  "networkAddress":"1.1.1.1"
+ * }
+ * </pre>
*/
@Path("/{containerName}/{networkAddress}")
@GET
- @Produces( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @TypeHint(HostNodeConnector.class)
- @StatusCodes( {
+ @Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @TypeHint(HostConfig.class)
+ @StatusCodes({
@ResponseCode(code = 200, condition = "Operation successful"),
@ResponseCode(code = 404, condition = "The containerName is not found"),
@ResponseCode(code = 415, condition = "Invalid IP Address passed in networkAddress parameter"),
@ResponseCode(code = 503, condition = "One or more of Controller Services are unavailable") })
- public HostNodeConnector getHostDetails(
+ public HostConfig getHostDetails(
@PathParam("containerName") String containerName,
@PathParam("networkAddress") String networkAddress) {
+ if (!NorthboundUtils.isAuthorized(
+ getUserName(), containerName, Privilege.READ, this)) {
+ throw new UnauthorizedException(
+ "User is not authorized to perform this operation on container "
+ + containerName);
+ }
IfIptoHost hostTracker = getIfIpToHostService(containerName);
if (hostTracker == null) {
throw new ServiceUnavailableException("Host Tracker "
}
for (HostNodeConnector host : hostTracker.getAllHosts()) {
if (host.getNetworkAddress().equals(ip)) {
- return host;
+ return HostConfig.convert(host);
}
}
throw new ResourceNotFoundException(RestMessages.NOHOST.toString());
/**
* Add a Static Host configuration
*
- * @param containerName Name of the Container. The Container name for the base controller is "default".
- * @param networkAddress Host IP Address
- * @param dataLayerAddress Host L2 data-layer address.
- * @param nodeType Node Type as specifid by Node class
- * @param nodeId Node Identifier as specifid by Node class
- * @param nodeConnectorType Port Type as specified by NodeConnector class
- * @param nodeConnectorId Port Identifier as specified by NodeConnector class
- * @param vlan Vlan number
+ * @param containerName
+ * Name of the Container. The Container name for the base
+ * controller is "default".
+ * @param networkAddress
+ * Host IP Address
+ * @param hostConfig
+ * Host Config Details
* @return Response as dictated by the HTTP Response Status code
+ *
+ * <pre>
+ *
+ * Example:
+ *
+ * RequestURL:
+ *
+ * http://localhost:8080/controller/nb/v2/host/default/1.1.1.1
+ *
+ * Request in XML
+ *
+ * <hostConfig>
+ *  <dataLayerAddress>00:00:00:00:01:01</dataLayerAddress>
+ *  <networkAddress>1.1.1.1</networkAddress>
+ *  <nodeType>OF</nodeType>
+ *  <nodeId>00:00:00:00:00:00:00:01</nodeId>
+ *  <nodeConnectorType>OF</nodeConnectorType>
+ *  <nodeConnectorId>9</nodeConnectorId>
+ *  <vlan>0</vlan>
+ *  <staticHost>false</staticHost>
+ * </hostConfig>
+ *
+ * Request in JSON:
+ *
+ * {
+ *  "dataLayerAddress":"00:00:00:00:01:01",
+ *  "nodeType":"OF",
+ *  "nodeId":"00:00:00:00:00:00:00:01",
+ *  "nodeConnectorType":"OF",
+ *  "nodeConnectorId":"9",
+ *  "vlan":"0",
+ *  "staticHost":"false",
+ *  "networkAddress":"1.1.1.1"
+ * }
+ * </pre>
*/
@Path("/{containerName}/{networkAddress}")
- @POST
- @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @StatusCodes( {
- @ResponseCode(code = 201, condition = "Flow Config processed successfully"),
+ @PUT
+ @Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @StatusCodes({
+ @ResponseCode(code = 201, condition = "Static host created successfully"),
@ResponseCode(code = 404, condition = "The Container Name or nodeId or configuration name is not found"),
@ResponseCode(code = 406, condition = "Cannot operate on Default Container when other Containers are active"),
@ResponseCode(code = 415, condition = "Invalid IP Address passed in networkAddress parameter"),
@ResponseCode(code = 503, condition = "One or more of Controller services are unavailable") })
public Response addHost(@PathParam("containerName") String containerName,
@PathParam("networkAddress") String networkAddress,
- @QueryParam("dataLayerAddress") String dataLayerAddress,
- @QueryParam("nodeType") String nodeType,
- @QueryParam("nodeId") String nodeId,
- @QueryParam("nodeConnectorType") String nodeConnectorType,
- @QueryParam("nodeConnectorId") String nodeConnectorId,
- @DefaultValue("0") @QueryParam("vlan") String vlan) {
+ @TypeHint(HostConfig.class) JAXBElement<HostConfig> hostConfig) {
+ if (!NorthboundUtils.isAuthorized(
+ getUserName(), containerName, Privilege.WRITE, this)) {
+ throw new UnauthorizedException(
+ "User is not authorized to perform this operation on container "
+ + containerName);
+ }
handleDefaultDisabled(containerName);
IfIptoHost hostTracker = getIfIpToHostService(containerName);
+ RestMessages.SERVICEUNAVAILABLE.toString());
}
- Node node = handleNodeAvailability(containerName, nodeType, nodeId);
+ HostConfig hc = hostConfig.getValue();
+ Node node = handleNodeAvailability(containerName, hc.getNodeType(), hc.getNodeId());
if (node == null) {
- throw new InternalServerErrorException(RestMessages.NONODE.
- toString());
+ throw new InternalServerErrorException(
+ RestMessages.NONODE.toString());
}
try {
throw new UnsupportedMediaTypeException(networkAddress + " "
+ RestMessages.INVALIDADDRESS.toString());
}
- NodeConnector nc = NodeConnector.fromStringNoNode(nodeConnectorType, nodeConnectorId,
- node);
+ if(!networkAddress.equals(hc.getNetworkAddress())) {
+ throw new UnsupportedMediaTypeException(networkAddress + " is not the same as "
+ + hc.getNetworkAddress());
+ }
+ if(!hc.isStaticHost()) {
+ throw new UnsupportedMediaTypeException("StaticHost flag must be true");
+ }
+ NodeConnector nc = NodeConnector.fromStringNoNode(hc.getNodeConnectorType(), hc.getNodeConnectorId(), node);
if (nc == null) {
- throw new ResourceNotFoundException(nodeConnectorType+"|"+nodeConnectorId + " : "
- + RestMessages.NONODE.toString());
+ throw new ResourceNotFoundException(hc.getNodeConnectorType() + "|"
+ + hc.getNodeConnectorId() + " : " + RestMessages.NONODE.toString());
}
Status status = hostTracker.addStaticHost(networkAddress,
- dataLayerAddress,
- nc, vlan);
+ hc.getDataLayerAddress(), nc, hc.getVlan());
if (status.isSuccess()) {
+ NorthboundUtils.auditlog("Static Host", username, "added", networkAddress, containerName);
return Response.status(Response.Status.CREATED).build();
} else if (status.getCode().equals(StatusCode.BADREQUEST)) {
throw new UnsupportedMediaTypeException(status.getDescription());
/**
* Delete a Static Host configuration
*
- * @param containerName Name of the Container. The Container name for the base controller is "default".
- * @param networkAddress IP Address
+ * @param containerName
+ * Name of the Container. The Container name for the base
+ * controller is "default".
+ * @param networkAddress
+ * IP Address
* @return Response as dictated by the HTTP Response code.
*/
@Path("/{containerName}/{networkAddress}")
@DELETE
- @Consumes( { MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
- @StatusCodes( {
+ @Consumes({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
+ @StatusCodes({
@ResponseCode(code = 200, condition = "Flow Config deleted successfully"),
@ResponseCode(code = 404, condition = "The Container Name or Node-id or Flow Name passed is not found"),
@ResponseCode(code = 406, condition = "Cannot operate on Default Container when other Containers are active"),
@PathParam(value = "containerName") String containerName,
@PathParam(value = "networkAddress") String networkAddress) {
+ if (!NorthboundUtils.isAuthorized(
+ getUserName(), containerName, Privilege.WRITE, this)) {
+ throw new UnauthorizedException(
+ "User is not authorized to perform this operation on container "
+ + containerName);
+ }
handleDefaultDisabled(containerName);
IfIptoHost hostTracker = getIfIpToHostService(containerName);
if (hostTracker == null) {
Status status = hostTracker.removeStaticHost(networkAddress);
if (status.isSuccess()) {
+ NorthboundUtils.auditlog("Static Host", username, "removed", networkAddress, containerName);
return Response.ok().build();
}
throw new InternalServerErrorException(status.getDescription());
IContainerManager containerManager = (IContainerManager) ServiceHelper
.getGlobalInstance(IContainerManager.class, this);
if (containerManager == null) {
- throw new InternalServerErrorException(RestMessages.INTERNALERROR
- .toString());
+ throw new InternalServerErrorException(
+ RestMessages.INTERNALERROR.toString());
}
if (containerName.equals(GlobalConstants.DEFAULT.toString())
&& containerManager.hasNonDefaultContainer()) {
- throw new ResourceConflictException(RestMessages.DEFAULTDISABLED
- .toString());
+ throw new ResourceConflictException(
+ RestMessages.DEFAULTDISABLED.toString());
}
}
private Node handleNodeAvailability(String containerName, String nodeType,
- String nodeId) {
+ String nodeId) {
Node node = Node.fromString(nodeType, nodeId);
if (node == null) {
}
return node;
}
+
}
Code Review / controller.git / blobdiff