services

ToolManagerPlugin

class ToolManagerPlugin extends Plugin

ToolManager plugin. This manages ToolInstances(), each describing a running tool/analysis environment/VM that was launched from Clowder. Supports launching, stopping, getting info of analysis environment sessions.

Linear Supertypes
Plugin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ToolManagerPlugin
  2. Plugin
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ToolManagerPlugin(application: Application)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def checkForInstanceURL(instanceID: UUID): String

    Return URL associated with instanceID if available, otherwise a blank string

    Return URL associated with instanceID if available, otherwise a blank string

    instanceID

    instanceID to check

    returns

    URL string or blank string depending on availability

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val collections: CollectionService

  10. val comments: CommentService

  11. val datasets: DatasetService

  12. def enabled: Boolean

    Definition Classes
    Plugin
  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  15. val files: FileService

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  18. def getInstances(): Map[String, String]

    Get a simple map of instanceID to instanceName

  19. def getInstancesWithDataset(datasetID: UUID): Map[UUID, ToolInstance]

    Get a subset of instanceMap with ToolInstances that have datasetID in history

    Get a subset of instanceMap with ToolInstances that have datasetID in history

    datasetID

    filter instanceMap to instances with this dataset attached

    returns

    map of instanceID to ToolInstance instance

  20. def getLaunchableTools(): JsObject

    Get list of valid endpoints for tool selection.

    Get list of valid endpoints for tool selection.

    returns

    list of tools that can be selected for launch

  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. var instanceMap: Map[UUID, ToolInstance]

  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def launchTool(hostURL: String, instanceName: String, toolPath: String, datasetId: UUID, datasetName: String, ownerId: Option[UUID]): UUID

    Send request to API to launch a new tool.

    Send request to API to launch a new tool.

    hostURL

    is url of API server

    instanceName

    user-provided name of Session to display

    toolPath

    name of environment type that is being launched

    datasetId

    clowder ID of dataset to attach

    returns

    ID of session that was launched

  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. def onStart(): Unit

    Definition Classes
    ToolManagerPlugin → Plugin
  29. def onStop(): Unit

    Definition Classes
    ToolManagerPlugin → Plugin
  30. def refreshActiveInstanceListFromServer(): Unit

    Update instanceMap with server-side list, in case Plugin has been stopped

  31. def refreshLaunchableToolsFromServer(): Unit

    Update toolList from server to get list of eligible API endpoints to launch tools from.

  32. def removeInstance(toolPath: String, instanceID: UUID): Unit

    Terminate a running tool instance.

    Terminate a running tool instance.

    toolPath

    is the endpoint to issue DELETE request to

    instanceID

    ID of ToolInstance to stop

  33. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  34. def toString(): String

    Definition Classes
    AnyRef → Any
  35. var toolList: JsObject

  36. def uploadDatasetToInstance(hostURL: String, instanceID: UUID, datasetId: UUID, datasetName: String, userId: Option[UUID]): Unit

    Upload dataset files to an existing instance.

  37. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Plugin

Inherited from AnyRef

Inherited from Any

Ungrouped