contrib/storage-splunk/src/main/java/org/apache/drill/exec/store/splunk/SplunkConnection.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.drill.exec.store.splunk;

import com.splunk.ConfCollection;
import com.splunk.EntityCollection;
import com.splunk.HttpService;
import com.splunk.Index;
import com.splunk.SSLSecurityProtocol;
import com.splunk.Service;
import com.splunk.ServiceArgs;
import org.apache.drill.common.exceptions.UserException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class wraps the functionality of the Splunk connection for Drill.
 */
public class SplunkConnection {

  private static final Logger logger = LoggerFactory.getLogger(SplunkConnection.class);

  private final String username;
  private final String password;
  private final String hostname;
  private final int port;
  private Service service;

  public SplunkConnection(SplunkPluginConfig config) {
    this.username = config.getUsername();
    this.password = config.getPassword();
    this.hostname = config.getHostname();
    this.port = config.getPort();
    service = connect();
    ConfCollection confs = service.getConfs();
  }

  /**
   * This constructor is used for testing only
   * @param config
   * @param service
   */
  public SplunkConnection(SplunkPluginConfig config, Service service) {
    this.username = config.getUsername();
    this.password = config.getPassword();
    this.hostname = config.getHostname();
    this.port = config.getPort();
    this.service = service;
  }

  /**
   * Connects to Splunk instance
   * @return an active Splunk connection.
   */
  public Service connect() {
    HttpService.setSslSecurityProtocol(SSLSecurityProtocol.TLSv1_2);
    ServiceArgs loginArgs = new ServiceArgs();
    loginArgs.setHost(hostname);
    loginArgs.setPort(port);
    loginArgs.setPassword(password);
    loginArgs.setUsername(username);

    try {
      service = Service.connect(loginArgs);
    } catch (Exception e) {
      throw UserException
        .connectionError()
        .message("Unable to connect to Splunk at %s:%s", hostname, port)
        .addContext(e.getMessage())
        .build(logger);
    }
    logger.debug("Successfully connected to {} on port {}", hostname, port);
    return service;
  }

  /**
   * Gets the available indexes from Splunk. Drill treats these as a table.
   * @return A collection of Splunk indexes
   */
  public EntityCollection<Index> getIndexes() {
    return service.getIndexes();
  }
}