com.couchbase.client.core.message.config

Class GetUsersRequest

java.lang.Object

com.couchbase.client.core.message.AbstractCouchbaseRequest

com.couchbase.client.core.message.config.GetUsersRequest

All Implemented Interfaces:

BootstrapMessage, ConfigRequest, CouchbaseMessage, CouchbaseRequest

public class GetUsersRequest
extends AbstractCouchbaseRequest
implements ConfigRequest

Get a user or list of users.

This request has three different ways to operate:

1) neither the domain nor the user is supplied: all users for all domains will be returned 2) just the domain is supplied: all the users will be returned 3) domain and user is supplied: only that user is returned

Note that if a userId is supplied, the domain is mandatory! Otherwise you’ll get a IllegalArgumentException.

Since:

1.4.4

Author:

Subhashni Balakrishnan, Michael Nitschinger

Method Summary

Modifier and Type	Method and Description
String	path()
static GetUsersRequest	user(String username, String password, String domain, String userId)
static GetUsersRequest	users(String username, String password)
static GetUsersRequest	usersFromDomain(String username, String password, String domain)

Methods inherited from class com.couchbase.client.core.message.AbstractCouchbaseRequest

bucket, creationTime, dispatchHostname, dispatchHostname, incrementRetryCount, isActive, maxRetryDuration, maxRetryDuration, observable, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, subscriber, toString, username

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.couchbase.client.core.message.CouchbaseRequest

bucket, dispatchHostname, dispatchHostname, incrementRetryCount, isActive, maxRetryDuration, maxRetryDuration, observable, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, subscriber, username

Methods inherited from interface com.couchbase.client.core.message.CouchbaseMessage

creationTime

Method Detail

users

public static GetUsersRequest users(String username,
                                    String password)

usersFromDomain

public static GetUsersRequest usersFromDomain(String username,
                                              String password,
                                              String domain)

user

public static GetUsersRequest user(String username,
                                   String password,
                                   String domain,
                                   String userId)

path

public String path()

Specified by:

path in interface ConfigRequest