Automorph
API
Generated with
Automorph/automorph/automorph.transport/automorph.transport.http/HttpContext

HttpContext

automorph.transport.http.HttpContext
See theHttpContext companion object
final case class HttpContext[TransportContext](scheme: Option[String], userInfo: Option[String], host: Option[String], port: Option[Int], path: Option[String], parameters: Seq[(String, String)], fragment: Option[String], headers: Seq[(String, String)], method: Option[HttpMethod], statusCode: Option[Int], followRedirects: Option[Boolean], timeout: Option[Duration], transportContext: Option[TransportContext])

HTTP transport message context.

Message transport plugins must use message context properties in the descending order of priority by source:

  • This context
  • Message properties for specific transport plugin (this.message)
  • Default values

Type parameters

TransportContext

type of context for specific transport plugin

Value parameters

followRedirects

automatically follow redirects if true

fragment

request URL fragment

headers

request or response headers

host

request URL authority host

method

request method

path

request URL path

port

request URL authority port

scheme

request URL scheme

statusCode

response status code

timeout

response timeout

transportContext

message properties for specific transport plugin

userInfo

request URL authority user information

Attributes

See also
Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def authority: Option[String]

Request URL authority.

Request URL authority.

Attributes

def authority(authority: String): HttpContext[TransportContext]

Set request URL authority.

Set request URL authority.

Value parameters

authority

URL authority

Attributes

Returns

HTTP message context

def authorization(scheme: String): Option[String]

Authorization header value.

Authorization header value.

Value parameters

scheme

authentication scheme

Attributes

Returns

authentication credentials

def authorization(scheme: String, credentials: String): HttpContext[TransportContext]

Set Authorization header value.

Set Authorization header value.

Value parameters

credentials

authentication credentials

scheme

authentication scheme

Attributes

Returns

HTTP message context

def contentLength: Option[String]

Content-Length header value.

Content-Length header value.

Attributes

def contentType: Option[String]

Content-Type header value.

Content-Type header value.

Attributes

def cookies: Map[String, String]

Cookie names and values.

Cookie names and values.

Attributes

def cookies(entries: (String, String)*): HttpContext[TransportContext]

Set request cookies.

Set request cookies.

Value parameters

entries

cookie names and values

Attributes

Returns

HTTP message context

def fragment(fragment: String): HttpContext[TransportContext]

Set request URL fragment.

Set request URL fragment.

Value parameters

fragment

URL fragment

Attributes

Returns

HTTP message context

def header(name: String): Option[String]

First header value.

First header value.

Value parameters

name

header name

Attributes

Returns

first header value

def header(name: String, value: String): HttpContext[TransportContext]

Add message header.

Add message header.

Value parameters

name

header name

value

header value

Attributes

Returns

HTTP message context

def header(name: String, value: String, replace: Boolean): HttpContext[TransportContext]

Add or replace message header.

Add or replace message header.

Value parameters

name

header name

replace

replace all existing headers with the specified name

value

header value

Attributes

Returns

HTTP message context

def headers(entries: (String, String)*): HttpContext[TransportContext]

Add message headers.

Add message headers.

Value parameters

entries

header names and values

Attributes

Returns

HTTP message context

def headers(name: String): Seq[String]

Header values.

Header values.

Value parameters

name

header name

Attributes

Returns

header values

def headers(entries: Iterable[(String, String)], replace: Boolean): HttpContext[TransportContext]

Add or replace message headers.

Add or replace message headers.

Value parameters

entries

header names and values

replace

replace all existing headers with specified names

Attributes

Returns

HTTP message context

def host(host: String): HttpContext[TransportContext]

Set request URL host.

Set request URL host.

Value parameters

host

URL host

Attributes

Returns

HTTP message context

def method(method: HttpMethod): HttpContext[TransportContext]

Set request method.

Set request method.

Value parameters

method

request method

Attributes

Returns

HTTP message context

def parameter(name: String): Option[String]

First URL query parameter value.

First URL query parameter value.

Value parameters

name

query parameter name

Attributes

Returns

first query parameter value

def parameter(name: String, value: String): HttpContext[TransportContext]

Add URL query parameter.

Add URL query parameter.

Value parameters

name

parameter name

value

parameter value

Attributes

Returns

HTTP message context

def parameter(name: String, value: String, replace: Boolean): HttpContext[TransportContext]

Add or replace URL query parameter.

Add or replace URL query parameter.

Value parameters

name

query parameter name

replace

replace all existing query parameters with the specified name

value

query parameter value

Attributes

Returns

HTTP message context

def parameters(name: String): Seq[String]

URL query parameter values.

URL query parameter values.

Value parameters

name

query parameter name

Attributes

Returns

query parameter values

def parameters(entries: (String, String)*): HttpContext[TransportContext]

Add URL query parameters.

Add URL query parameters.

Value parameters

entries

query parameter names and values

Attributes

Returns

HTTP message context

def parameters(entries: Iterable[(String, String)], replace: Boolean): HttpContext[TransportContext]

Add or replace URL query parameters.

Add or replace URL query parameters.

Value parameters

entries

query parameter names and values

replace

replace all existing query parameters with specified names

Attributes

Returns

HTTP message context

def path(path: String): HttpContext[TransportContext]

Set request URL user information.

Set request URL user information.

Value parameters

path

URL userinfo

Attributes

Returns

HTTP message context

def port(port: Int): HttpContext[TransportContext]

Set request URL port.

Set request URL port.

Value parameters

port

URL port

Attributes

Returns

HTTP message context

def proxyAuthorization(scheme: String): Option[String]

Proxy-Authorization header value.

Proxy-Authorization header value.

Value parameters

scheme

authentication scheme

Attributes

Returns

authentication credentials

def proxyAuthorization(scheme: String, credentials: String): HttpContext[TransportContext]

Set Proxy-Authorization header value.

Set Proxy-Authorization header value.

Value parameters

credentials

authentication credentials

scheme

authentication scheme

Attributes

Returns

HTTP message context

def query: Option[String]

Request URL query.

Request URL query.

Attributes

def query(queryString: String): HttpContext[TransportContext]

Set request URL query string.

Set request URL query string.

Value parameters

queryString

URL query string

Attributes

Returns

HTTP message context

def scheme(scheme: String): HttpContext[TransportContext]

Set request URL scheme.

Set request URL scheme.

Value parameters

scheme

URL scheme

Attributes

Returns

HTTP message context

def setCookie(name: String): Option[SetCookie]

Set-Cookie value.

Set-Cookie value.

Value parameters

name

set cookie name

Attributes

Returns

set cookie value

def setCookies: Map[String, SetCookie]

Set-Cookie names and values.

Set-Cookie names and values.

Attributes

def setCookies(entries: (String, SetCookie)*): HttpContext[TransportContext]

Set response cookies.

Set response cookies.

Value parameters

entries

set cookie names and values

Attributes

Returns

HTTP message context

def statusCode(statusCode: Int): HttpContext[TransportContext]

Set response status code.

Set response status code.

Value parameters

statusCode

status code

Attributes

Returns

HTTP message context

def url: Option[URI]

Request URL.

Request URL.

Attributes

def url(url: String): HttpContext[TransportContext]

Set request URL.

Set request URL.

Value parameters

url

URL

Attributes

Returns

HTTP message context

def url(url: URI): HttpContext[TransportContext]

Set request URL.

Set request URL.

Value parameters

url

URL

Attributes

Returns

HTTP message context

def userInfo(userInfo: String): HttpContext[TransportContext]

Set request URL user information.

Set request URL user information.

Value parameters

userInfo

URL user information

Attributes

Returns

HTTP message context

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with