--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - CCSDK
+ * ================================================================================
+ * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.ccsdk.sli.plugins.restconfapicall;
+
+import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
+import org.onap.ccsdk.sli.core.sli.SvcLogicException;
+import org.onap.ccsdk.sli.core.sli.SvcLogicJavaPlugin;
+import org.onap.ccsdk.sli.plugins.restapicall.HttpResponse;
+import org.onap.ccsdk.sli.plugins.restapicall.RestapiCallNode;
+import org.onap.ccsdk.sli.plugins.restapicall.RetryException;
+import org.onap.ccsdk.sli.plugins.restapicall.RetryPolicy;
+import org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.DataFormatSerializer;
+import org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.DataFormatSerializerContext;
+import org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.DfSerializerFactory;
+import org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.Listener;
+import org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.MdsalSerializerHelper;
+import org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.SerializerHelper;
+import org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.YangParameters;
+import org.onap.ccsdk.sli.plugins.yangserializers.pnserializer.MdsalPropertiesNodeSerializer;
+import org.onap.ccsdk.sli.plugins.yangserializers.pnserializer.PropertiesNodeSerializer;
+import org.opendaylight.netconf.sal.restconf.impl.ControllerContext;
+import org.opendaylight.restconf.common.context.InstanceIdentifierContext;
+import org.opendaylight.yangtools.yang.model.api.SchemaContext;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.ServiceReference;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.ws.rs.core.UriBuilder;
+import java.net.SocketException;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+import static java.lang.String.format;
+import static org.apache.commons.lang3.StringUtils.join;
+import static org.onap.ccsdk.sli.plugins.restapicall.HttpMethod.POST;
+import static org.onap.ccsdk.sli.plugins.restapicall.HttpMethod.PUT;
+import static org.onap.ccsdk.sli.plugins.restapicall.RestapiCallNode.parseParam;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.ATTEMPTS_MSG;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.COMMA;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.COMM_FAIL;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.HEADER;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.HTTP_REQ;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.HTTP_RES;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.MAX_RETRY_ERR;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.NO_MORE_RETRY;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.REQ_ERR;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.REST_API_URL;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.RES_CODE;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.RES_MSG;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.RES_PRE;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.RETRY_COUNT;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.RETRY_FAIL;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.UPDATED_URL;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.getSchemaCtxFromDir;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.getYangParameters;
+import static org.onap.ccsdk.sli.plugins.restconfapicall.RestconfApiUtils.parseUrl;
+import static org.onap.ccsdk.sli.plugins.yangserializers.dfserializer.DfListenerFactory.instance;
+import static org.osgi.framework.FrameworkUtil.getBundle;
+
+/**
+ * Representation of a plugin to enable RESTCONF based CRUD operations from DG.
+ */
+public class RestconfApiCallNode implements SvcLogicJavaPlugin {
+
+ /**
+ * Logger for the restconf api call node class.
+ */
+ private static final Logger log = LoggerFactory.getLogger(
+ RestconfApiCallNode.class);
+
+ /**
+ * Creates an instance of restconf api call node.
+ */
+ public RestconfApiCallNode() {
+ }
+
+ /**
+ * Sends the restconf request using the parameters map and the memory
+ * context. And this method allows the directed graphs to interact with
+ * the restconf api call node
+ *
+ * @param paramMap parameters map
+ * @param ctx service logic context
+ * @throws SvcLogicException when svc logic exception occurs
+ */
+ public void sendRequest(Map<String, String> paramMap, SvcLogicContext ctx)
+ throws SvcLogicException {
+ sendRequest(paramMap, ctx, 0);
+ }
+
+ /**
+ * Sends the restconf request using the parameters map and the memory
+ * context along with the retry count.
+ *
+ * @param paramMap parameters map
+ * @param ctx service logic context
+ * @param retryCount number of retry counts
+ * @throws SvcLogicException when svc logic exception occurs
+ */
+ public void sendRequest(Map<String, String> paramMap, SvcLogicContext ctx,
+ Integer retryCount) throws SvcLogicException {
+ RestapiCallNode rest = new RestapiCallNode();
+ RetryPolicy retryPolicy = null;
+ HttpResponse r = new HttpResponse();
+ try {
+ YangParameters p = getYangParameters(paramMap);
+ if (p.partner != null) {
+ retryPolicy = rest.getRetryPolicyStore()
+ .getRetryPolicy(p.partner);
+ }
+
+ String pp = p.responsePrefix != null ? p.responsePrefix + '.' : "";
+ Map<String, String> props = new HashMap<>((Map)ctx.toProperties());
+ String uri = parseUrl(p.restapiUrl, p.httpMethod);
+ InstanceIdentifierContext<?> insIdCtx = getInsIdCtx(p, uri);
+
+ String req = null;
+ if (p.httpMethod == POST || p.httpMethod == PUT) {
+ req = serializeRequest(props, p, uri, insIdCtx);
+ }
+ if (req == null && p.requestBody != null) {
+ req = p.requestBody;
+ }
+
+ r = rest.sendHttpRequest(req, p);
+ if (p.returnRequestPayload && req != null) {
+ ctx.setAttribute(pp + HTTP_REQ, req);
+ }
+
+ String response = getResponse(ctx, p, pp, r);
+ if (response != null) {
+ Map<String, String> resProp = serializeResponse(
+ p, uri, response, insIdCtx);
+ for (Map.Entry<String, String> pro : resProp.entrySet()) {
+ ctx.setAttribute(pro.getKey(), pro.getValue());
+ }
+ }
+ } catch (SvcLogicException e) {
+ boolean shouldRetry = false;
+ if (e.getCause().getCause() instanceof SocketException) {
+ shouldRetry = true;
+ }
+
+ log.error(REQ_ERR + e.getMessage(), e);
+ String prefix = parseParam(paramMap, RES_PRE, false, null);
+ if (retryPolicy == null || shouldRetry == false) {
+ setFailureResponseStatus(ctx, prefix, e.getMessage(), r);
+ } else {
+ if (retryCount == null) {
+ retryCount = 0;
+ }
+ log.debug(format(ATTEMPTS_MSG, retryCount,
+ retryPolicy.getMaximumRetries()));
+ try {
+ retryCount = retryCount + 1;
+ if (retryCount < retryPolicy.getMaximumRetries() + 1) {
+ setRetryUri(paramMap, retryPolicy);
+ log.debug(format(RETRY_COUNT, retryCount, retryPolicy
+ .getMaximumRetries()));
+ sendRequest(paramMap, ctx, retryCount);
+ } else {
+ log.debug(MAX_RETRY_ERR);
+ setFailureResponseStatus(ctx, prefix,
+ e.getMessage(), r);
+ }
+ } catch (Exception ex) {
+ log.error(NO_MORE_RETRY, ex);
+ setFailureResponseStatus(ctx, prefix, RETRY_FAIL, r);
+ }
+ }
+ }
+
+ if (r != null && r.code >= 300) {
+ throw new SvcLogicException(
+ String.valueOf(r.code) + ": " + r.message);
+ }
+ }
+
+ /**
+ * Serializes the request message to JSON or XML from the properties.
+ *
+ * @param properties properties
+ * @param params YANG parameters
+ * @param uri URI
+ * @param insIdCtx instance identifier context
+ * @return JSON or XML message to be sent
+ * @throws SvcLogicException when serializing the request fails
+ */
+ protected String serializeRequest(Map<String, String> properties,
+ YangParameters params, String uri,
+ InstanceIdentifierContext insIdCtx)
+ throws SvcLogicException {
+ PropertiesNodeSerializer propSer = new MdsalPropertiesNodeSerializer(
+ insIdCtx.getSchemaNode(), insIdCtx.getSchemaContext(), uri);
+ DataFormatSerializerContext serCtx = new DataFormatSerializerContext(
+ null, uri, null, propSer);
+ DataFormatSerializer ser = DfSerializerFactory.instance()
+ .getSerializer(serCtx, params);
+ //TODO: Handling of XML annotations
+ return ser.encode(properties, null);
+ }
+
+ /**
+ * Serializes the response message from JSON or XML to the properties.
+ *
+ * @param params YANG parameters
+ * @param uri URI
+ * @param response response message
+ * @param insIdCtx instance identifier context
+ * @return response message as properties
+ * @throws SvcLogicException when serializing the response fails
+ */
+ protected Map<String, String> serializeResponse(YangParameters params,
+ String uri, String response,
+ InstanceIdentifierContext insIdCtx)
+ throws SvcLogicException {
+ PropertiesNodeSerializer propSer = new MdsalPropertiesNodeSerializer(
+ insIdCtx.getSchemaNode(), insIdCtx.getSchemaContext(), uri);
+ SerializerHelper helper = new MdsalSerializerHelper(
+ insIdCtx.getSchemaNode(), insIdCtx.getSchemaContext(), uri);
+ Listener listener = instance().getListener(helper, params);
+ DataFormatSerializerContext serCtx = new DataFormatSerializerContext(
+ listener, uri, null, propSer);
+ DataFormatSerializer ser = DfSerializerFactory.instance()
+ .getSerializer(serCtx, params);
+ return ser.decode(response);
+ }
+
+ /**
+ * Returns instance identifier context for a uri using the schema context.
+ *
+ * @param params YANG parameters
+ * @param uri URI
+ * @return instance identifier context
+ * @throws SvcLogicException when getting schema context fails
+ */
+ private InstanceIdentifierContext<?> getInsIdCtx(YangParameters params,
+ String uri)
+ throws SvcLogicException {
+ SchemaContext context = getSchemaContext(params);
+ ControllerContext contCtx = ControllerContext.getInstance();
+ contCtx.onGlobalContextUpdated(context);
+ return contCtx.toInstanceIdentifier(uri);
+ }
+
+ /**
+ * Returns the global schema context or schema context of particular YANG
+ * files present in a directory path.
+ *
+ * @param params YANG parameters
+ * @return schema context
+ * @throws SvcLogicException when schema context fetching fails
+ */
+ private SchemaContext getSchemaContext(YangParameters params)
+ throws SvcLogicException {
+ if (params.dirPath != null) {
+ return getSchemaCtxFromDir(params.dirPath);
+ }
+ BundleContext bc = getBundle(SchemaContext.class).getBundleContext();
+ SchemaContext schemaContext = null;
+ if (bc != null) {
+ ServiceReference reference = bc.getServiceReference(
+ SchemaContext.class);
+ if (reference != null) {
+ schemaContext = (SchemaContext) bc.getService(reference);
+ }
+ }
+ return schemaContext;
+ }
+
+ /**
+ * Returns the response message body of a http response message.
+ *
+ * @param ctx svc logic context
+ * @param params parameters
+ * @param pre prefix to be appended
+ * @param res http response
+ * @return response message body
+ */
+ private String getResponse(SvcLogicContext ctx, YangParameters params,
+ String pre, HttpResponse res) {
+ ctx.setAttribute(pre + RES_CODE, String.valueOf(res.code));
+ ctx.setAttribute(pre + RES_MSG, res.message);
+
+ if (params.dumpHeaders && res.headers != null) {
+ for (Map.Entry<String, List<String>> a : res.headers.entrySet()) {
+ ctx.setAttribute(pre + HEADER + a.getKey(),
+ join(a.getValue(), COMMA));
+ }
+ }
+
+ if (res.body != null && res.body.trim().length() > 0) {
+ ctx.setAttribute(pre + HTTP_RES, res.body);
+ return res.body;
+ }
+ return null;
+ }
+
+ /**
+ * Sets the failure response status in the context memory.
+ *
+ * @param ctx service logic context
+ * @param prefix prefix to be added
+ * @param errMsg error message
+ * @param res http response
+ */
+ private void setFailureResponseStatus(SvcLogicContext ctx, String prefix,
+ String errMsg, HttpResponse res) {
+ res = new HttpResponse();
+ res.code = 500;
+ res.message = errMsg;
+ ctx.setAttribute(prefix + RES_CODE, String.valueOf(res.code));
+ ctx.setAttribute(prefix + RES_MSG, res.message);
+ }
+
+ /**
+ * Sets the retry URI to the param map from the retry policies different
+ * host.
+ *
+ * @param paramMap parameter map
+ * @param retryPolicy retry policy
+ * @throws URISyntaxException when new URI creation fails
+ * @throws RetryException when retry policy cannot give another host
+ */
+ private void setRetryUri(Map<String, String> paramMap,
+ RetryPolicy retryPolicy)
+ throws URISyntaxException, RetryException {
+ URI uri = new URI(paramMap.get(REST_API_URL));
+ String hostName = uri.getHost();
+ String retryString = retryPolicy.getNextHostName(uri.toString());
+
+ URI uriTwo = new URI(retryString);
+ URI retryUri = UriBuilder.fromUri(uri).host(uriTwo.getHost()).port(
+ uriTwo.getPort()).scheme(uriTwo.getScheme()).build();
+
+ paramMap.put(REST_API_URL, retryUri.toString());
+ log.debug(UPDATED_URL + retryUri.toString());
+ log.debug(format(COMM_FAIL, hostName, retryString));
+ }
+}
Code Review / ccsdk / sli / plugins.git / blobdiff