/* * Copyright (c) 2015 Brocade Communications Systems, Inc. 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.netconf.sal.restconf.impl; import com.google.common.base.Optional; import com.google.common.base.Preconditions; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.InputStream; import java.lang.annotation.Annotation; import java.net.URI; import java.nio.charset.StandardCharsets; import java.util.Collections; import java.util.List; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.MultivaluedHashMap; import javax.ws.rs.core.MultivaluedMap; import javax.ws.rs.core.PathSegment; import javax.ws.rs.core.UriBuilder; import javax.ws.rs.core.UriInfo; import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType; import org.opendaylight.netconf.sal.rest.impl.JsonNormalizedNodeBodyReader; import org.opendaylight.netconf.sal.rest.impl.NormalizedNodeJsonBodyWriter; import org.opendaylight.netconf.sal.restconf.api.JSONRestconfService; import org.opendaylight.netconf.sal.restconf.impl.RestconfError.ErrorTag; import org.opendaylight.yangtools.yang.common.OperationFailedException; import org.opendaylight.yangtools.yang.common.RpcError; import org.opendaylight.yangtools.yang.common.RpcError.ErrorType; import org.opendaylight.yangtools.yang.common.RpcResultBuilder; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * Implementation of the JSONRestconfService interface using the restconf Draft02 implementation. * * @author Thomas Pantelis * @deprecated Replaced by {@link JSONRestconfServiceDraft18} */ @Deprecated public class JSONRestconfServiceImpl implements JSONRestconfService, AutoCloseable { private static final Logger LOG = LoggerFactory.getLogger(JSONRestconfServiceImpl.class); private static final Annotation[] EMPTY_ANNOTATIONS = new Annotation[0]; @SuppressWarnings("checkstyle:IllegalCatch") @Override public void put(final String uriPath, final String payload) throws OperationFailedException { Preconditions.checkNotNull(payload, "payload can't be null"); LOG.debug("put: uriPath: {}, payload: {}", uriPath, payload); final InputStream entityStream = new ByteArrayInputStream(payload.getBytes(StandardCharsets.UTF_8)); final NormalizedNodeContext context = JsonNormalizedNodeBodyReader.readFrom(uriPath, entityStream, false); LOG.debug("Parsed YangInstanceIdentifier: {}", context.getInstanceIdentifierContext().getInstanceIdentifier()); LOG.debug("Parsed NormalizedNode: {}", context.getData()); try { RestconfImpl.getInstance().updateConfigurationData(uriPath, context, new SimpleUriInfo(uriPath)); } catch (final Exception e) { propagateExceptionAs(uriPath, e, "PUT"); } } @SuppressWarnings("checkstyle:IllegalCatch") @Override public void post(final String uriPath, final String payload) throws OperationFailedException { Preconditions.checkNotNull(payload, "payload can't be null"); LOG.debug("post: uriPath: {}, payload: {}", uriPath, payload); final InputStream entityStream = new ByteArrayInputStream(payload.getBytes(StandardCharsets.UTF_8)); final NormalizedNodeContext context = JsonNormalizedNodeBodyReader.readFrom(uriPath, entityStream, true); LOG.debug("Parsed YangInstanceIdentifier: {}", context.getInstanceIdentifierContext().getInstanceIdentifier()); LOG.debug("Parsed NormalizedNode: {}", context.getData()); try { RestconfImpl.getInstance().createConfigurationData(uriPath, context, new SimpleUriInfo(uriPath)); } catch (final Exception e) { propagateExceptionAs(uriPath, e, "POST"); } } @SuppressWarnings("checkstyle:IllegalCatch") @Override public void delete(final String uriPath) throws OperationFailedException { LOG.debug("delete: uriPath: {}", uriPath); try { RestconfImpl.getInstance().deleteConfigurationData(uriPath); } catch (final Exception e) { propagateExceptionAs(uriPath, e, "DELETE"); } } @SuppressWarnings("checkstyle:IllegalCatch") @Override public Optional get(final String uriPath, final LogicalDatastoreType datastoreType) throws OperationFailedException { LOG.debug("get: uriPath: {}", uriPath); try { NormalizedNodeContext readData; final SimpleUriInfo uriInfo = new SimpleUriInfo(uriPath); if (datastoreType == LogicalDatastoreType.CONFIGURATION) { readData = RestconfImpl.getInstance().readConfigurationData(uriPath, uriInfo); } else { readData = RestconfImpl.getInstance().readOperationalData(uriPath, uriInfo); } final Optional result = Optional.of(toJson(readData)); LOG.debug("get returning: {}", result.get()); return result; } catch (final Exception e) { if (!isDataMissing(e)) { propagateExceptionAs(uriPath, e, "GET"); } LOG.debug("Data missing - returning absent"); return Optional.absent(); } } @SuppressWarnings("checkstyle:IllegalCatch") @Override public Optional invokeRpc(final String uriPath, final Optional input) throws OperationFailedException { Preconditions.checkNotNull(uriPath, "uriPath can't be null"); final String actualInput = input.isPresent() ? input.get() : null; LOG.debug("invokeRpc: uriPath: {}, input: {}", uriPath, actualInput); String output = null; try { NormalizedNodeContext outputContext; if (actualInput != null) { final InputStream entityStream = new ByteArrayInputStream(actualInput.getBytes(StandardCharsets.UTF_8)); final NormalizedNodeContext inputContext = JsonNormalizedNodeBodyReader.readFrom(uriPath, entityStream, true); LOG.debug("Parsed YangInstanceIdentifier: {}", inputContext.getInstanceIdentifierContext() .getInstanceIdentifier()); LOG.debug("Parsed NormalizedNode: {}", inputContext.getData()); outputContext = RestconfImpl.getInstance().invokeRpc(uriPath, inputContext, null); } else { outputContext = RestconfImpl.getInstance().invokeRpc(uriPath, "", null); } if (outputContext.getData() != null) { output = toJson(outputContext); } } catch (final Exception e) { propagateExceptionAs(uriPath, e, "RPC"); } return Optional.fromNullable(output); } @Override public void close() { } private static String toJson(final NormalizedNodeContext readData) throws IOException { final NormalizedNodeJsonBodyWriter writer = new NormalizedNodeJsonBodyWriter(); final ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); writer.writeTo(readData, NormalizedNodeContext.class, null, EMPTY_ANNOTATIONS, MediaType.APPLICATION_JSON_TYPE, null, outputStream); return outputStream.toString(StandardCharsets.UTF_8.name()); } private static boolean isDataMissing(final Exception exception) { boolean dataMissing = false; if (exception instanceof RestconfDocumentedException) { final RestconfDocumentedException rde = (RestconfDocumentedException)exception; if (!rde.getErrors().isEmpty()) { if (rde.getErrors().get(0).getErrorTag() == ErrorTag.DATA_MISSING) { dataMissing = true; } } } return dataMissing; } private static void propagateExceptionAs(final String uriPath, final Exception exception, final String operation) throws OperationFailedException { LOG.debug("Error for uriPath: {}", uriPath, exception); if (exception instanceof RestconfDocumentedException) { throw new OperationFailedException(String.format( "%s failed for URI %s", operation, uriPath), exception.getCause(), toRpcErrors(((RestconfDocumentedException)exception).getErrors())); } throw new OperationFailedException(String.format("%s failed for URI %s", operation, uriPath), exception); } private static RpcError[] toRpcErrors(final List from) { final RpcError[] to = new RpcError[from.size()]; int index = 0; for (final RestconfError e: from) { to[index++] = RpcResultBuilder.newError(toRpcErrorType(e.getErrorType()), e.getErrorTag().getTagValue(), e.getErrorMessage()); } return to; } private static ErrorType toRpcErrorType(final RestconfError.ErrorType errorType) { switch (errorType) { case TRANSPORT: { return ErrorType.TRANSPORT; } case RPC: { return ErrorType.RPC; } case PROTOCOL: { return ErrorType.PROTOCOL; } default: { return ErrorType.APPLICATION; } } } private static class SimpleUriInfo implements UriInfo { private final String path; private final MultivaluedMap queryParams; SimpleUriInfo(String path) { this(path, new MultivaluedHashMap<>()); } SimpleUriInfo(String path, MultivaluedMap queryParams) { this.path = path; this.queryParams = queryParams; } @Override public String getPath() { return path; } @Override public String getPath(boolean decode) { return path; } @Override public List getPathSegments() { throw new UnsupportedOperationException(); } @Override public List getPathSegments(boolean decode) { throw new UnsupportedOperationException(); } @Override public URI getRequestUri() { return URI.create(path); } @Override public UriBuilder getRequestUriBuilder() { return UriBuilder.fromUri(getRequestUri()); } @Override public URI getAbsolutePath() { return getRequestUri(); } @Override public UriBuilder getAbsolutePathBuilder() { return UriBuilder.fromUri(getAbsolutePath()); } @Override public URI getBaseUri() { return URI.create(""); } @Override public UriBuilder getBaseUriBuilder() { return UriBuilder.fromUri(getBaseUri()); } @Override public MultivaluedMap getPathParameters() { return new MultivaluedHashMap<>(); } @Override public MultivaluedMap getPathParameters(boolean decode) { return getPathParameters(); } @Override public MultivaluedMap getQueryParameters() { return queryParams; } @Override public MultivaluedMap getQueryParameters(boolean decode) { return getQueryParameters(); } @Override public List getMatchedURIs() { return Collections.emptyList(); } @Override public List getMatchedURIs(boolean decode) { return getMatchedURIs(); } @Override public List getMatchedResources() { return Collections.emptyList(); } @Override public URI resolve(URI uri) { return uri; } @Override public URI relativize(URI uri) { return uri; } } }