com.couchbase.client.java.cluster

Interface ClusterInfo

All Known Implementing Classes:

DefaultClusterInfo

@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface ClusterInfo

Provides information about a Cluster.

Selected bucket properties are available through explicit getters, the full (raw JSON) response from the server is accessible through the raw() method. Note that the response is subject to change across server versions and therefore should be properly checked before being used.

Since:

2.0

Method Summary

Modifier and Type	Method and Description
boolean	checkAvailable(CouchbaseFeature feature) Checks the availability of a specified CouchbaseFeature on the associated Cluster.
List<Version>	getAllVersions() Returns the list of Version obtained from the cluster from which this ClusterInfo was obtained.
Version	getMinVersion() Returns the smallest node version (thus oldest version) in the cluster from which this ClusterInfo was taken.
JsonObject	raw() Provides raw access to the full JSON information from the server.

Method Detail

raw

JsonObject raw()

Provides raw access to the full JSON information from the server.

Returns:

the raw JSON cluster info.

checkAvailable

boolean checkAvailable(CouchbaseFeature feature)

Checks the availability of a specified CouchbaseFeature on the associated Cluster.

Note that this relies on getMinVersion(). If said method returns Version.NO_VERSION then the feature will be deemed unavailable (this method will return false).

Parameters:

feature - the feature to check for.

Returns:

true if minimum node server version is compatible with the feature, false otherwise.

See Also:

getMinVersion()

getMinVersion

Version getMinVersion()

Returns the smallest node version (thus oldest version) in the cluster from which this ClusterInfo was taken. If list of version cannot be obtained then this returns Version.NO_VERSION.

Returns:

the smallest (oldest) server version in the cluster.

getAllVersions

List<Version> getAllVersions()

Returns the list of Version obtained from the cluster from which this ClusterInfo was obtained. In case the versions cannot be obtained, an empty list is returned.

Returns:

the list of nodes versions, or an empty list in case of errors.