com.m3.octoparts.ws

OctoClientLike

trait OctoClientLike extends AnyRef

Octoparts client interface based on WS.

Useful if you want to customise certain phases of building a WS request (e.g. logging, hooks)

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

Abstract Value Members

  1. abstract def baseUrl: String

    Base URL for Octoparts

  2. abstract def rescueAggregateResponse: AggregateResponse

    Defines the AggregateResponse rescue return value

    Defines the AggregateResponse rescue return value

    Attributes
    protected
  3. abstract def rescueHttpPartConfigs: Seq[HttpPartConfig]

    Defines the SeqHttpPartConfig rescue return value

    Defines the SeqHttpPartConfig rescue return value

    Attributes
    protected
  4. abstract def rescuer[A](defaultReturn: ⇒ A): PartialFunction[Throwable, A]

    PartialFunction for recovering from errors when hitting Octoparts

    PartialFunction for recovering from errors when hitting Octoparts

    Attributes
    protected
  5. abstract def wsHolderFor(url: String): WSRequestHolder

    Returns a play.api.libs.ws.WSRequestHolder for a given a URL string

    Returns a play.api.libs.ws.WSRequestHolder for a given a URL string

    Attributes
    protected

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. object InvalidateCache extends PlaceHoldersUrl with Product with Serializable

    Attributes
    protected[com.m3.octoparts.ws]
  5. object InvalidateCacheFor extends PlaceHoldersUrl with Product with Serializable

    Attributes
    protected[com.m3.octoparts.ws]
  6. object InvalidateCacheGroup extends PlaceHoldersUrl with Product with Serializable

    Attributes
    protected[com.m3.octoparts.ws]
  7. object InvalidateCacheGroupFor extends PlaceHoldersUrl with Product with Serializable

    Attributes
    protected[com.m3.octoparts.ws]
  8. object Invoke extends NoPlaceholdersUrl with Product with Serializable

    Attributes
    protected[com.m3.octoparts.ws]
  9. object ListEndpoints extends NoPlaceholdersUrl with Product with Serializable

    Attributes
    protected[com.m3.octoparts.ws]
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def buildAggReq(reqMeta: RequestMeta, partReqs: Seq[PartRequest]): AggregateRequest

    Builds an com.m3.octoparts.model.AggregateRequest using com.m3.octoparts.model.RequestMeta and a list of com.m3.octoparts.model.PartRequest

    Builds an com.m3.octoparts.model.AggregateRequest using com.m3.octoparts.model.RequestMeta and a list of com.m3.octoparts.model.PartRequest

    You may wish to (abstract) override this if you have you have your own requirements for pulling shared data from com.m3.octoparts.model.RequestMeta into your com.m3.octoparts.model.PartRequests

    Attributes
    protected
  12. def cacheApiBaseUrl(baseUrl: String): String

    Returns a base URL for the Cache-related APIs

    Returns a base URL for the Cache-related APIs

    Attributes
    protected
  13. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  14. def dropTrailingSlash(s: String): String

    Drops the final forward slash from a string if it exists.

    Drops the final forward slash from a string if it exists.

    As far as I can see, this does not use any Regexp..

    Attributes
    protected
  15. def emptyPostOk(url: String)(implicit ec: ExecutionContext): Future[Boolean]

    Does a POST with empty content to the given URL and maps the response to true if the response status is less than 400 or false otherwise

  16. def emptyReqResponse: AggregateResponse

    Generates a default dumb/empty com.m3.octoparts.model.AggregateResponse.

    Generates a default dumb/empty com.m3.octoparts.model.AggregateResponse.

    Attributes
    protected
  17. def endpointsApiBaseUrl(baseUrl: String): String

    Returns a base URL for the Endpoint APIs

    Returns a base URL for the Endpoint APIs

    Attributes
    protected
  18. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  20. def finalize(): Unit

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

    Definition Classes
    AnyRef → Any
  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  23. def invalidateCache(partId: String)(implicit ec: ExecutionContext): Future[Boolean]

    Invalidates cache for a single part

  24. def invalidateCacheFor(partId: String, paramName: String, paramValue: String)(implicit ec: ExecutionContext): Future[Boolean]

    Invalidates a region of the cache for a single part.

    Invalidates a region of the cache for a single part. If the part does not exist, returns true anyways.

  25. def invalidateCacheGroup(groupName: String)(implicit ec: ExecutionContext): Future[Boolean]

    Invalidates a group of caches If the group does not exist, returns false.

  26. def invalidateCacheGroupFor(groupName: String, paramValue: String)(implicit ec: ExecutionContext): Future[Boolean]

    Invalidates a region for a group of caches If the group does not exist, returns false.

  27. def invoke[A](obj: A, partReqs: Seq[PartRequest])(implicit reqMetaBuilder: RequestMetaBuilder[A], ec: ExecutionContext): Future[AggregateResponse]

    Returns a Futurecom.m3.octoparts.model.AggregateResponse received from asynchronously invoking Octoparts using the provided argument object, and com.m3.octoparts.model.PartRequest list.

    Returns a Futurecom.m3.octoparts.model.AggregateResponse received from asynchronously invoking Octoparts using the provided argument object, and com.m3.octoparts.model.PartRequest list.

    A RequestMetaBuilder type class instance for the first argument must be in scope at the call-site.

  28. def invoke(aggReq: AggregateRequest)(implicit ec: ExecutionContext): Future[AggregateResponse]

    Returns a Futurecom.m3.octoparts.model.AggregateResponse received from asynchronously invoking Octoparts using the provided com.m3.octoparts.model.AggregateRequest

  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  30. def listEndpoints()(implicit ec: ExecutionContext): Future[Seq[HttpPartConfig]]

    Returns a Future Seqcom.m3.octoparts.model.config.json.HttpPartConfig, which describes all the endpoints registered to the Octoparts service.

  31. val logger: Logger

    Simple named logger

    Simple named logger

    Attributes
    protected
  32. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  36. def toString(): String

    Definition Classes
    AnyRef → Any
  37. def urlFor(opUrl: ApiUrl, pathSegments: String*): String

    Given an ApiUrl and path segments, returns the full URL for that operation, filling in path segments where appropriate

    Given an ApiUrl and path segments, returns the full URL for that operation, filling in path segments where appropriate

    Attributes
    protected[com.m3.octoparts.ws]
  38. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def wsPost[A](url: String, body: A)(implicit wrt: Writeable[A], ct: ContentTypeOf[A]): Future[WSResponse]

    Asynchronously sends a POST request to Octoparts.

    Asynchronously sends a POST request to Octoparts.

    You may wish to (abstract) override this if you want to do custom error-handling on the WS request level.

    Attributes
    protected

Inherited from AnyRef

Inherited from Any

Ungrouped