Package org.gorpipe.spark.platform

Class GorTaskBase

java.lang.Object
org.gorpipe.spark.platform.GorTaskBase
All Implemented Interfaces:
java.lang.Runnable
public abstract class GorTaskBase
extends java.lang.Object
implements java.lang.Runnable

  • Constructor Summary

    Constructors 
    Modifier Constructor Description
    protected GorTaskBase​(java.lang.String jobId)  

  • Method Summary

    Modifier and Type Method Description
    GorClusterBase getCluster()  
    java.lang.String getJobId()
    Get job id
    protected java.lang.String getMessage​(java.lang.String message)  
    protected java.lang.String getProgressMessage​(java.lang.String state)  
    protected abstract java.lang.String getRequestId()  
    JobStatus getStatus()
    Get job status
    static java.lang.String getTaskName​(java.lang.Class<? extends GorTaskBase> taskClass)
    Get short name for task class.
    protected boolean hasLock()  
    boolean isCancelled()
    Check if job has been cancelled
    protected boolean lock​(java.lang.String key, long timeoutMs)
    Get exclusive cluster-wide lock
    protected void logDebug​(java.lang.String message)  
    protected void logError​(java.lang.String message, java.lang.Throwable ex)  
    protected void logInfo​(java.lang.String message, java.lang.Throwable ex)  
    protected void logProgress​(java.lang.String progress)  
    protected void logWarn​(java.lang.String message, java.lang.Throwable ex)  
    protected abstract java.lang.String perform()
    Work method.
    void run()  
    void setCluster​(GorClusterBase cluster)  
    protected void setError​(java.lang.String error)  
    protected void setProgress​(java.lang.String progress)  
    protected void setResult​(java.lang.String result)  
    protected void setStatus​(JobStatus status)  
    protected void unlock()
    Release lock

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • GorTaskBase

      protected GorTaskBase​(java.lang.String jobId)

  • Method Details

    • perform

      protected abstract java.lang.String perform() throws java.lang.Exception
      Work method. Should return normally if successful. Should raise error if not. Can either return or raise if cancelled.
      Returns:
      result or null if no result
      Throws:
      java.lang.Exception - on error

    • getJobId

      public java.lang.String getJobId()
      Get job id
      Returns:
      Job id

    • getRequestId

      protected abstract java.lang.String getRequestId()

    • setProgress

      protected void setProgress​(java.lang.String progress)

    • setResult

      protected void setResult​(java.lang.String result)

    • setStatus

      protected void setStatus​(JobStatus status)

    • setError

      protected void setError​(java.lang.String error)

    • setCluster

      public void setCluster​(GorClusterBase cluster)

    • getCluster

      public GorClusterBase getCluster()

    • getStatus

      public JobStatus getStatus()
      Get job status
      Returns:
      Status

    • lock

      protected boolean lock​(java.lang.String key, long timeoutMs) throws java.lang.InterruptedException
      Get exclusive cluster-wide lock
      Parameters:
      key - Key to lock
      timeoutMs - Timeout in ms waiting for lock
      Returns:
      true if lock was acquired
      Throws:
      java.lang.InterruptedException

    • unlock

      protected void unlock()
      Release lock

    • hasLock

      protected boolean hasLock()

    • logInfo

      protected void logInfo​(java.lang.String message, java.lang.Throwable ex)

    • logDebug

      protected void logDebug​(java.lang.String message)

    • logWarn

      protected void logWarn​(java.lang.String message, java.lang.Throwable ex)

    • logError

      protected void logError​(java.lang.String message, java.lang.Throwable ex)

    • logProgress

      protected void logProgress​(java.lang.String progress)

    • getMessage

      protected java.lang.String getMessage​(java.lang.String message)

    • isCancelled

      public boolean isCancelled()
      Check if job has been cancelled
      Returns:
      true if canncelled

    • run

      public final void run()
      Specified by:
      run in interface java.lang.Runnable

    • getProgressMessage

      protected java.lang.String getProgressMessage​(java.lang.String state)

    • getTaskName

      public static java.lang.String getTaskName​(java.lang.Class<? extends GorTaskBase> taskClass)
      Get short name for task class.
      Parameters:
      taskClass - Class
      Returns:
      name without package