io.opentracing.contrib.jdbc.parser.OracleURLParser Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opentracing-jdbc Show documentation
OpenTracing Instrumentation for JDBC API
There is a newer version: 0.2.15
/*
 * Copyright 2017-2020 The OpenTracing Authors
 *
 * 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.
 */
package io.opentracing.contrib.jdbc.parser;

import io.opentracing.contrib.jdbc.ConnectionInfo;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class OracleURLParser implements ConnectionURLParser {
  public static final String DB_TYPE = "oracle";
  public static final String PREFIX = "jdbc:oracle:thin:";
  public static final int DEFAULT_PORT = 1521;
  private static Pattern EASY_CONNECT_PATTERN = Pattern.compile(
      "(?.*)@(//)?(?[^:/]+)(?:[0-9]+)?(?[:/][^:/]+)?(?:[^:/]+)?(?/[^:/]+)?");

  @Override
  public ConnectionInfo parse(final String url) {
    if (url != null && url.startsWith(PREFIX)) {
      OracleConnectionInfo connectionInfo = parseTnsName(url.substring(PREFIX.length()));
      if (connectionInfo == null) {
        connectionInfo = parseEasyConnect(url.substring(PREFIX.length()));
      }
      if (connectionInfo != null) {
        return new ConnectionInfo.Builder(connectionInfo.getDbPeer()) //
            .dbType(DB_TYPE) //
            .dbInstance(connectionInfo.getDbInstance()) //
            .build();
      }
    }
    return null;
  }

  private OracleConnectionInfo parseTnsName(final String url) {
    final String hosts = parseDatabaseHostsFromTnsUrl(url);
    if (hosts != null) {
      final int idxServiceName = url.indexOf("SERVICE_NAME");
      final int start = url.indexOf('=', idxServiceName) + 1;
      final int end = url.indexOf(")", start);
      final String serviceName = url.substring(start, end);
      return new OracleConnectionInfo() //
          .setDbPeer(hosts) //
          .setDbInstance(serviceName);
    }
    return null;
  }

  public static String parseDatabaseHostsFromTnsUrl(String url) {
    int beginIndex = url.indexOf("DESCRIPTION");
    if (beginIndex == -1) {
      return null;
    }
    List hosts = new ArrayList();
    do {
      int hostStartIndex = url.indexOf("HOST", beginIndex);
      if (hostStartIndex == -1) {
        break;
      }
      int equalStartIndex = url.indexOf("=", hostStartIndex);
      int hostEndIndex = url.indexOf(")", hostStartIndex);
      String host = url.substring(equalStartIndex + 1, hostEndIndex);

      int port = DEFAULT_PORT;
      int portStartIndex = url.indexOf("PORT", hostEndIndex);
      int portEndIndex = url.length();
      if (portStartIndex != -1) {
        int portEqualStartIndex = url.indexOf("=", portStartIndex);
        portEndIndex = url.indexOf(")", portEqualStartIndex);
        port = Integer.parseInt(url.substring(portEqualStartIndex + 1, portEndIndex).trim());
      }
      hosts.add(host.trim() + ":" + port);
      beginIndex = portEndIndex;
    } while (true);
    return join(",", hosts);
  }

  private static String join(String delimiter, List list) {
    if (list == null || list.isEmpty()) {
      return "";
    }
    StringBuilder builder = new StringBuilder();
    for (int i = 0, len = list.size(); i < len; i++) {
      if (i == (len - 1)) {
        builder.append(list.get(i));
      } else {
        builder.append(list.get(i)).append(delimiter);
      }
    }
    return builder.toString();
  }

  /**
   * Implementation according to https://www.oracle.com/technetwork/database/enterprise-edition/oraclenetservices-neteasyconnect-133058.pdf
   *
   * @param url the url without the oracle jdbc prefix
   * @return the oracle connection info if the url could be parsed, or null otherwise.
   */
  public static OracleConnectionInfo parseEasyConnect(final String url) {
    final Matcher matcher = EASY_CONNECT_PATTERN.matcher(url);
    if (matcher.matches()) {
      final OracleConnectionInfo result = new OracleConnectionInfo();
      final String host = matcher.group("host");
      final String portGroup = matcher.group("port");
      final int dbPort =
          portGroup != null ? Integer.parseInt(portGroup.substring(1)) : DEFAULT_PORT;
      result.setDbPeer(host + ":" + dbPort);
      final String service = matcher.group("service");
      if (service != null) {
        result.setDbInstance(service.substring(1));
      } else {
        result.setDbInstance(host);
      }
      return result;
    }
    return null;
  }

  public static class OracleConnectionInfo {
    private String dbInstance;
    private String dbPeer;

    public String getDbInstance() {
      return dbInstance;
    }

    public OracleConnectionInfo setDbInstance(final String dbInstance) {
      this.dbInstance = dbInstance;
      return this;
    }

    public String getDbPeer() {
      return dbPeer;
    }

    public OracleConnectionInfo setDbPeer(final String dbPeer) {
      this.dbPeer = dbPeer;
      return this;
    }
  }
}