/*
 * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
 * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
 *
 * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European
 * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in
 * compliance with the Licence. You may obtain a copy of the Licence at:
 * https://joinup.ec.europa.eu/news/understanding-eupl-v12
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the Licence
 * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the Licence for the specific language governing permissions and limitations under
 * the Licence.
 *
 * This product combines work with different licenses. See the "NOTICE" text file for details on the
 * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
 * works that you distribute must include a readable copy of the "NOTICE" text file.
*/

package at.gv.egiz.eaaf.core.impl.utils;

import java.util.UUID;

import at.gv.egiz.eaaf.core.api.IRequest;

/**
 * Transaction Identifier Utils.
 *
 * @author tlenz
 *
 */
public class TransactionIdUtils {

  /**
   * To correlate technical logs over one single transactions.
   */
  public static final String MDC_TRANSACTION_ID = "transactionId";

  /**
   * To correlate technical logs over a set of transactions, like SSO.
   */
  public static final String MDC_SESSION_ID = "sessionId";

  /**
   * Unique application identifier that is processed in this transaction.
   */
  public static final String MDC_SERVICEPROVIDER_ID = "oaId";

  /**
   * Unique application identifier that is processed in this transaction.
   */
  public static final String MDC_REMOTEHOST = "remoteHost";

  /**
   * Set all MDC variables from pending request to this threat context.<br>
   * These includes SessionID, TransactionID, and unique service-provider
   * identifier
   *
   * @param pendingRequest Http request object
   */
  public static void setAllLoggingVariables(final IRequest pendingRequest) {
    setTransactionId(pendingRequest.getUniqueTransactionIdentifier());
    setSessionId(pendingRequest.getUniqueSessionIdentifier());
    setServiceProviderId(pendingRequest.getServiceProviderConfiguration().getUniqueIdentifier());

  }

  /**
   * Remove all MDC variables from this threat context.
   *
   */
  public static void removeAllLoggingVariables() {
    removeSessionId();
    removeTransactionId();
    removeServiceProviderId();
    removeRemoteHost();

  }

  /**
   * Set unique service-provider identifier for Logging purposes.
   *
   * @param oaUniqueId Unique application Id
   */
  public static void setServiceProviderId(final String oaUniqueId) {
    org.slf4j.MDC.put(MDC_SERVICEPROVIDER_ID, oaUniqueId);

  }

  /**
   * Remove service-provider identifier for Logging.
   */
  public static void removeServiceProviderId() {
    org.slf4j.MDC.remove(MDC_SERVICEPROVIDER_ID);

  }

  /**
   * Get Id to correlate technical logs over one single transactions.
   *
   * @return Unique transaction Id
   */
  public static String getTransactionId() {
    return org.slf4j.MDC.get(MDC_TRANSACTION_ID);

  }

  /**
   * Set new random transactionId as an UUID.
   */
  public static void setTransactionId() {
    org.slf4j.MDC.put(MDC_TRANSACTION_ID, UUID.randomUUID().toString());

  }

  /**
   * Set Id to correlate technical logs over one single transactions.
   *
   * @param transactionId Unique transaction Id
   */
  public static void setTransactionId(final String transactionId) {
    org.slf4j.MDC.put(MDC_TRANSACTION_ID, transactionId);

  }

  /**
   * Remove transactionId for Logging.
   */
  public static void removeTransactionId() {
    org.slf4j.MDC.remove(MDC_TRANSACTION_ID);

  }

  /**
   * Set a new random SessionId as UUID.
   */
  public static void setSessionId() {
    org.slf4j.MDC.put(MDC_SESSION_ID, UUID.randomUUID().toString());

  }

  /**
   * Set Id to correlate technical logs over a set of transactions, like SSO.
   *
   * @param uniqueSessionId Unique Id
   */
  public static void setSessionId(final String uniqueSessionId) {
    org.slf4j.MDC.put(MDC_SESSION_ID, uniqueSessionId);

  }

  /**
   * Remove sessionId for Logging.
   *
   */
  public static void removeSessionId() {
    org.slf4j.MDC.remove(MDC_SESSION_ID);

  }

  /**
   * Set remoteHost information to correlate technical logs.
   *
   * @param remoteHost IP address of the remote host
   */
  public static void setRemoteHost(final String remoteHost) {
    org.slf4j.MDC.put(MDC_REMOTEHOST, remoteHost);

  }

  /**
   * Remove remoteHost for Logging.
   */
  public static void removeRemoteHost() {
    org.slf4j.MDC.remove(MDC_REMOTEHOST);

  }


}