WebServerDispatcher.Resource.Builder

public Builder()

Constructs an instance.

public WebServerDispatcher.Resource build()

Builds the Resource.

@CanIgnoreReturnValue
public WebServerDispatcher.Resource.Builder includesContentLengthInRangeResponses(
    boolean includesContentLengthInRangeResponses
)

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
public WebServerDispatcher.Resource.Builder resolvesToUnknownLength(boolean resolvesToUnknownLength)

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
public WebServerDispatcher.Resource.Builder setData(byte[] data)

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

@CanIgnoreReturnValue
public WebServerDispatcher.Resource.Builder setExtraResponseHeaders(Multimap<String, String> extraResponseHeaders)

Sets the extra response headers that should be attached.

@CanIgnoreReturnValue
public WebServerDispatcher.Resource.Builder setGzipSupport(int gzipSupport)

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

@CanIgnoreReturnValue
public WebServerDispatcher.Resource.Builder setHttpMethod(@DataSpec.HttpMethod int httpMethod)

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

Defaults to HTTP_METHOD_GET.

@CanIgnoreReturnValue
public WebServerDispatcher.Resource.Builder setPath(String path)

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

@CanIgnoreReturnValue
public WebServerDispatcher.Resource.Builder setRequestBody(byte[] requestBody)

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
public WebServerDispatcher.Resource.Builder setRequestHeaders(
    ImmutableListMultimap<String, String> requestHeaders
)

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
public WebServerDispatcher.Resource.Builder supportsRangeRequests(boolean supportsRangeRequests)

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