scala-api/src/main/scala/org/apache/livy/scalaapi/ScalaJobContext.scala

/*
 * 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.livy.scalaapi

import java.io.File

import org.apache.spark.SparkContext
import org.apache.spark.sql.SQLContext
import org.apache.spark.sql.hive.HiveContext
import org.apache.spark.streaming.StreamingContext

import org.apache.livy.JobContext

/**
 *  Holds runtime information about the job execution context.
 *
 *  @constructor Creates a ScalaJobContext.
 *  @param context the Java JobContext of Livy.
 */
class ScalaJobContext private[livy] (context: JobContext) {

  /** The shared SparkContext instance. */
  def sc: SparkContext = context.sc().sc

  /** The shared SQLContext instance. */
  def sqlctx: SQLContext = context.sqlctx()

  /** The shared HiveContext instance. */
  def hivectx: HiveContext = context.hivectx()

  /** Returns the StreamingContext which has already been created. */
  def streamingctx: StreamingContext = context.streamingctx().ssc

  def sparkSession[E]: E = context.sparkSession()

  /** Set shared object, it will replace the old one if already existed */
  def setSharedVariable[E](name: String, obj: E): Unit = context.setSharedObject(name, obj)

  /** Get shared object */
  def getSharedVariable[E](name: String): E = context.getSharedObject(name)

  /** Remove shared object from cache */
  def removeSharedVariable[E](name: String): E = context.removeSharedObject(name)

  /**
   * Creates the SparkStreaming context.
   *
   * @param batchDuration  Time interval at which streaming data will be divided into batches,
   *                       in milliseconds.
   */
  def createStreamingContext(batchDuration: Long): Unit =
    context.createStreamingContext(batchDuration)

  /** Stops the SparkStreaming context. */
  def stopStreamingContext(): Unit = context.stopStreamingCtx()

  /**
   * Returns a local tmp dir specific to the context.
   */
  def localTmpDir: File = context.getLocalTmpDir

}