/*
- * Copyright (c) 2015 Intel Corporation All rights reserved.
- * Copyright (c) 2015 Isaku Yamahata All rights reserved.
+ * Copyright (c) 2018 Intel Corporation and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
-
package org.opendaylight.neutron.northbound.api;
-import java.util.List;
+import static org.opendaylight.neutron.spi.INeutronCRUD.Result.AlreadyExists;
+import static org.opendaylight.neutron.spi.INeutronCRUD.Result.DependencyMissing;
+import static org.opendaylight.neutron.spi.INeutronCRUD.Result.DoesNotExist;
+import java.lang.reflect.Constructor;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.ParameterizedType;
+import java.net.HttpURLConnection;
+import java.util.List;
+import java.util.Objects;
+import javax.ws.rs.core.Response;
+import org.opendaylight.neutron.spi.INeutronCRUD;
+import org.opendaylight.neutron.spi.INeutronCRUD.Result;
+import org.opendaylight.neutron.spi.INeutronObject;
+import org.opendaylight.yangtools.yang.common.OperationFailedException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public abstract class AbstractNeutronNorthbound {
- private static final Logger LOGGER = LoggerFactory
- .getLogger(AbstractNeutronNorthbound.class);
+public abstract class AbstractNeutronNorthbound<T extends INeutronObject<T>, R extends INeutronRequest<T>,
+ I extends INeutronCRUD<T>> {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractNeutronNorthbound.class);
+
+ // T extends INeutronObject<T> as 0th type argument
+ private static final int NEUTRON_ARGUMENT_TYPE_INDEX = 0;
+ // NeutronRequest extends INeutronRequest<T> as 1st type argument
+ private static final int NEUTRON_REQUEST_TYPE_INDEX = 1;
protected static final int HTTP_OK_BOTTOM = 200;
protected static final int HTTP_OK_TOP = 299;
+ private static final int HTTP_MISSING_DEPENDENCY = 442; // see NEUTRON-158 (also in neutron.e2etest.HttpUtils)
private static final String INTERFACE_NAME_BASE = " CRUD Interface";
private static final String UUID_NO_EXIST_BASE = " UUID does not exist.";
- protected static final String NO_PROVIDERS = "No providers registered. Please try again later";
- protected static final String NO_PROVIDER_LIST = "Couldn't get providers list. Please try again later";
- protected static final String serviceUnavailable(String resourceName) {
- return resourceName + INTERFACE_NAME_BASE + RestMessages.SERVICEUNAVAILABLE.toString();
+ private final I neutronCRUD;
+
+ protected AbstractNeutronNorthbound(I neutronCRUD) {
+ this.neutronCRUD = Objects.requireNonNull(neutronCRUD, "neutronCRUD");
+ }
+
+ protected final String serviceUnavailable() {
+ return getResourceName() + INTERFACE_NAME_BASE + RestMessages.SERVICEUNAVAILABLE.toString();
+ }
+
+ protected final String uuidNoExist() {
+ return getResourceName() + UUID_NO_EXIST_BASE;
}
- protected static final String uuidNoExist(String resourceName) {
- return resourceName + UUID_NO_EXIST_BASE;
+
+ protected abstract String getResourceName();
+
+ private <K> Class<K> getActualTypeArgument(final int typeIndex) {
+ ParameterizedType parameterizedType = (ParameterizedType) getClass().getGenericSuperclass();
+ @SuppressWarnings("unchecked")
+ Class<K> cls = (Class<K>) parameterizedType.getActualTypeArguments()[typeIndex];
+ return cls;
+ }
+
+ private R newNeutronRequest(T neutronObject) {
+ // return new R(neutronObject)
+
+ // argumentClass = T.class
+ Class<T> argumentClass = getActualTypeArgument(NEUTRON_ARGUMENT_TYPE_INDEX);
+ // cls = NeturonRequest.class
+ Class<R> cls = getActualTypeArgument(NEUTRON_REQUEST_TYPE_INDEX);
+ try {
+ // ctor = R constructor
+ Constructor<R> ctor = cls.getDeclaredConstructor(argumentClass);
+ return ctor.newInstance(neutronObject);
+ } catch (NoSuchMethodException | InstantiationException
+ | IllegalAccessException | InvocationTargetException e) {
+ // This case shouldn't happen
+ throw new IllegalArgumentException(e);
+ }
}
- protected interface Remover {
- abstract public boolean remove(String uuid);
+ protected I getNeutronCRUD() {
+ return this.neutronCRUD;
+ }
+
+ protected Response show(String uuid, List<String> returnFields)
+ throws DatastoreOperationFailedWebApplicationException {
+ try {
+ T ans = neutronCRUD.get(uuid);
+ if (ans == null) {
+ throw new ResourceNotFoundException(uuidNoExist());
+ }
+
+ if (returnFields.size() > 0) {
+ return Response.status(HttpURLConnection.HTTP_OK)
+ .entity(newNeutronRequest(ans.extractFields(returnFields))).build();
+ } else {
+ return Response.status(HttpURLConnection.HTTP_OK).entity(newNeutronRequest(ans)).build();
+ }
+ } catch (OperationFailedException e) {
+ LOG.warn("get failed due to datastore problem; uuid: {}", uuid);
+ throw new DatastoreOperationFailedWebApplicationException(e);
+ }
+ }
+
+ protected Response create(final R input) throws DatastoreOperationFailedWebApplicationException {
+ try {
+ if (input.isSingleton()) {
+ T singleton = input.getSingleton();
+
+ singleton.initDefaults();
+ Result result = neutronCRUD.add(singleton);
+ if (result.equals(DependencyMissing)) {
+ LOG.warn("create failed due to input missing dependencies: {}", input);
+ return Response.status(HTTP_MISSING_DEPENDENCY).entity(input).build();
+ } else if (result.equals(AlreadyExists)) {
+ return Response.status(HttpURLConnection.HTTP_CONFLICT).entity(input).build();
+ }
+ } else {
+ if (input.getBulk() == null) {
+ throw new BadRequestException("Invalid requests");
+ }
+ for (T test : input.getBulk()) {
+ test.initDefaults();
+ Result result = neutronCRUD.add(test);
+ if (result.equals(DependencyMissing)) {
+ LOG.warn("create failed due to input missing dependencies: {}", input);
+ return Response.status(HTTP_MISSING_DEPENDENCY).entity(input).build();
+ } else if (result.equals(AlreadyExists)) {
+ return Response.status(HttpURLConnection.HTTP_CONFLICT).entity(input).build();
+ }
+ }
+ }
+ return Response.status(HttpURLConnection.HTTP_CREATED).entity(input).build();
+ } catch (OperationFailedException e) {
+ LOG.warn("create failed due to datastore problem (possibly missing required fields); input: {}", input);
+ throw new DatastoreOperationFailedWebApplicationException(e);
+ }
+ }
+
+ protected void updateDelta(String uuid, T delta, T original) {
+ }
+
+ private boolean checkRevisionNumber(T original, T delta) {
+ // If new update is null ignore the original revision number
+ if (delta.getRevisionNumber() == null) {
+ return false;
+ }
+ // If what is stored is null no need for comparison
+ if (original.getRevisionNumber() == null) {
+ return false;
+ }
+ if (original.getRevisionNumber() > delta.getRevisionNumber()) {
+ return true;
+ }
+ return false;
+ }
+
+ protected Response update(String uuid, final R input) throws DatastoreOperationFailedWebApplicationException {
+ if (!input.isSingleton()) {
+ throw new BadRequestException("Only singleton edit supported");
+ }
+ T delta = input.getSingleton();
+ try {
+ T original = neutronCRUD.get(uuid);
+ if (original == null) {
+ throw new ResourceNotFoundException(uuidNoExist());
+ }
+ if (checkRevisionNumber(original, delta)) {
+ return Response.status(HttpURLConnection.HTTP_OK).build();
+ }
+ updateDelta(uuid, delta, original);
+ /*
+ * update the object and return it
+ */
+ Result updateResult = neutronCRUD.update(uuid, delta);
+ if (updateResult.equals(DoesNotExist)) {
+ throw new ResourceNotFoundException(uuidNoExist());
+ } else if (updateResult.equals(DependencyMissing)) {
+ LOG.warn("update failed due to missing dependencies; input: {}", input);
+ return Response.status(HTTP_MISSING_DEPENDENCY).entity(input).build();
+ }
+ T updated = neutronCRUD.get(uuid);
+ return Response.status(HttpURLConnection.HTTP_OK).entity(newNeutronRequest(updated)).build();
+ } catch (OperationFailedException e) {
+ LOG.warn("update failed due to datastore problem (possibly missing required fields); input: {}", input);
+ throw new DatastoreOperationFailedWebApplicationException(e);
+ }
}
- public void deleteUuid(String resourceName, String uuid, Remover remover) {
- boolean exist = false;
+ protected Response delete(String uuid) throws DatastoreOperationFailedWebApplicationException {
try {
- exist = remover.remove(uuid);
- } catch (Exception e) {
- LOGGER.debug("exception during remove {} {} {}",
- resourceName, uuid, e);
- throw new InternalServerErrorException("Could not delete " +
- resourceName);
- }
- if (!exist) {
- throw new ResourceNotFoundException(uuidNoExist(resourceName));
+ // remove it and return 204 status
+ if (!neutronCRUD.remove(uuid)) {
+ throw new ResourceNotFoundException(uuidNoExist());
+ } else {
+ return Response.status(HttpURLConnection.HTTP_NO_CONTENT).build();
+ }
+ } catch (OperationFailedException e) {
+ LOG.warn("delete failed due to datastore problem; uuid: {}", uuid);
+ throw new DatastoreOperationFailedWebApplicationException(e);
}
}
}
Code Review / neutron.git / blobdiff