Package com.couchbase.client.java.http

Class CouchbaseHttpClient

java.lang.Object

com.couchbase.client.java.http.CouchbaseHttpClient

public class CouchbaseHttpClient
extends Object

A specialized HTTP client for making requests to Couchbase Server.

Get an instance by calling Cluster.httpClient().

Example usage:

 public static String getAutoFailoverSettings(Cluster cluster) {
   HttpResponse response = cluster.httpClient().get(
       HttpTarget.manager(),
       HttpPath.of("/settings/autoFailover"));

   if (!response.success()) {
     throw new RuntimeException(
         "Failed to get auto-failover settings. HTTP status code " +
             response.statusCode() + "; " + response.contentAsString());
   }

   return response.contentAsString();
 }

 public static void disableAutoFailover(Cluster cluster) {
   HttpResponse response = cluster.httpClient().post(
       HttpTarget.manager(),
       HttpPath.of("/settings/autoFailover"),
       HttpPostOptions.httpPostOptions()
           .body(HttpBody.form(Map.of("enabled", "false"))));

   if (!response.success()) {
     throw new RuntimeException(
         "Failed to disable auto-failover. HTTP status code " +
             response.statusCode() + "; " + response.contentAsString());
   }
 }
 

See Also:

• AsyncCouchbaseHttpClient
• ReactiveCouchbaseHttpClient

Constructor Summary

Constructors

Constructor	Description
CouchbaseHttpClient(AsyncCouchbaseHttpClient async)

Method Summary

Modifier and Type	Method	Description
HttpResponse	delete(HttpTarget target, HttpPath path)	Issues a DELETE request with default options.
HttpResponse	delete(HttpTarget target, HttpPath path, HttpDeleteOptions options)	Issues a DELETE request with the given options.
HttpResponse	get(HttpTarget target, HttpPath path)	Issues a GET request with default options (no query parameters).
HttpResponse	get(HttpTarget target, HttpPath path, HttpGetOptions options)	Issues a GET request with the given options.
HttpResponse	patch(HttpTarget target, HttpPath path)	Issues a PATCH request with no body and default options.
HttpResponse	patch(HttpTarget target, HttpPath path, HttpPatchOptions options)	Issues a PATCH request with the given options.
HttpResponse	post(HttpTarget target, HttpPath path)	Issues a POST request with no body and default options.
HttpResponse	post(HttpTarget target, HttpPath path, HttpPostOptions options)	Issues a POST request with the given options.
HttpResponse	put(HttpTarget target, HttpPath path)	Issues a PUT request with no body and default options.
HttpResponse	put(HttpTarget target, HttpPath path, HttpPutOptions options)	Issues a PUT request with the given options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CouchbaseHttpClient

@Internal
public CouchbaseHttpClient(AsyncCouchbaseHttpClient async)

Method Details

get

public HttpResponse get(HttpTarget target,
 HttpPath path)

Issues a GET request with default options (no query parameters).

To specify query parameters, use the overload that takes HttpGetOptions or include the query string in the path.

get

public HttpResponse get(HttpTarget target,
 HttpPath path,
 HttpGetOptions options)

Issues a GET request with the given options.

Specify query parameters via the options:

 httpClient.get(target, path, HttpGetOptions.httpGetOptions()
     .queryString(Map.of("foo", "bar")));
 

post

public HttpResponse post(HttpTarget target,
 HttpPath path)

Issues a POST request with no body and default options.

To specify a request body, use the overload that takes HttpPostOptions.

post

public HttpResponse post(HttpTarget target,
 HttpPath path,
 HttpPostOptions options)

Issues a POST request with the given options.

Specify a request body via the options:

 // form data
 httpClient.post(target, path, HttpPostOptions.httpPostOptions()
     .body(HttpBody.form(Map.of("foo", "bar")));

 // JSON document
 httpClient.post(target, path, HttpPostOptions.httpPostOptions()
     .body(HttpBody.json("{}")));
 

put

public HttpResponse put(HttpTarget target,
 HttpPath path)

Issues a PUT request with no body and default options.

To specify a request body, use the overload that takes HttpPutOptions.

put

public HttpResponse put(HttpTarget target,
 HttpPath path,
 HttpPutOptions options)

Issues a PUT request with the given options.

Specify a request body via the options:

 // form data
 httpClient.put(target, path, HttpPutOptions.httpPutOptions()
     .body(HttpBody.form(Map.of("foo", "bar")));

 // JSON document
 httpClient.put(target, path, HttpPutOptions.httpPutOptions()
     .body(HttpBody.json("{}")));
 

patch

public HttpResponse patch(HttpTarget target,
 HttpPath path)

Issues a PATCH request with no body and default options.

To specify a request body, use the overload that takes HttpPatchOptions.

patch

public HttpResponse patch(HttpTarget target,
 HttpPath path,
 HttpPatchOptions options)

Issues a PATCH request with the given options.

Specify a request body via the options:

 // form data
 httpClient.patch(target, path, HttpPatchOptions.httpPatchOptions()
     .body(HttpBody.form(Map.of("foo", "bar")));

 // JSON document
 httpClient.patch(target, path, HttpPatchOptions.httpPatchOptions()
     .body(HttpBody.json("{}")));
 

delete

public HttpResponse delete(HttpTarget target,
 HttpPath path)

Issues a DELETE request with default options.

delete

public HttpResponse delete(HttpTarget target,
 HttpPath path,
 HttpDeleteOptions options)

Issues a DELETE request with the given options.