package client
- Alphabetic
- Public
- All
Type Members
- case class AuthInfo(accessToken: String, expires: DateTime, refreshToken: String) extends Product with Serializable
-
case class
AuthRequest(apiKey: String, secret: String) extends Product with Serializable
Created by apatzer on 3/20/17.
- case class ClientConfig(baseRestUri: Uri, apiKey: String, apiSecret: String) extends Product with Serializable
- case class EmptyResponse(none: Option[String] = scala.None) extends Product with Serializable
-
trait
HttpClient extends Closeable
Designed to unify interfaces of play.api.libs.ws.StandaloneWSClient and play.api.libs.ws.WSClient so that these can be used interchangeably.
Designed to unify interfaces of play.api.libs.ws.StandaloneWSClient and play.api.libs.ws.WSClient so that these can be used interchangeably. Can be used to accommodate play's internal WsClient or StandaloneAhcWSClient bundled with the library.
- case class RedoxAuthorizationException(msg: String) extends Exception with Product with Serializable
-
class
RedoxClient extends RedoxClientComponents
Created by apatzer on 3/20/17.
- abstract class RedoxClientComponents extends AnyRef
- case class RedoxError(ID: Long, Text: String, Type: Option[String] = scala.None, Module: Option[String] = scala.None) extends Product with Serializable
- case class RedoxErrorResponse(Errors: Seq[RedoxError] = scala.collection.Seq.empty[Nothing]) extends Product with Serializable
-
case class
RedoxResponse[T](result: Either[RedoxErrorResponse, T]) extends Product with Serializable
Wrapper for all responses, for common functionality.
-
class
RedoxTokenManager extends RedoxClientComponents
Redox uses a perishable accessToken with an expiry to authenticate requests.
Redox uses a perishable accessToken with an expiry to authenticate requests. The accessToken is obtained by exchanging a apiKey and an apiSecret. On the first exchange we receive:
- accessToken 2. expiry time 3. refreshToken
We use the RefreshToken obtained from the first request to obtain new accessTokens as they expire.
The RedoxTokenManager schedules the refresh and storage of accessTokens and keeps them valid, so a client doesn't have to authenticate each time it makes a request.
- case class RefreshRequest(apiKey: String, refreshToken: String) extends Product with Serializable
Value Members
- object AuthInfo extends Serializable
- object AuthRequest extends Serializable
- object ClientConfig extends Serializable
- object EmptyResponse extends Serializable
- object HttpClient
- object RedoxClient
- object RedoxError extends Serializable
- object RedoxErrorResponse extends Serializable
- object RefreshRequest extends Serializable