Restructuring the form of REST API deployment to provide
for security of app's REST APIs and for consistency of
exception mappers and JSON writer.
Change-Id: Id318372bf62f82ed974355c05e7fe64e0fbfc0c5
diff --git a/apps/acl/src/main/java/org/onosproject/acl/AclWebApplication.java b/apps/acl/src/main/java/org/onosproject/acl/AclWebApplication.java
new file mode 100644
index 0000000..c66c3f8
--- /dev/null
+++ b/apps/acl/src/main/java/org/onosproject/acl/AclWebApplication.java
@@ -0,0 +1,32 @@
+/*
+ * Copyright 2014-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.
+ */
+
+package org.onosproject.acl;
+
+import org.onlab.rest.AbstractWebApplication;
+
+import java.util.Set;
+
+/**
+ * ACL REST API web application.
+ */
+public class AclWebApplication extends AbstractWebApplication {
+ @Override
+ public Set<Class<?>> getClasses() {
+ return getClasses(AclWebResource.class);
+ }
+}
+
diff --git a/apps/acl/src/main/webapp/WEB-INF/web.xml b/apps/acl/src/main/webapp/WEB-INF/web.xml
index fc188b7..bd5de2f 100644
--- a/apps/acl/src/main/webapp/WEB-INF/web.xml
+++ b/apps/acl/src/main/webapp/WEB-INF/web.xml
@@ -22,20 +22,35 @@
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
id="ONOS" version="2.5">
- <display-name>ACL application</display-name>
+ <display-name>ACL application REST API</display-name>
+
+ <security-constraint>
+ <web-resource-collection>
+ <web-resource-name>Secured</web-resource-name>
+ <url-pattern>/*</url-pattern>
+ </web-resource-collection>
+ <auth-constraint>
+ <role-name>admin</role-name>
+ </auth-constraint>
+ </security-constraint>
+
+ <security-role>
+ <role-name>admin</role-name>
+ </security-role>
+
+ <login-config>
+ <auth-method>BASIC</auth-method>
+ <realm-name>karaf</realm-name>
+ </login-config>
<servlet>
<servlet-name>JAX-RS Service</servlet-name>
<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
<init-param>
- <param-name>com.sun.jersey.config.property.resourceConfigClass</param-name>
- <param-value>com.sun.jersey.api.core.ClassNamesResourceConfig</param-value>
+ <param-name>javax.ws.rs.Application</param-name>
+ <param-value>org.onosproject.acl.AclWebApplication</param-value>
</init-param>
- <init-param>
- <param-name>com.sun.jersey.config.property.classnames</param-name>
- <param-value>org.onosproject.acl.AclWebResource</param-value>
- </init-param>
- <load-on-startup>10</load-on-startup>
+ <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
diff --git a/apps/dhcp/app/src/main/java/org/onosproject/dhcp/rest/DhcpWebApplication.java b/apps/dhcp/app/src/main/java/org/onosproject/dhcp/rest/DhcpWebApplication.java
new file mode 100644
index 0000000..65c99da
--- /dev/null
+++ b/apps/dhcp/app/src/main/java/org/onosproject/dhcp/rest/DhcpWebApplication.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2014-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.
+ */
+
+package org.onosproject.dhcp.rest;
+
+import org.onlab.rest.AbstractWebApplication;
+
+import java.util.Set;
+
+/**
+ * DHCP Web application.
+ */
+public class DhcpWebApplication extends AbstractWebApplication {
+ @Override
+ public Set<Class<?>> getClasses() {
+ return getClasses(DhcpWebResource.class);
+ }
+}
diff --git a/apps/dhcp/app/src/main/java/org/onosproject/dhcp/rest/DhcpWebResource.java b/apps/dhcp/app/src/main/java/org/onosproject/dhcp/rest/DhcpWebResource.java
index 6265fee..36c7a6c 100644
--- a/apps/dhcp/app/src/main/java/org/onosproject/dhcp/rest/DhcpWebResource.java
+++ b/apps/dhcp/app/src/main/java/org/onosproject/dhcp/rest/DhcpWebResource.java
@@ -44,7 +44,7 @@
@Path("dhcp")
public class DhcpWebResource extends AbstractWebResource {
- final DhcpService service = get(DhcpService.class);
+ private final DhcpService service = get(DhcpService.class);
/**
* Get DHCP server configuration data.
@@ -56,12 +56,11 @@
@GET
@Path("config")
public Response getConfigs() {
- DhcpService service = get(DhcpService.class);
ObjectNode node = mapper().createObjectNode()
.put("leaseTime", service.getLeaseTime())
.put("renewalTime", service.getRenewalTime())
.put("rebindingTime", service.getRebindingTime());
- return ok(node.toString()).build();
+ return ok(node).build();
}
/**
@@ -76,13 +75,13 @@
public Response listMappings() {
ObjectNode root = mapper().createObjectNode();
- final Map<HostId, IpAssignment> intents = service.listMapping();
+ Map<HostId, IpAssignment> intents = service.listMapping();
ArrayNode arrayNode = root.putArray("mappings");
intents.entrySet().forEach(i -> arrayNode.add(mapper().createObjectNode()
.put("host", i.getKey().toString())
.put("ip", i.getValue().ipAddress().toString())));
- return ok(root.toString()).build();
+ return ok(root).build();
}
@@ -96,12 +95,11 @@
@GET
@Path("available")
public Response listAvailableIPs() {
- final Iterable<Ip4Address> availableIPList = service.getAvailableIPs();
-
- final ObjectNode root = mapper().createObjectNode();
+ Iterable<Ip4Address> availableIPList = service.getAvailableIPs();
+ ObjectNode root = mapper().createObjectNode();
ArrayNode arrayNode = root.putArray("availableIP");
availableIPList.forEach(i -> arrayNode.add(i.toString()));
- return ok(root.toString()).build();
+ return ok(root).build();
}
/**
@@ -139,7 +137,7 @@
} catch (IOException e) {
throw new IllegalArgumentException(e.getMessage());
}
- return ok(root.toString()).build();
+ return ok(root).build();
}
/**
@@ -152,7 +150,6 @@
@DELETE
@Path("mappings/{macID}")
public Response deleteMapping(@PathParam("macID") String macID) {
-
ObjectNode root = mapper().createObjectNode();
if (!service.removeStaticMapping(MacAddress.valueOf(macID))) {
@@ -164,6 +161,6 @@
.put("host", i.getKey().toString())
.put("ip", i.getValue().ipAddress().toString())));
- return ok(root.toString()).build();
+ return ok(root).build();
}
}
diff --git a/apps/dhcp/app/src/main/webapp/WEB-INF/web.xml b/apps/dhcp/app/src/main/webapp/WEB-INF/web.xml
index a53110e..974ac99 100644
--- a/apps/dhcp/app/src/main/webapp/WEB-INF/web.xml
+++ b/apps/dhcp/app/src/main/webapp/WEB-INF/web.xml
@@ -14,24 +14,38 @@
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
-<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee"
+<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
id="ONOS" version="2.5">
<display-name>DHCP Server REST API v1.0</display-name>
+ <security-constraint>
+ <web-resource-collection>
+ <web-resource-name>Secured</web-resource-name>
+ <url-pattern>/*</url-pattern>
+ </web-resource-collection>
+ <auth-constraint>
+ <role-name>admin</role-name>
+ </auth-constraint>
+ </security-constraint>
+
+ <security-role>
+ <role-name>admin</role-name>
+ </security-role>
+
+ <login-config>
+ <auth-method>BASIC</auth-method>
+ <realm-name>karaf</realm-name>
+ </login-config>
+
<servlet>
<servlet-name>JAX-RS Service</servlet-name>
<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
<init-param>
- <param-name>com.sun.jersey.config.property.resourceConfigClass</param-name>
- <param-value>com.sun.jersey.api.core.ClassNamesResourceConfig</param-value>
- </init-param>
- <init-param>
- <param-name>com.sun.jersey.config.property.classnames</param-name>
- <param-value>
- org.onosproject.dhcp.rest.DhcpWebResource
- </param-value>
+ <param-name>javax.ws.rs.Application</param-name>
+ <param-value>org.onosproject.dhcp.rest.DhcpWebApplication</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
diff --git a/apps/vtn/vtnweb/src/main/java/org/onosproject/vtnweb/resources/VtnWebApplication.java b/apps/vtn/vtnweb/src/main/java/org/onosproject/vtnweb/resources/VtnWebApplication.java
new file mode 100644
index 0000000..4f24a2f
--- /dev/null
+++ b/apps/vtn/vtnweb/src/main/java/org/onosproject/vtnweb/resources/VtnWebApplication.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright 2014-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.
+ */
+
+package org.onosproject.vtnweb.resources;
+
+import org.onlab.rest.AbstractWebApplication;
+
+import java.util.Set;
+
+/**
+ * VTN REST API web application.
+ */
+public class VtnWebApplication extends AbstractWebApplication {
+ @Override
+ public Set<Class<?>> getClasses() {
+ return getClasses(TenantNetworkWebResource.class,
+ SubnetWebResource.class,
+ VirtualPortWebResource.class,
+ FlowClassifierWebResource.class,
+ PortChainWebResource.class,
+ PortPairGroupWebResource.class,
+ PortPairWebResource.class,
+ FloatingIpWebResource.class,
+ RouterWebResource.class);
+ }
+}
+
diff --git a/apps/vtn/vtnweb/src/main/webapp/WEB-INF/web.xml b/apps/vtn/vtnweb/src/main/webapp/WEB-INF/web.xml
index 3b8d5d7..abc83e4 100644
--- a/apps/vtn/vtnweb/src/main/webapp/WEB-INF/web.xml
+++ b/apps/vtn/vtnweb/src/main/webapp/WEB-INF/web.xml
@@ -42,41 +42,17 @@
-->
<servlet>
- <servlet-name>VTNRSC JAX-RS Service</servlet-name>
+ <servlet-name>JAX-RS Service</servlet-name>
<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
<init-param>
- <param-name>com.sun.jersey.config.property.resourceConfigClass</param-name>
- <param-value>com.sun.jersey.api.core.ClassNamesResourceConfig</param-value>
- </init-param>
- <init-param>
- <param-name>com.sun.jersey.config.property.classnames</param-name>
- <param-value>
- org.onosproject.rest.exceptions.EntityNotFoundMapper,
- org.onosproject.rest.exceptions.ServiceNotFoundMapper,
- org.onosproject.rest.exceptions.NotFoundMapper,
- org.onosproject.rest.exceptions.ServerErrorMapper,
- org.onosproject.rest.exceptions.BadRequestMapper,
- org.onosproject.rest.exceptions.WebApplicationExceptionMapper,
- org.onosproject.rest.exceptions.IllegalArgumentExceptionMapper,
- org.onosproject.rest.exceptions.IllegalStateExceptionMapper,
- org.onosproject.rest.resources.JsonBodyWriter,
-
- org.onosproject.vtnweb.resources.TenantNetworkWebResource,
- org.onosproject.vtnweb.resources.SubnetWebResource,
- org.onosproject.vtnweb.resources.VirtualPortWebResource,
- org.onosproject.vtnweb.resources.FlowClassifierWebResource,
- org.onosproject.vtnweb.resources.PortChainWebResource,
- org.onosproject.vtnweb.resources.PortPairGroupWebResource,
- org.onosproject.vtnweb.resources.PortPairWebResource,
- org.onosproject.vtnweb.resources.FloatingIpWebResource,
- org.onosproject.vtnweb.resources.RouterWebResource
- </param-value>
+ <param-name>javax.ws.rs.Application</param-name>
+ <param-value>org.onosproject.vtnweb.resources.VtnWebApplication</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
- <servlet-name>VTNRSC JAX-RS Service</servlet-name>
+ <servlet-name>JAX-RS Service</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>