trait DataClientApi extends AnyRef

Abstract trait for DataClient.

This type can be used by applications that want to mock DataClient in unit tests by passing parameters of type DataClientApi instead of accessing the DataClient singleton directly everywhere. For example:

// Get the DataClientApi passed to functions instead of them accessing the DataClient singleton.
def logicToTest(dataClient: DataClientApi, ...) = ???

object Application {
   // The application instantiates the real DataClient.
   val dataClient: DataClientApi = DataClient()
   logicToTest(dataClient, ...)
}

object Test {
   // Tests generate a mock or a stub from the trait.
   val dataClientStub: DataClientApi = stub[DataClientApi]
   logicToTest(dataClientStub, ...)
}
Linear Supertypes
AnyRef, Any
Known Subclasses
DataClientExt
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DataClientApi
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def adminApi(settings: Settings = defaultSettings): AdminApi

    Create a catalog and configuration administration API object

    Create a catalog and configuration administration API object

    settings

    setting to be used while using admin API

    returns

    catalog admin API

  2. abstract val defaultSettings: Settings

    Default setting which will be used if no overrides is provided

  3. abstract def invalidateCache(hrn: HRN): Unit

    Invalidate internal caches for catalog

    Invalidate internal caches for catalog

    hrn

    catalog identifier

  4. abstract def publishApi(hrn: HRN, settings: Settings = defaultSettings): PublishApi

    Create a catalog publish API object

    Create a catalog publish API object

    hrn

    catalog identifier

    settings

    setting to be used while using publish API

    returns

    catalog publish API if catalog exists, return error if catalog does not exists

  5. abstract def queryApi(hrn: HRN, settings: Settings = defaultSettings): QueryApi

    Create a catalog query API object

    Create a catalog query API object

    hrn

    catalog identifier

    settings

    setting to be used while using query API

    returns

    catalog query API if catalog exists, return error if catalog does not exists

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

Inherited from AnyRef

Inherited from Any

Ungrouped