Packages

trait ToolDataProvider[DataTypes] extends Closeable

An abstraction of a tool "report".

Most tool reports will either be a File, or an API endpoint that can be accessed somewhere. Some tool reports have "extra data" that is referenced by the main report that needs to be looked up via some separate mechanism. Some tool reports may be comprised of multiple files.

A tool reader generally will want to iterate the "primary entry points" of a report, and as it reads through the report data, it may need to look up some "supporting" information.

DataTypes

This type parameter represents the possible "extra data" records that may be requested. For example, Veracode has "Flow Data" that needs to be accessed separately.

Linear Supertypes
Closeable, AutoCloseable, AnyRef, Any
Known Subclasses
Reader, Writer
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ToolDataProvider
  2. Closeable
  3. AutoCloseable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def close(): Unit
    Definition Classes
    Closeable → AutoCloseable
    Annotations
    @throws( classOf[java.io.IOException] )
  2. abstract def get(dataType: DataTypes): Task[Option[ToolData]]

    Return a task that knows how to acquire a given entry, as specified by the dataType.

    Return a task that knows how to acquire a given entry, as specified by the dataType. For tools that don't support

  3. abstract def getPrimaryEntries: Iterant[Task, ContextedToolData]

    Return a stream of ToolDatas that represent the primary entry point(s) of a tool report.

    Return a stream of ToolDatas that represent the primary entry point(s) of a tool report. For tool readers, this will typically be a File, or an entry in a Zip File. For tool connectors, this will typically be the body of an HTTP response.

    returns

    A stream representing the possibly-multiple primary entry points of a tool report.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def closeT: Task[Unit]

    returns

    A task that, when run, will close this ToolDataProvider.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped