onap-enabler/onap-enabler-be/src/main/java/org/onap/osam/aai/util/AAIRestInterface.java

/*-
 * ============LICENSE_START=======================================================
 * OSAM
 * ================================================================================
 * Copyright (C) 2018 AT&T
 * ================================================================================
 * 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.osam.aai.util;


import com.att.eelf.configuration.EELFLogger;
import org.apache.commons.lang3.exception.ExceptionUtils;
import org.onap.portalsdk.core.logging.logic.EELFLoggerDelegate;
import org.onap.osam.aai.ExceptionWithRequestInfo;
import org.onap.osam.aai.ResponseWithRequestInfo;
import org.onap.osam.aai.exceptions.InvalidPropertyException;
import org.onap.osam.utils.Logging;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpMethod;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.Entity;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.Optional;
import java.util.UUID;

import static org.apache.commons.lang3.ObjectUtils.defaultIfNull;
import static org.onap.osam.utils.Logging.REQUEST_ID_HEADER_KEY;


public class AAIRestInterface {

	protected EELFLoggerDelegate logger = EELFLoggerDelegate.getLogger(AAIRestInterface.class);

	protected final EELFLogger outgoingRequestsLogger = Logging.getRequestsLogger("aai");


	/** The client. */
	private Client client = null;

	/** The rest srvr base URL. */
	private String restSrvrBaseURL;

	@Autowired
	protected HttpsAuthClient httpsAuthClientFactory;
	private final ServletRequestHelper servletRequestHelper;
	private final SystemPropertyHelper systemPropertyHelper;

	protected static final String START_STRING = " start";
	protected static final String TRANSACTION_ID_HEADER = "X-TransactionId";
	protected static final String FROM_APP_ID_HEADER = "X-FromAppId";
	protected static final String SUCCESSFUL_API_MESSAGE = " REST api call was successful!";
	protected static final String URL_DECLARATION = ", url=";

	public AAIRestInterface(HttpsAuthClient httpsAuthClientFactory, ServletRequestHelper servletRequestHelper, SystemPropertyHelper systemPropertyHelper) {
		this.httpsAuthClientFactory = httpsAuthClientFactory;
		this.servletRequestHelper = servletRequestHelper;
		this.systemPropertyHelper = systemPropertyHelper;
		initRestClient();
	}

	/**
	 * For testing purpose
	 */
	AAIRestInterface(Optional<Client> client,
					 HttpsAuthClient httpsAuthClientFactory, ServletRequestHelper servletRequestHelper, SystemPropertyHelper systemPropertyHelper){
		this.httpsAuthClientFactory = httpsAuthClientFactory;
		this.servletRequestHelper = servletRequestHelper;
		this.systemPropertyHelper = systemPropertyHelper;
		if (client != null && client.isPresent()){
			this.client = client.get();
		}

	}

	/**
	 * Encode URL.
	 *
	 * @param nodeKey the node key
	 * @return the string
	 * @throws UnsupportedEncodingException the unsupported encoding exception
	 */
	public String encodeURL (String nodeKey) throws UnsupportedEncodingException {
		return URLEncoder.encode(nodeKey, "UTF-8").replaceAll("\\+", "%20");
	}

    private void initRestClient() {
        initRestClient(false);
    }


	private void initRestClient(boolean propagateExceptions) {
		if (client == null) {
			try {
				client = httpsAuthClientFactory.getClient(HttpClientMode.WITH_KEYSTORE);
			} catch (Exception e) {
				logger.info(EELFLoggerDelegate.errorLogger, "Exception in REST call to DB in initRestClient" + e.toString());
				logger.debug(EELFLoggerDelegate.debugLogger, "Exception in REST call to DB : " + e.toString());
				if (propagateExceptions) {
					ExceptionUtils.rethrow(e);
				}
			}
		}
	}



	/**
	 * Sets the rest srvr base URL.
	 *
	 * @param baseURL the base URL
	 */
	public void SetRestSrvrBaseURL(String baseURL)
	{
		if (baseURL == null) {
			logger.info(EELFLoggerDelegate.errorLogger, "REST Server base URL cannot be null.");
			logger.debug(EELFLoggerDelegate.debugLogger, "REST Server base URL cannot be null.");
		}

		restSrvrBaseURL = baseURL;
	}

	/**
	 * Gets the rest srvr base URL.
	 *
	 * @return the rest srvr base URL
	 */
	public String getRestSrvrBaseURL() {
		return restSrvrBaseURL;
	}


	/**
	 * Rest get.
	 *
	 * @param fromAppId the from app id
	 * @param transId the trans id
	 * @param requestUri the request uri
	 * @param xml the xml
	 * @return the string
	 */
	public ResponseWithRequestInfo RestGet(String fromAppId, String transId, String requestUri, boolean xml) {
		return RestGet(fromAppId, transId, requestUri, xml, false);
	}

	public ResponseWithRequestInfo RestGet(String fromAppId, String transId, String requestUri, boolean xml, boolean propagateExceptions) {
        String methodName = "RestGet";
		String url = systemPropertyHelper.getFullServicePath(requestUri);
		try {
			initRestClient(propagateExceptions);

			logger.debug(EELFLoggerDelegate.debugLogger, methodName + START_STRING);
			logger.debug(EELFLoggerDelegate.debugLogger, url + " for the get REST API");

			Logging.logRequest(outgoingRequestsLogger, HttpMethod.GET, url);

			final Response response;
            Invocation.Builder requestBuilder = client.target(url)
                    .request()
                    .accept(xml ? MediaType.APPLICATION_XML : MediaType.APPLICATION_JSON)
                    .header(TRANSACTION_ID_HEADER, transId)
                    .header(FROM_APP_ID_HEADER, fromAppId)
                    .header("Content-Type", MediaType.APPLICATION_JSON)
                    .header(REQUEST_ID_HEADER_KEY, extractOrGenerateRequestId());
            response = systemPropertyHelper.isClientCertEnabled() ?
                    requestBuilder.get() : authenticateRequest(requestBuilder).get();
			Logging.logResponse(outgoingRequestsLogger, HttpMethod.GET, url, response);

			if (response.getStatusInfo().equals(Response.Status.OK)) {
				logger.debug(EELFLoggerDelegate.debugLogger, methodName + SUCCESSFUL_API_MESSAGE);
				logger.info(EELFLoggerDelegate.errorLogger, methodName + SUCCESSFUL_API_MESSAGE);
			} else {
				logger.debug(EELFLoggerDelegate.debugLogger, getInvalidResponseLogMessage(url, methodName, response));
			}
			return new ResponseWithRequestInfo(response, url, HttpMethod.GET);
		} catch (Exception e) {
			logger.debug(EELFLoggerDelegate.debugLogger, getFailedResponseLogMessage(url, methodName, e));
			if (propagateExceptions) {
                throw new ExceptionWithRequestInfo(HttpMethod.GET, defaultIfNull(url, requestUri), e);
            } else {
                return new ResponseWithRequestInfo(null, url, HttpMethod.GET);
            }
		}
	}

	protected String extractOrGenerateRequestId() {
		return servletRequestHelper.extractOrGenerateRequestId();
	}


	/**
	 * Delete.
	 *
	 * @param sourceID the source ID
	 * @param transId the trans id
	 * @param path the path
	 * @return true, if successful
	 */
	public boolean Delete(String sourceID, String transId, String path) {
		String methodName = "Delete";
		transId += ":" + UUID.randomUUID().toString();
		logger.debug(methodName + START_STRING);
		Boolean response = false;
		String url = systemPropertyHelper.getFullServicePath(path);;
		try {

			initRestClient();
			Logging.logRequest(outgoingRequestsLogger, HttpMethod.DELETE, url);
			final Response cres = client.target(url)
					.request()
					.accept(MediaType.APPLICATION_JSON)
					.header(TRANSACTION_ID_HEADER, transId)
					.header(FROM_APP_ID_HEADER, sourceID)
					.header(REQUEST_ID_HEADER_KEY, extractOrGenerateRequestId())
					.delete();
			Logging.logResponse(outgoingRequestsLogger, HttpMethod.DELETE, url, cres);
			if (cres.getStatusInfo().equals(Response.Status.NOT_FOUND)) {
				logger.debug(EELFLoggerDelegate.debugLogger, "Resource does not exist...: " + cres.getStatus()
						+ ":" + cres.readEntity(String.class));
				response = false;
			} else if (cres.getStatusInfo().equals(Response.Status.OK) || cres.getStatusInfo().equals(Response.Status.NO_CONTENT)) {
				logger.debug(EELFLoggerDelegate.debugLogger, "Resource " + url + " deleted");
				logger.info(EELFLoggerDelegate.errorLogger, "Resource " + url + " deleted");
				response = true;
			} else {
				logger.debug(EELFLoggerDelegate.debugLogger, "Deleting Resource failed: " + cres.getStatus()
						+ ":" + cres.readEntity(String.class));
				response = false;
			}

		} catch (Exception e) {
			logger.debug(EELFLoggerDelegate.debugLogger, getFailedResponseLogMessage(url, methodName, e));
		}
		return response;
	}


	/**
	 * Rest put.
	 *
	 * @param fromAppId the from app id
	 * @param path the path
	 * @param payload the payload
	 * @param xml the xml
	 * @return the string
	 */
	public Response RestPut(String fromAppId, String path, String payload, boolean xml) {
		String methodName = "RestPut";
		String url=systemPropertyHelper.getFullServicePath(path);
		String transId = UUID.randomUUID().toString();
		logger.debug(EELFLoggerDelegate.debugLogger, methodName + START_STRING);

        Response response = null;
		try {
			initRestClient();
			Logging.logRequest(outgoingRequestsLogger, HttpMethod.PUT, url, payload);
			response = authenticateRequest(client.target(url)
					.request()
                    .accept(xml ? MediaType.APPLICATION_XML : MediaType.APPLICATION_JSON)
					.header(TRANSACTION_ID_HEADER, transId)
					.header(FROM_APP_ID_HEADER,  fromAppId))
					.header(REQUEST_ID_HEADER_KEY, extractOrGenerateRequestId())
					.put(Entity.entity(payload, MediaType.APPLICATION_JSON));
			Logging.logResponse(outgoingRequestsLogger, HttpMethod.PUT, url, response);

			if (response.getStatusInfo().getFamily().equals(Response.Status.Family.SUCCESSFUL)) {
				logger.info(EELFLoggerDelegate.errorLogger, getValidResponseLogMessage(methodName));
				logger.debug(EELFLoggerDelegate.debugLogger, getValidResponseLogMessage(methodName));
			} else {
				logger.debug(EELFLoggerDelegate.debugLogger, getInvalidResponseLogMessage(url, methodName, response));
			}
		} catch (Exception e) {
			logger.debug(EELFLoggerDelegate.debugLogger, getFailedResponseLogMessage(url, methodName, e));
		}
		return response;
	}



	/**
	 * Rest post.
	 *
	 * @param fromAppId the from app id
	 * @param path the path
	 * @param payload the payload
	 * @param xml the xml
	 * @return the string
	 */
	public Response RestPost(String fromAppId, String path, String payload, boolean xml) {
		String methodName = "RestPost";
		String url=systemPropertyHelper.getServiceBasePath(path);
		String transId = UUID.randomUUID().toString();
		logger.debug(EELFLoggerDelegate.debugLogger, methodName + START_STRING);

        Response response = null;
		try {
			initRestClient();
			Logging.logRequest(outgoingRequestsLogger, HttpMethod.POST, url, payload);
			response = authenticateRequest(client.target(systemPropertyHelper.getServiceBasePath(path))
					.request()
                    .accept(xml ? MediaType.APPLICATION_XML : MediaType.APPLICATION_JSON)
					.header(TRANSACTION_ID_HEADER, transId)
					.header(FROM_APP_ID_HEADER,  fromAppId))
					.header(REQUEST_ID_HEADER_KEY, extractOrGenerateRequestId())
					.post(Entity.entity(payload, MediaType.APPLICATION_JSON));
			Logging.logResponse(outgoingRequestsLogger, HttpMethod.POST, url, response);

			if (response.getStatusInfo().getFamily().equals(Response.Status.Family.SUCCESSFUL)) {
				logger.info(EELFLoggerDelegate.errorLogger, getValidResponseLogMessage(methodName));
				logger.debug(EELFLoggerDelegate.debugLogger, getValidResponseLogMessage(methodName));
			} else {
				logger.debug(EELFLoggerDelegate.debugLogger, getInvalidResponseLogMessage(url, methodName, response));
			}
		} catch (Exception e) {
			logger.debug(EELFLoggerDelegate.debugLogger, getFailedResponseLogMessage(url, methodName, e));
		}
		return response;
	}

	protected String getFailedResponseLogMessage(String path, String methodName, Exception e) {
		return methodName + URL_DECLARATION + path + ", Exception: " + e.toString();
	}

	protected String getValidResponseLogMessage(String methodName) {
		return methodName + URL_DECLARATION;
	}

	protected String getInvalidResponseLogMessage(String path, String methodName, Response cres) {
		return methodName + " with status=" + cres.getStatus() + URL_DECLARATION + path;
	}

	private Invocation.Builder authenticateRequest(Invocation.Builder requestBuilder) throws InvalidPropertyException, UnsupportedEncodingException {
		return requestBuilder
				.header("Authorization", "Basic " + systemPropertyHelper.getEncodedCredentials());
	}

}