Package com.couchbase.client.java.cluster

Interface AsyncClusterManager

    • Method Detail

      • info

        rx.Observable<ClusterInfo> info()
        Provides information about the cluster. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
        Returns:
        cluster information wrapped into a ClusterInfo object.

      • getBuckets

        rx.Observable<BucketSettings> getBuckets()
        Returns BucketSettings for all available Buckets. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
        Returns:
        zero to N BucketSettings.

      • getBucket

        rx.Observable<BucketSettings> getBucket​(String name)
        Returns the BucketSettings for the Bucket identified by name. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
        Parameters:
        name - the name of the bucket.
        Returns:
        the BucketSettings if found or an empty observable if not found.

      • hasBucket

        rx.Observable<Boolean> hasBucket​(String name)
        Checks if the cluster has a Bucket identified by the given name. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
        Parameters:
        name - the name of the bucket.
        Returns:
        true if it was found, false otherwise.

      • insertBucket

        rx.Observable<BucketSettings> insertBucket​(BucketSettings settings)
        Inserts a Bucket with its BucketSettings if it does not already exist. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded. - com.couchbase.client.java.error.BucketAlreadyExistsException: If the bucket already exists. **Note:** Inserting a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
        Parameters:
        settings - the bucket settings that should be applied.
        Returns:
        the stored bucket settings if succeeded.

      • updateBucket

        rx.Observable<BucketSettings> updateBucket​(BucketSettings settings)
        Updates a Bucket with its BucketSettings if it does already exist. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded. - com.couchbase.client.java.error.BucketDoesNotExistException: If the bucket does not exist. **Note:** Updating a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
        Parameters:
        settings - the bucket settings that should be applied.
        Returns:
        the updated bucket settings if succeeded.

      • removeBucket

        rx.Observable<Boolean> removeBucket​(String name)
        Removes a Bucket identified by its name. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded. **Note:** Removing a Bucket is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
        Parameters:
        name - the name of the bucket.
        Returns:
        true if the removal was successful, false otherwise.

      • upsertUser

        @Experimental
rx.Observable<Boolean> upsertUser​(AuthDomain domain,
                                  String username,
                                  UserSettings settings)
        Creates/Updates a user with its UserSettings. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. **Note:** Updating a user is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
        Parameters:
        domain - the authentication to use, most likely AuthDomain.LOCAL
        username - the user name of the user that should be updated.
        settings - the user settings that should be applied.
        Returns:
        true if the update was successful, false otherwise.

      • removeUser

        @Experimental
rx.Observable<Boolean> removeUser​(AuthDomain domain,
                                  String username)
        Removes a user identified by user name. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. **Note:** Removing a user is an asynchronous operation on the server side, so even if the response is returned there is no guarantee that the operation has finished on the server itself.
        Parameters:
        domain - the authentication to use, most likely AuthDomain.LOCAL
        username - the user name of the user that should be updated.
        Returns:
        true if the removal was successful, false otherwise.

      • getUsers

        @Experimental
rx.Observable<User> getUsers​(AuthDomain domain)
        Get all users in Couchbase Server. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
        Parameters:
        domain - the authentication to use, most likely AuthDomain.LOCAL
        Returns:
        users list of users.

      • getUser

        @Experimental
rx.Observable<User> getUser​(AuthDomain domain,
                            String username)
        Get user info from Couchbase Server. The Observable can error under the following conditions: - com.couchbase.client.core.CouchbaseException: If the underlying resources could not be enabled properly. - com.couchbase.client.java.error.TranscodingException: If the server response could not be decoded.
        Parameters:
        domain - the authentication to use, most likely AuthDomain.LOCAL
        Returns:
        user info