gerrit.onap Code Review - ccsdk/sli/plugins.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - CCSDK
   4  * ================================================================================
   5  * Copyright (C) 2018 Huawei Technologies Co., Ltd. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.ccsdk.sli.plugins.restconfapicall;
  22
  23 import java.util.Map;
  24 import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
  25 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
  26 import org.onap.ccsdk.sli.core.sli.SvcLogicJavaPlugin;
  27
  28 /**
  29  * Representation of a plugin to enable RESTCONF based CRUD operations from DG.
  30  */
  31 public class RestconfapiCallNode implements SvcLogicJavaPlugin {
  32
  33     public RestconfapiCallNode() {
  34     }
  35
  36     /**
  37      * Allows Directed Graphs  the ability to interact with RESTCONF APIs.
  38      * @param parameters HashMap<String,String> of parameters passed by the DG to this function
  39      * <table border="1">
  40      *  <thead><th>parameter</th><th>Mandatory/Optional</th><th>description</th><th>example values</th></thead>
  41      *  <tbody>
  42      *      <tr><td>templateFileName</td><td>Optional</td><td>full path to YANG directory that can be used to build a request</td><td>/sdncopt/bvc/resconfapi/test</td></tr>
  43      *      <tr><td>restapiUrl</td><td>Mandatory</td><td>url to send the request to</td><td>https://sdncodl:8543/restconf/operations/L3VNF-API:create-update-vnf-request</td></tr>
  44      *      <tr><td>restapiUser</td><td>Optional</td><td>user name to use for http basic authentication</td><td>sdnc_ws</td></tr>
  45      *      <tr><td>restapiPassword</td><td>Optional</td><td>unencrypted password to use for http basic authentication</td><td>plain_password</td></tr>
  46      *      <tr><td>contentType</td><td>Optional</td><td>http content type to set in the http header</td><td>usually application/json or application/xml</td></tr>
  47      *      <tr><td>format</td><td>Optional</td><td>should match request body format</td><td>json or xml</td></tr>
  48      *      <tr><td>httpMethod</td><td>Optional</td><td>http method to use when sending the request</td><td>get post put delete patch</td></tr>
  49      *      <tr><td>responsePrefix</td><td>Optional</td><td>location the response will be written to in context memory</td><td>tmp.resconftapi.result</td></tr>
  50      *      <tr><td>skipSending</td><td>Optional</td><td></td><td>true or false</td></tr>
  51      *      <tr><td>convertResponse </td><td>Optional</td><td>whether the response should be converted</td><td>true or false</td></tr>
  52      *      <tr><td>customHttpHeaders</td><td>Optional</td><td>a list additional http headers to be passed in, follow the format in the example</td><td>X-CSI-MessageId=messageId,headerFieldName=headerFieldValue</td></tr>
  53      *      <tr><td>dumpHeaders</td><td>Optional</td><td>when true writes http header content to context memory</td><td>true or false</td></tr>
  54      *  </tbody>
  55      * </table>
  56      * @param ctx Reference to context memory
  57      * @throws SvcLogicException
  58      * @since 11.0.2
  59      * @see String#split(String, int)
  60      */
  61     public void sendRequest(Map<String, String> paramMap, SvcLogicContext ctx) throws SvcLogicException {
  62         //TODO
  63     }
  64
  65 }