WebServerDispatcher.Resource.Builder

Builder()

Constructs an instance.

fun build(): WebServerDispatcher.Resource!

Builds the Resource.

@CanIgnoreReturnValue
fun includesContentLengthInRangeResponses(
    includesContentLengthInRangeResponses: Boolean
): WebServerDispatcher.Resource.Builder!

Sets if RFC 7233 HTTP 206 range responses should include a Content-Length header.

Setting this to false allows simulating servers or proxies that only include the Content-Range header and not Content-Length, as described in the comments in getContentLength.

Defaults to true.

@CanIgnoreReturnValue
fun resolvesToUnknownLength(resolvesToUnknownLength: Boolean): WebServerDispatcher.Resource.Builder!

Sets if the server shouldn't include the resource length in header responses.

If true, responses to unbound requests won't include a Content-Length header and Content-Range headers won't include the total resource length.

@CanIgnoreReturnValue
fun setData(data: ByteArray!): WebServerDispatcher.Resource.Builder!

Sets the data served by this resource. This is required.

@CanIgnoreReturnValue
fun setExtraResponseHeaders(extraResponseHeaders: Multimap<String!, String!>!): WebServerDispatcher.Resource.Builder!

Sets the extra response headers that should be attached.

@CanIgnoreReturnValue
fun setGzipSupport(gzipSupport: Int): WebServerDispatcher.Resource.Builder!

Sets the level of gzip support for this resource. Defaults to GZIP_SUPPORT_DISABLED.

@CanIgnoreReturnValue
fun setHttpMethod(@DataSpec.HttpMethod httpMethod: Int): WebServerDispatcher.Resource.Builder!

Sets the HTTP method that is expected to be used to access the resource.

Defaults to HTTP_METHOD_GET.

@CanIgnoreReturnValue
fun setPath(path: String!): WebServerDispatcher.Resource.Builder!

Sets the path this data should be served at. This is required.

@CanIgnoreReturnValue
fun setRequestBody(requestBody: ByteArray!): WebServerDispatcher.Resource.Builder!

The request body that is expected to be included in a request for the resource.

If a request is made with a mismatched body, WebServerDispatcher will return a 400 Bad Request error response.

Defaults to an empty array.

@CanIgnoreReturnValue
fun setRequestHeaders(
    requestHeaders: ImmutableListMultimap<String!, String!>!
): WebServerDispatcher.Resource.Builder!

Sets the request headers that are expected to be included in a request for the resource.

This is non-exhaustive, additional headers are permitted, but if any headers in this map are missing from a request (or have mismatched values), WebServerDispatcher will return a 400 Bad Request error response.

Defaults to an empty map.

@CanIgnoreReturnValue
fun supportsRangeRequests(supportsRangeRequests: Boolean): WebServerDispatcher.Resource.Builder!

Sets if RFC 7233 range requests should be supported for this resource. Defaults to false.