client
0.23.19-RC3
API
Generated with
client/org.http4s.client.oauth1

org.http4s.client.oauth1

package org.http4s.client.oauth1

Basic OAuth1 message signing support

This feature is not considered stable.

Attributes

Members list

Concise view

Type members

Classlikes

final case class Consumer(key: String, secret: String)

Representation of a Consumer key and secret

Representation of a Consumer key and secret

Attributes

Source:
Types.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
object HmacSha1 extends SignatureAlgorithm

An implementation of the HMAC-SHA1 oauth signature method.

An implementation of the HMAC-SHA1 oauth signature method.

This uses the HmacSHA1 implementation which every java platform is required to have.

Attributes

Source:
SignatureAlgorithm.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object HmacSha256 extends SignatureAlgorithm

An implementation of the HMAC-SHA256 oauth signature method.

An implementation of the HMAC-SHA256 oauth signature method.

This uses the HmacSHA256 implementation which every java platform is required to have.

Attributes

Source:
SignatureAlgorithm.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object HmacSha512 extends SignatureAlgorithm

An implementation of the HMAC-SHA512 oauth signature method.

An implementation of the HMAC-SHA512 oauth signature method.

WARNING - This uses the HmacSHA512 implementation which is not required to be present by the Java spec. (However, most modern Java runtimes tend to have it)

Attributes

Source:
SignatureAlgorithm.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait ProtocolParameter

Attributes

Companion:
object
Source:
ProtocolParameter.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Callback
class Consumer
class Custom
class Nonce
class Realm
class Timestamp
class Token
class Verifier
class Version
object ProtocolParameter

Attributes

Companion:
trait
Source:
ProtocolParameter.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
object SignatureAlgorithm

Attributes

Companion:
trait
Source:
SignatureAlgorithm.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
trait SignatureAlgorithm

Implementations for Oauth1 signatures.

Implementations for Oauth1 signatures.

Attributes

Companion:
object
Source:
SignatureAlgorithm.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object HmacSha1.type
object HmacSha256.type
object HmacSha512.type
final case class Token(value: String, secret: String)

Representation of an OAuth Token and Token secret

Representation of an OAuth Token and Token secret

Attributes

Source:
Types.scala
Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def mkBaseString(method: Method, uri: Uri, paramsStr: String): String

Attributes

Source:
oauth1.scala
def signRequest[F[_]](req: Request[F], consumer: Consumer, token: Option[Token], realm: Option[Realm], signatureMethod: SignatureMethod, timestampGenerator: F[Timestamp], version: Version, nonceGenerator: F[Nonce], callback: Option[Callback], verifier: Option[Verifier])(implicit F: MonadThrow[F], W: EntityDecoder[F, UrlForm]): F[Request[F]]

Attributes

Source:
oauth1.scala
def takeSigHeaders[F[_] : Monad](consumer: Consumer, token: Option[Token], signatureMethod: SignatureMethod, timestampGenerator: F[Timestamp], version: Version, nonceGenerator: F[Nonce], callback: Option[Callback], verifier: Option[Verifier]): F[Seq[ProtocolParameter]]

Attributes

Source:
oauth1.scala

Deprecated methods

def signRequest[F[_]](req: Request[F], consumer: Consumer, callback: Option[Uri], verifier: Option[String], token: Option[Token])(implicit F: MonadThrow[F], W: EntityDecoder[F, UrlForm]): F[Request[F]]

Sign the request with an OAuth Authorization header

Sign the request with an OAuth Authorization header

WARNING: POST requests with application/x-www-form-urlencoded bodies will be entirely buffered due to signing requirements.

Attributes

Deprecated
true
Source:
oauth1.scala
Generated with