HttpRequest

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val backendConfig: BackendConfig
val body: Option[BodyPart]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val crossDomainCookies: Boolean
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def get()(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

Sends this request with the GET method.
Sends this request with the GET method.

See also
send
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
val headers: HeaderMap[String]
val host: String
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val longPath: String

The path with the query string or just the path if there is no query string
val method: Method
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def options(body: BodyPart)(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

Sends this request with the OPTIONS method and a body
Sends this request with the OPTIONS method and a body
body
The body to send with the request

See also
post
val path: String
val port: Option[Int]
def post(body: BodyPart)(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

Sends this request with the POST method and a body
Sends this request with the POST method and a body
body
The body to send with the request

See also
send
val protocol: Protocol
def put(body: BodyPart)(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

Sends this request with the PUT method and a body
Sends this request with the PUT method and a body
body
The body to send with the request

See also
post
val queryString: Option[String]
def send(body: BodyPart)(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

Sends this request with a body.
Sends this request with a body.
This method should not be used directly. If you want to post or put some data, you should use the appropriate methods. If you do not want to send data with the request, you should use post without arguments.
body
The body to send.
def send()(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

Sends this request.
Sends this request.
A request can be sent multiple times. When a request is sent, it returns a Future[HttpResponse] which either succeeds with an HttpResponse or fails.]]
def stream()(implicit scheduler: Scheduler): Future[StreamHttpResponse]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeout: FiniteDuration
def toString(): String

Definition Classes
AnyRef → Any
val url: String

The target url for this request
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )
def withBackendConfig(backendConfig: BackendConfig): HttpRequest

Use the provided backend configuration when executing the request
def withBody(body: BodyPart): HttpRequest

Attaches a body to this request and sets the Content-Type header.
Attaches a body to this request and sets the Content-Type header.
The body will be sent with the request regardless of other parameters once send() is invoked. Any subsequent call to withBody(), send(BodyPart), post(BodyPart), put(BodyPart) or similar methods will override the request body.
The Content-Type header is set to this body's content-type. It can still be manually overridden using a method of the withHeader() family.
Note that the HTTP spec forbids sending data with some methods. In case you need to deal with a broken backend, this library allows you to do so anyway. **Beware that in this case, the JVM can still enforce a compliant HTTP method**.
def withCrossDomainCookies(toggle: Boolean): HttpRequest

Allows browser to add a cookie to a cross-domain request, if one was received prior from the server.
Allows browser to add a cookie to a cross-domain request, if one was received prior from the server.
toggle
If true, browser is allowed to add cookie to cross-domain request.
returns
A copy of this HttpRequest with an updated header set.
def withDefaultPort(): HttpRequest

Discards changes introduced by any call to withPort
Discards changes introduced by any call to withPort
returns
A copy of this HttpRequest with no explicit port.
def withHeader(key: String, value: String): HttpRequest

Adds or updates a header to the current set of headers.
Adds or updates a header to the current set of headers.
key
The header key (case insensitive)
value
The header value
returns
A copy of this HttpRequest with an updated header set.
def withHeaders(newHeaders: (String, String)*): HttpRequest

Adds or updates multiple headers to the current set of headers.
Adds or updates multiple headers to the current set of headers.
newHeaders
The headers to add.
returns
A copy of this HttpRequest with an updated header set.
def withHost(host: String): HttpRequest

Sets the host used in the request URI.
Sets the host used in the request URI.
host
The new host
returns
A copy of this HttpRequest with an updated host
def withMethod(method: Method): HttpRequest

Sets the HTTP method.
Sets the HTTP method. Defaults to GET.
Beware of browser limitations when using exotic methods.
method
The new method
returns
A copy of this HttpRequest with an updated method
def withPath(path: String): HttpRequest

Sets the path used in the request URI.
Sets the path used in the request URI.
The path is the part that lies between the host (or port if present) and the query string or the end of the request. Note that the query string is not part of the path.
path
The new path, including the leading '/' and excluding any '?' or '#' and subsequent characters
returns
A copy of this HttpRequest with an updated path
def withPort(port: Int): HttpRequest

Sets the port used in the request URI.
Sets the port used in the request URI.
port
The new port
returns
A copy of this HttpRequest with an updated port
def withProtocol(protocol: Protocol): HttpRequest

Sets the protocol used in the request URL.
Sets the protocol used in the request URL.
Setting the protocol also sets the port accordingly (80 for HTTP, 443 for HTTPS).
protocol
The HTTP or HTTPS protocol
returns
A copy of this HttpRequest with an updated protocol and port
def withQueryObjectParameter(key: String, values: Seq[(String, String)]): HttpRequest

Adds an object made of key/value pairs to the query string.
Adds an object made of key/value pairs to the query string.
Although this is not part of a spec, most servers recognize bracket indices in a query string as object keys. The same key can appear multiple times as some server will interpret this as multiple elements in an array for that key.
example: ?obj[foo]=bar&obj[baz]=42
key
The unescaped parameter key
values
The unescaped parameter map values
returns
A copy of this HttpRequest with an updated query string.
def withQueryParameter(key: String, value: String): HttpRequest

Adds a query parameter key/value pair.
Adds a query parameter key/value pair.
Query parameters end up in the query string as key=value pairs separated by ampersands. Both the key and parameter are escaped to ensure proper query string format.
key
The unescaped parameter key
value
The unescaped parameter value
returns
A copy of this HttpRequest with an updated query string.
def withQueryParameters(parameters: (String, String)*): HttpRequest

Adds multiple query parameters.
Adds multiple query parameters.
parameters
A sequence of new, unescaped parameters.
returns
A copy of this HttpRequest with an updated query string.
def withQuerySeqParameter(key: String, values: Seq[String]): HttpRequest

Adds a query array parameter.
Adds a query array parameter.
Although this is not part of a spec, most servers recognize bracket indices in a query string as array indices or object keys.
example: ?list[0]=foo&list[1]=bar
This method formats array values according to the above example.
key
The unescaped parameter key
values
The unescaped parameter array values
returns
A copy of this HttpRequest with an updated query string.
def withQueryString(queryString: String): HttpRequest

Sets the query string.
Sets the query string.
The argument is escaped by this method. If you want to bypass the escaping, use withQueryStringRaw.
Escaping also means that the queryString property will generally not be equal to what you passed as argument to withQueryString.
For instance: request.withQueryString("äéuô").queryString.get != "%C3%A4%C3%A9u%C3%B4"
queryString
The unescaped query string.
returns
A copy of this HttpRequest with an updated queryString
def withQueryStringRaw(queryString: String): HttpRequest

Sets the query string without escaping.
Sets the query string without escaping.
Raw query strings must only contain legal characters as per rfc3986. Adding special characters yields undefined behaviour.
In most cases, withQueryString should be preferred.
queryString
The raw, escaped query string
returns
A copy of this HttpRequest with an updated queryString
def withTimeout(timeout: FiniteDuration): HttpRequest

Specifies the request timeout.
Specifies the request timeout.
When a request takes longer than timeout to complete, the future is rejected with a fr.hmil.roshttp.exceptions.TimeoutException.
timeout
The duration to wait before throwing a timeout exception.
returns
A copu of this HttpRequest with an updated timeout setting.
def withURL(url: String): HttpRequest

Updates request protocol, host, port, path and queryString according to a url.
Updates request protocol, host, port, path and queryString according to a url.
url
A valid HTTP url
returns
A copy of this HttpRequest with updated URL-related attributes.
def withoutQueryString(): HttpRequest

Removes the query string.
Removes the query string.
returns
A copy of this HttpRequest without query string

Related Docs: object HttpRequest | package roshttp

final class HttpRequest extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val backendConfig: BackendConfig

val body: Option[BodyPart]

def clone(): AnyRef

val crossDomainCookies: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

def get()(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

final def getClass(): Class[_]

def hashCode(): Int

val headers: HeaderMap[String]

val host: String

final def isInstanceOf[T0]: Boolean

val longPath: String

val method: Method

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def options(body: BodyPart)(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

val path: String

val port: Option[Int]

def post(body: BodyPart)(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

val protocol: Protocol

def put(body: BodyPart)(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

val queryString: Option[String]

def send(body: BodyPart)(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

def send()(implicit scheduler: Scheduler): Future[SimpleHttpResponse]

def stream()(implicit scheduler: Scheduler): Future[StreamHttpResponse]

final def synchronized[T0](arg0: ⇒ T0): T0

val timeout: FiniteDuration

def toString(): String

val url: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withBackendConfig(backendConfig: BackendConfig): HttpRequest

def withBody(body: BodyPart): HttpRequest

def withCrossDomainCookies(toggle: Boolean): HttpRequest

def withDefaultPort(): HttpRequest

def withHeader(key: String, value: String): HttpRequest

def withHeaders(newHeaders: (String, String)*): HttpRequest

def withHost(host: String): HttpRequest

def withMethod(method: Method): HttpRequest

def withPath(path: String): HttpRequest

def withPort(port: Int): HttpRequest

def withProtocol(protocol: Protocol): HttpRequest

def withQueryObjectParameter(key: String, values: Seq[(String, String)]): HttpRequest

def withQueryParameter(key: String, value: String): HttpRequest

def withQueryParameters(parameters: (String, String)*): HttpRequest

def withQuerySeqParameter(key: String, values: Seq[String]): HttpRequest

def withQueryString(queryString: String): HttpRequest

def withQueryStringRaw(queryString: String): HttpRequest

def withTimeout(timeout: FiniteDuration): HttpRequest

def withURL(url: String): HttpRequest

def withoutQueryString(): HttpRequest

Inherited from AnyRef

Inherited from Any

Ungrouped