ai.heavy.jdbc.HeavyAIConnection.Connection_properties Class Reference

Inheritance diagram for ai.heavy.jdbc.HeavyAIConnection.Connection_properties:

Collaboration diagram for ai.heavy.jdbc.HeavyAIConnection.Connection_properties:

Public Member Functions
	Connection_properties (String connection_url, Properties baseProperties) throws SQLException

Package Functions
boolean	isHttpProtocol ()
boolean	isHttpsProtocol_insecure ()
boolean	isHttpsProtocol ()
boolean	isBinary ()
boolean	isBinary_tls ()
boolean	containsTrustStore ()

Private Member Functions
String	extract_and_remove_query_components (String connection_url, Properties query_props) throws SQLException
void	validate_params () throws SQLException

Detailed Description

Definition at line 144 of file HeavyAIConnection.java.

Constructor & Destructor Documentation

ai.heavy.jdbc.HeavyAIConnection.Connection_properties.Connection_properties ( String  connection_url, Properties  baseProperties  ) throws SQLException

inline

Definition at line 201 of file HeavyAIConnection.java.

References ai.heavy.jdbc.HeavyAIConnection.Connection_properties.extract_and_remove_query_components(), ai.heavy.jdbc.Options.option_order, and ai.heavy.jdbc.HeavyAIConnection.Connection_properties.validate_params().

                                {
      connection_url = extract_and_remove_query_components(connection_url, this);
      String[] url_values = connection_url.split(":");
      // add 2 for the default jdbc:heavy.ai at the start of the url.
      if (url_values.length > Options.option_order.length + 2) {
        // would be nice to print the url at this stage, but the user may have added
        // their
        // password into the list.
        throw new SQLException("Invalid number of arguments provided in url ["
                + url_values.length + "]. Maximum allowed ["
                + (Options.option_order.length + 2) + "]");
      }
      for (int i = 2; i < url_values.length; i++) {
        // the offest of 2 is caused by the 2 lables 'jdbc:heavyai' at the start if the
        // URL
        String existingValue = getProperty(Options.option_order[i - 2]);
        if (existingValue != null && !existingValue.equals((url_values[i]))) {
          logger.warn("Connection property [" + Options.option_order[i - 2]
                  + "] has been provided with different values in the URL and query component of the url. Defaulting to the URL value");
        }
        setProperty(Options.option_order[i - 2], url_values[i]);
      }

      for (String key : baseProperties.stringPropertyNames()) {
        String existingValue = getProperty(key);
        if (existingValue != null
                && !existingValue.equals(baseProperties.getProperty(key))) {
          logger.warn("Connection property " + key
                  + "] has been provided with different values in the properties object and the url. Defaulting to the URL value");
        } else {
          setProperty(key, baseProperties.getProperty(key));
        }
      }

      validate_params();
    }

Here is the call graph for this function:

Member Function Documentation

boolean ai.heavy.jdbc.HeavyAIConnection.Connection_properties.containsTrustStore ( )

inlinepackage

Definition at line 325 of file HeavyAIConnection.java.

References ai.heavy.jdbc.Options.server_trust_store.

                                 {
      return this.containsKey(Options.server_trust_store);
    }

String ai.heavy.jdbc.HeavyAIConnection.Connection_properties.extract_and_remove_query_components ( String  connection_url, Properties  query_props  ) throws SQLException

inlineprivate

Definition at line 172 of file HeavyAIConnection.java.

Referenced by ai.heavy.jdbc.HeavyAIConnection.Connection_properties.Connection_properties().

                                                                               {
      // The heavy.ai version of the connection_url is a ':' separated list
      // with an optional 'query component' at the end (see example above).
      // The query component starts with the first '?' in the string.
      // Its is made up of key=value pairs separated by the '&' character.
      //
      // The query component is terminated by the end of the string and is
      // assumed to be at the end of the URL

      String[] url_components = connection_url.split("\\?");
      if (url_components.length == 2) {
        // Query component are separated by an '&' - replace each with a '\n'
        // will allow Properties.load method to build a properties obj
        StringReader reader = new StringReader(url_components[1].replace('&', '\n'));
        try {
          query_props.load(reader);
        } catch (IOException iex) {
          throw new SQLException(iex.toString());
        }
      } else if (url_components.length > 2) {
        throw new SQLException(
                "Invalid connection string. Multiple query components included ["
                + connection_url + "]");
      }
      // return the url with out any query component
      return url_components[0];
    }

Here is the caller graph for this function:

boolean ai.heavy.jdbc.HeavyAIConnection.Connection_properties.isBinary ( )

inlinepackage

Definition at line 315 of file HeavyAIConnection.java.

References ai.heavy.jdbc.Options.protocol.

Referenced by ai.heavy.jdbc.HeavyAIConnection.manageConnection().

                       {
      return (this.containsKey(Options.protocol)
              && this.getProperty(Options.protocol).equals("binary"));
    }

Here is the caller graph for this function:

boolean ai.heavy.jdbc.HeavyAIConnection.Connection_properties.isBinary_tls ( )

inlinepackage

Definition at line 320 of file HeavyAIConnection.java.

References ai.heavy.jdbc.Options.protocol.

Referenced by ai.heavy.jdbc.HeavyAIConnection.manageConnection().

                           {
      return (this.containsKey(Options.protocol)
              && this.getProperty(Options.protocol).equals("binary_tls"));
    }

Here is the caller graph for this function:

boolean ai.heavy.jdbc.HeavyAIConnection.Connection_properties.isHttpProtocol ( )

inlinepackage

Definition at line 300 of file HeavyAIConnection.java.

References ai.heavy.jdbc.Options.protocol.

Referenced by ai.heavy.jdbc.HeavyAIConnection.manageConnection().

                             {
      return (this.containsKey(Options.protocol)
              && this.getProperty(Options.protocol).equals("http"));
    }

Here is the caller graph for this function:

boolean ai.heavy.jdbc.HeavyAIConnection.Connection_properties.isHttpsProtocol ( )

inlinepackage

Definition at line 310 of file HeavyAIConnection.java.

References ai.heavy.jdbc.Options.protocol.

Referenced by ai.heavy.jdbc.HeavyAIConnection.manageConnection().

                              {
      return (this.containsKey(Options.protocol)
              && this.getProperty(Options.protocol).equals("https"));
    }

Here is the caller graph for this function:

boolean ai.heavy.jdbc.HeavyAIConnection.Connection_properties.isHttpsProtocol_insecure ( )

inlinepackage

Definition at line 305 of file HeavyAIConnection.java.

References ai.heavy.jdbc.Options.protocol.

                                       {
      return (this.containsKey(Options.protocol)
              && this.getProperty(Options.protocol).equals("https_insecure"));
    }

void ai.heavy.jdbc.HeavyAIConnection.Connection_properties.validate_params ( ) throws SQLException

inlineprivate

Definition at line 239 of file HeavyAIConnection.java.

References ai.heavy.jdbc.Options.host_name, ai.heavy.jdbc.Options.max_rows, ai.heavy.jdbc.Options.option_order, ai.heavy.jdbc.Options.password, ai.heavy.jdbc.Options.port_num, ai.heavy.jdbc.Options.protocol, ai.heavy.jdbc.HeavyAIConnection.protocol_set, ai.heavy.jdbc.Options.server_trust_store, ai.heavy.jdbc.Options.server_trust_store_pwd, and ai.heavy.jdbc.Options.user.

Referenced by ai.heavy.jdbc.HeavyAIConnection.Connection_properties.Connection_properties().

                                                       {
      // Warn if config values with invalid keys have been used.
      for (String key : this.stringPropertyNames()) {
        if (key != Options.user && key != Options.password
                && !Arrays.asList(Options.option_order).contains(key)) {
          logger.warn("Unsupported configuration key" + key + " used.");
        }
      }
      // if present remove "//" from front of hostname
      if (containsKey(Options.host_name)) {
        String hN = this.getProperty(Options.host_name);
        if (hN.startsWith("//")) {
          this.setProperty(Options.host_name, hN.substring(2));
        }
      }

      // Default to binary if no protocol specified
      String protocol = "binary";
      if (this.containsKey(Options.protocol)) {
        protocol = this.getProperty(Options.protocol);
        protocol.toLowerCase();
        if (!protocol_set.contains(protocol)) {
          logger.warn("Incorrect protcol [" + protocol
                  + "] supplied. Possible values are [" + protocol_set.toString()
                  + "]. Using binary as default");
          protocol = "binary";
        }
      }
      this.setProperty(Options.protocol, protocol);

      if (this.containsKey(Options.port_num)) {
        try {
          Integer.parseInt(getProperty(Options.port_num));
        } catch (NumberFormatException nfe) {
          throw new SQLException(
                  "Invalid port number supplied" + getProperty(Options.port_num));
        }
      }

      if (this.containsKey(Options.server_trust_store)
              && !this.containsKey(Options.server_trust_store_pwd)) {
        logger.warn("server trust store ["
                + (String) this.getProperty(Options.server_trust_store)
                + " specfied without a password");
      }
      if (this.containsKey(Options.server_trust_store_pwd)
              && !this.containsKey(Options.server_trust_store)) {
        logger.warn("server trust store password specified without a keystore file");
      }
      if (!this.containsKey(Options.max_rows)) {
        this.setProperty(Options.max_rows, "100000");
      } else {
        try {
          Integer.parseInt(getProperty(Options.max_rows));
        } catch (NumberFormatException nfe) {
          throw new SQLException(
                  "Invalid value supplied for max rows " + getProperty(Options.max_rows));
        }
      }
    }

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• /home/jenkins-slave/workspace/core-os-doxygen/java/heavyaijdbc/src/main/java/ai/heavy/jdbc/HeavyAIConnection.java