org.apache.hc.client5.http.fluent.Request Maven / Gradle / Ivy
Show all versions of httpclient5-fluent Show documentation
/*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
*
* This feature is considered experimental and may be discontinued in the future.
*
* @since 5.5
*/
@Experimental
public Response executeHttp2() throws IOException {
return execute(Executor.GET_ASYNC_CLIENT());
}
public Response execute(final CloseableHttpClient client) throws IOException {
return new Response(internalExecute(client, HttpClientContext.create()));
}
//// HTTP header operations
public Request addHeader(final Header header) {
this.request.addHeader(header);
return this;
}
/**
* @return this instance.
* @since 4.3
*/
public Request setHeader(final Header header) {
this.request.setHeader(header);
return this;
}
public Request addHeader(final String name, final String value) {
this.request.addHeader(name, value);
return this;
}
/**
* @return this instance.
* @since 4.3
*/
public Request setHeader(final String name, final String value) {
this.request.setHeader(name, value);
return this;
}
public Request removeHeader(final Header header) {
this.request.removeHeader(header);
return this;
}
public Request removeHeaders(final String name) {
this.request.removeHeaders(name);
return this;
}
public Request setHeaders(final Header... headers) {
this.request.setHeaders(headers);
return this;
}
public Request setCacheControl(final String cacheControl) {
this.request.setHeader(HttpHeader.CACHE_CONTROL, cacheControl);
return this;
}
ClassicHttpRequest getRequest() {
return request;
}
/**
* @return this instance.
* @deprecated Use {@link #setDate(Instant)}
*/
@Deprecated
public Request setDate(final Date date) {
this.request.setHeader(HttpHeader.DATE, DateUtils.formatStandardDate(DateUtils.toInstant(date)));
return this;
}
/**
* @return this instance.
* @deprecated Use {@link #setIfModifiedSince(Instant)}
*/
@Deprecated
public Request setIfModifiedSince(final Date date) {
this.request.setHeader(HttpHeader.IF_MODIFIED_SINCE, DateUtils.formatStandardDate(DateUtils.toInstant(date)));
return this;
}
/**
* @return this instance.
* @deprecated Use {@link #setIfUnmodifiedSince(Instant)}
*/
@Deprecated
public Request setIfUnmodifiedSince(final Date date) {
this.request.setHeader(HttpHeader.IF_UNMODIFIED_SINCE, DateUtils.formatStandardDate(DateUtils.toInstant(date)));
return this;
}
public Request setDate(final Instant instant) {
this.request.setHeader(HttpHeader.DATE, DateUtils.formatStandardDate(instant));
return this;
}
public Request setIfModifiedSince(final Instant instant) {
this.request.setHeader(HttpHeader.IF_MODIFIED_SINCE, DateUtils.formatStandardDate(instant));
return this;
}
public Request setIfUnmodifiedSince(final Instant instant) {
this.request.setHeader(HttpHeader.IF_UNMODIFIED_SINCE, DateUtils.formatStandardDate(instant));
return this;
}
//// HTTP protocol parameter operations
public Request version(final HttpVersion version) {
this.request.setVersion(version);
return this;
}
public Request useExpectContinue() {
this.useExpectContinue = Boolean.TRUE;
return this;
}
public Request userAgent(final String agent) {
this.request.setHeader(HttpHeaders.USER_AGENT, agent);
return this;
}
//// HTTP connection parameter operations
public Request connectTimeout(final Timeout timeout) {
this.connectTimeout = timeout;
return this;
}
public Request responseTimeout(final Timeout timeout) {
this.responseTimeout = timeout;
return this;
}
//// HTTP connection route operations
public Request viaProxy(final HttpHost proxy) {
this.proxy = proxy;
return this;
}
/**
* @return this instance.
* @since 4.4
*/
public Request viaProxy(final String proxy) {
try {
this.proxy = HttpHost.create(proxy);
} catch (final URISyntaxException e) {
throw new IllegalArgumentException("Invalid host");
}
return this;
}
//// HTTP entity operations
public Request body(final HttpEntity entity) {
this.request.setEntity(entity);
return this;
}
public Request bodyForm(final Iterable formParams, final Charset charset) {
final List paramList = new ArrayList<>();
for (final NameValuePair param : formParams) {
paramList.add(param);
}
final ContentType contentType = charset != null ?
ContentType.APPLICATION_FORM_URLENCODED.withCharset(charset) : ContentType.APPLICATION_FORM_URLENCODED;
final String s = WWWFormCodec.format(paramList, contentType.getCharset());
return bodyString(s, contentType);
}
public Request bodyForm(final Iterable formParams) {
return bodyForm(formParams, StandardCharsets.ISO_8859_1);
}
public Request bodyForm(final NameValuePair... formParams) {
return bodyForm(Arrays.asList(formParams), StandardCharsets.ISO_8859_1);
}
public Request bodyString(final String s, final ContentType contentType) {
final Charset charset = contentType != null ? contentType.getCharset() : null;
final byte[] raw = charset != null ? s.getBytes(charset) : s.getBytes();
return body(new ByteArrayEntity(raw, contentType));
}
public Request bodyFile(final File file, final ContentType contentType) {
return body(new FileEntity(file, contentType));
}
public Request bodyByteArray(final byte[] b) {
return body(new ByteArrayEntity(b, null));
}
/**
* @return this instance.
* @since 4.4
*/
public Request bodyByteArray(final byte[] b, final ContentType contentType) {
return body(new ByteArrayEntity(b, contentType));
}
public Request bodyByteArray(final byte[] b, final int off, final int len) {
return body(new ByteArrayEntity(b, off, len, null));
}
/**
* @return this instance.
* @since 4.4
*/
public Request bodyByteArray(final byte[] b, final int off, final int len, final ContentType contentType) {
return body(new ByteArrayEntity(b, off, len, contentType));
}
public Request bodyStream(final InputStream inStream) {
return body(new InputStreamEntity(inStream, -1, null));
}
public Request bodyStream(final InputStream inStream, final ContentType contentType) {
return body(new InputStreamEntity(inStream, -1, contentType));
}
@Override
public String toString() {
return this.request.toString();
}
}