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 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
afterSpanSet, bucket, complete, creationTime, dispatchHostname, dispatchHostname, emit, fail, incrementRetryCount, isActive, lastLocalId, lastLocalId, lastLocalSocket, lastLocalSocket, lastRemoteSocket, lastRemoteSocket, maxRetryDuration, maxRetryDuration, observable, operationId, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, span, span, subscriber, succeed, 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.CouchbaseMessage
creationTime
Methods inherited from interface com.couchbase.client.core.message.CouchbaseRequest
bucket, complete, dispatchHostname, dispatchHostname, emit, fail, incrementRetryCount, isActive, lastLocalId, lastLocalId, lastLocalSocket, lastLocalSocket, lastRemoteSocket, lastRemoteSocket, maxRetryDuration, maxRetryDuration, observable, operationId, password, retryAfter, retryAfter, retryCount, retryDelay, retryDelay, span, span, subscriber, succeed, username
-
Method Details
-
users
-
usersFromDomain
-
user
-
path
- Specified by:
path
in interfaceConfigRequest
-