src/main/java/org/onap/aai/rest/RestClientProducer.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017 Amdocs
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23 package org.onap.aai.rest;
  24
  25 import org.apache.camel.Exchange;
  26 import org.apache.camel.impl.DefaultProducer;
  27 import org.eclipse.jetty.util.security.Password;
  28 import org.onap.aai.event.EventBusConsumer;
  29 import org.onap.aai.restclient.client.Headers;
  30 import org.onap.aai.restclient.client.OperationResult;
  31 import org.onap.aai.restclient.client.RestClient;
  32 import org.onap.aai.restclient.rest.HttpUtil;
  33 import org.onap.aai.cl.api.Logger;
  34 import org.onap.aai.cl.eelf.LoggerFactory;
  35
  36 import java.util.Arrays;
  37 import java.util.HashMap;
  38 import java.util.List;
  39 import java.util.Map;
  40
  41 import javax.ws.rs.core.MediaType;
  42 import javax.ws.rs.core.Response;
  43
  44
  45 /**
  46  * The EcompRest producer.
  47  */
  48 public class RestClientProducer extends DefaultProducer {
  49
  50   private enum Operation {
  51     GET, PUT, POST, DELETE
  52   }
  53
  54   private RestClientEndpoint endpoint;
  55
  56   /** REST client used for sending HTTP requests. */
  57   private RestClient restClient;
  58
  59   private Logger logger = LoggerFactory.getInstance().getLogger(RestClientProducer.class);
  60
  61
  62   public RestClientProducer(RestClientEndpoint endpoint) {
  63     super(endpoint);
  64     this.endpoint = endpoint;
  65   }
  66
  67   @Override
  68   public void process(Exchange exchange) {
  69
  70     // Extract the URL for our REST request from the IN message header.
  71     String url = exchange.getIn().getHeader(RestClientEndpoint.IN_HEADER_URL).toString();
  72
  73     // Populate the HTTP Request header values from any values passed in via the
  74     // IN message headers.
  75     Map<String, List<String>> headers = populateRestHeaders(exchange);
  76
  77     if (logger.isDebugEnabled()) {
  78       StringBuilder sb = new StringBuilder();
  79       sb.append("Process REST request - operation=").append(getOperation(exchange));
  80       sb.append(" headers=[");
  81       for (String key : headers.keySet()) {
  82         sb.append("{").append(key).append("->").append(headers.get(key)).append("} ");
  83       }
  84       sb.append("]");
  85       sb.append(" content: ").append(exchange.getIn().getBody());
  86       logger.debug(sb.toString());
  87     }
  88
  89     // Now, invoke the REST client to perform the operation.
  90     OperationResult result;
  91     switch (getOperation(exchange)) {
  92
  93       case GET:
  94         result = getRestClient().get(url, headers, MediaType.APPLICATION_JSON_TYPE);
  95         break;
  96
  97       case PUT:
  98         result = getRestClient().put(url, exchange.getIn().getBody().toString(), headers,
  99             MediaType.APPLICATION_JSON_TYPE, null);
 100         break;
 101
 102       case POST:
 103         result = getRestClient().post(url, exchange.getIn().getBody().toString(), headers,
 104             MediaType.APPLICATION_JSON_TYPE, MediaType.APPLICATION_JSON_TYPE);
 105         break;
 106
 107       case DELETE:
 108         result = getRestClient().delete(url, headers, MediaType.APPLICATION_JSON_TYPE);
 109         break;
 110
 111       default:
 112         // The supplied operation is not supported.
 113         result = new OperationResult();
 114         result.setResultCode(Response.Status.BAD_REQUEST.getStatusCode());
 115         result.setFailureCause("Unsupported HTTP Operation: " + getOperation(exchange));
 116
 117         break;
 118     }
 119
 120     /** Just use IN headers as camel does not pass incoming headers from IN to OUT so they might be lost .
 121     Reference : http://camel.apache.org/using-getin-or-getout-methods-on-exchange.html **/
 122     exchange.getIn().setHeader(RestClientEndpoint.OUT_HEADER_RESPONSE_CODE,
 123         result.getResultCode());
 124     if (HttpUtil.isHttpResponseClassSuccess(result.getResultCode())) {
 125       exchange.getIn().setHeader(RestClientEndpoint.OUT_HEADER_RESPONSE_MSG,
 126           responseStatusStringFromResult(result));
 127       exchange.getIn().setBody(result.getResult());
 128     } else {
 129       exchange.getIn().setHeader(RestClientEndpoint.OUT_HEADER_RESPONSE_MSG,
 130           result.getFailureCause());
 131     }
 132
 133   }
 134
 135
 136   /**
 137    * Extracts the requested REST operation from the exchange message.
 138    *
 139    * @param exchange - The Camel exchange to pull the operation from.
 140    *
 141    * @return - The REST operation being requested.
 142    */
 143   private Operation getOperation(Exchange exchange) {
 144
 145     String toEndpoint = ((String) exchange.getProperty(Exchange.TO_ENDPOINT));
 146
 147     String operation = toEndpoint.substring((toEndpoint.lastIndexOf("://") + 3));
 148
 149     int position = operation.indexOf('?');
 150     if (position >= 0) {
 151       operation = operation.substring(0, position);
 152     }
 153
 154     return Operation.valueOf(operation.toUpperCase());
 155   }
 156
 157
 158
 159   /**
 160    * This method extracts values from the IN message which are intended to be used to populate the
 161    * HTTP Header entries for our REST request.
 162    *
 163    * @param exchange - The Camel exchange to extract the HTTP header parameters from.
 164    *
 165    * @return - A map of HTTP header names and values.
 166    */
 167   private Map<String, List<String>> populateRestHeaders(Exchange exchange) {
 168
 169     Map<String, List<String>> headers = new HashMap<>();
 170
 171     if (exchange.getIn().getHeader(Headers.FROM_APP_ID) != null) {
 172       headers.put(Headers.FROM_APP_ID,
 173           Arrays.asList(exchange.getIn().getHeader(Headers.FROM_APP_ID).toString()));
 174     }
 175     if (exchange.getIn().getHeader(Headers.TRANSACTION_ID) != null) {
 176       headers.put(Headers.TRANSACTION_ID,
 177           Arrays.asList(exchange.getIn().getHeader(Headers.TRANSACTION_ID).toString()));
 178     }
 179     if (exchange.getIn().getHeader(Headers.RESOURCE_VERSION) != null) {
 180       headers.put(Headers.RESOURCE_VERSION,
 181           Arrays.asList(exchange.getIn().getHeader(Headers.RESOURCE_VERSION).toString()));
 182     }
 183     if (exchange.getIn().getHeader(Headers.ETAG) != null) {
 184       headers.put(Headers.ETAG, Arrays.asList(exchange.getIn().getHeader(Headers.ETAG).toString()));
 185     }
 186     if (exchange.getIn().getHeader(Headers.IF_MATCH) != null) {
 187       headers.put(Headers.IF_MATCH,
 188           Arrays.asList(exchange.getIn().getHeader(Headers.IF_MATCH).toString()));
 189     }
 190     if (exchange.getIn().getHeader(Headers.IF_NONE_MATCH) != null) {
 191       headers.put(Headers.IF_NONE_MATCH,
 192           Arrays.asList(exchange.getIn().getHeader(Headers.IF_NONE_MATCH).toString()));
 193     }
 194     if (exchange.getIn().getHeader(Headers.ACCEPT) != null) {
 195       headers.put(Headers.ACCEPT,
 196           Arrays.asList(exchange.getIn().getHeader(Headers.ACCEPT).toString()));
 197     }
 198     if (exchange.getIn().getHeader("Content-Type") != null) {
 199       headers.put("Content-Type",
 200           Arrays.asList(exchange.getIn().getHeader("Content-Type").toString()));
 201     }
 202
 203     return headers;
 204   }
 205
 206
 207   /**
 208    * This helper method converts an HTTP response code into the associated string.
 209    *
 210    * @param result - A result object to get the response code from.
 211    *
 212    * @return - The string message associated with the supplied response code.
 213    */
 214   private String responseStatusStringFromResult(OperationResult result) {
 215
 216     // Not every valid response code is actually represented by the Response.Status
 217     // object, so we need to guard against missing codes, otherwise we throw null
 218     // pointer exceptions when we try to generate our metrics logs...
 219     Response.Status responseStatus = Response.Status.fromStatusCode(result.getResultCode());
 220     String responseStatusCodeString = "";
 221     if (responseStatus != null) {
 222       responseStatusCodeString = responseStatus.toString();
 223     }
 224
 225     return responseStatusCodeString;
 226   }
 227
 228   /**
 229    * Instantiate the REST client that will be used for sending our HTTP requests.
 230    *
 231    * @return - An instance of the REST client.
 232    */
 233   private RestClient getRestClient() {
 234
 235     if (restClient == null) {
 236
 237       String keystoreFilename = endpoint.getEcompKeystore();
 238       String keystorePassword = endpoint.getEcompKeystorePassword();
 239       String clientCertFilename = endpoint.getEcompClientCert();
 240
 241       if (logger.isDebugEnabled()) {
 242         logger.debug("Instantiating REST Client with client_cert=" + clientCertFilename
 243             + " keystore=" + keystoreFilename + " keystorePassword=" + keystorePassword);
 244       }
 245
 246       // Create REST client for search service
 247       restClient = new RestClient().validateServerHostname(false).validateServerCertChain(true)
 248           .clientCertFile(clientCertFilename)
 249           .clientCertPassword(Password.deobfuscate(keystorePassword)).trustStore(keystoreFilename);
 250     }
 251
 252     return restClient;
 253   }
 254 }