io.smartdatalake.workflow.connection.SplunkConnection.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sdl-splunk_2.12 Show documentation
The newest version!
/*
 * Smart Data Lake - Build your data lake the smart way.
 *
 * Copyright © 2019-2020 ELCA Informatique SA ()
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package io.smartdatalake.workflow.connection

import com.splunk.{SSLSecurityProtocol, Service, ServiceArgs}
import com.typesafe.config.Config
import io.smartdatalake.config.SdlConfigObject.ConnectionId
import io.smartdatalake.config.{FromConfigFactory, InstanceRegistry}
import io.smartdatalake.workflow.connection.authMode.{AuthMode, BasicAuthMode, TokenAuthMode}

/**
 * Connection information for splunk queries
 *
 * @param id unique id of this connection
 * @param host
 * @param port
 * @param authMode
 * @param metadata
 */
case class SplunkConnection( override val id: ConnectionId,
                             host: String,
                             port: Int,
                             authMode: AuthMode,
                             override val metadata: Option[ConnectionMetadata] = None
                           ) extends Connection with SplunkConnectionService {

 // Allow only supported authentication modes
 private val supportedAuths = Seq(classOf[BasicAuthMode], classOf[TokenAuthMode])
 require(supportedAuths.contains(authMode.getClass), s"${authMode.getClass.getSimpleName} not supported by ${this.getClass.getSimpleName}. Supported auth modes are ${supportedAuths.map(_.getSimpleName).mkString(", ")}.")

  override def connectToSplunk: Service = {

    val connectionArgs = new ServiceArgs

    connectionArgs.setHost(host)
    connectionArgs.setPort(port)
    connectionArgs.setSSLSecurityProtocol(SSLSecurityProtocol.TLSv1_2)

    authMode match {
      case m: TokenAuthMode =>
        connectionArgs.setToken(m.tokenSecret.resolve())
      case m: BasicAuthMode =>
        connectionArgs.setUsername(m.userSecret.resolve())
        connectionArgs.setPassword(m.passwordSecret.resolve())
      case _ =>
        throw new IllegalArgumentException(s"${authMode.getClass.getSimpleName} not supported.")
    }

    Service.connect(connectionArgs)

  }

  def test(): Unit = {
    connectToSplunk.logout()
  }

  override def factory: FromConfigFactory[Connection] = SplunkConnection
}

trait SplunkConnectionService {
  def connectToSplunk: Service
}

object SplunkConnection extends FromConfigFactory[Connection] {
  override def fromConfig(config: Config)(implicit instanceRegistry: InstanceRegistry): SplunkConnection = {
    extract[SplunkConnection](config)
  }
}