com.mongodb.operation

Class UpdateUserOperation

java.lang.Object

com.mongodb.operation.UpdateUserOperation

All Implemented Interfaces:

AsyncWriteOperation<Void>, WriteOperation<Void>

public class UpdateUserOperation
extends Object
implements AsyncWriteOperation<Void>, WriteOperation<Void>

An operation that updates a user.

Since:

3.0

Constructor Summary

Constructors

Constructor and Description
UpdateUserOperation(MongoCredential credential, boolean readOnly) Deprecated. Prefer UpdateUserOperation(MongoCredential, boolean, WriteConcern)
UpdateUserOperation(MongoCredential credential, boolean readOnly, WriteConcern writeConcern) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
Void	execute(WriteBinding binding) General execute which can return anything of type T
void	executeAsync(AsyncWriteBinding binding, SingleResultCallback<Void> callback) General execute which can return anything of type T
MongoCredential	getCredential() Gets the users credentials.
boolean	isReadOnly() Returns true if the user is a readOnly user.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateUserOperation

@Deprecated
public UpdateUserOperation(MongoCredential credential,
                                       boolean readOnly)

Deprecated. Prefer UpdateUserOperation(MongoCredential, boolean, WriteConcern)

Construct a new instance.

Parameters:

credential - the users credentials.

readOnly - true if the user is a readOnly user.

UpdateUserOperation

public UpdateUserOperation(MongoCredential credential,
                           boolean readOnly,
                           WriteConcern writeConcern)

Construct a new instance.

Parameters:

credential - the users credentials.

readOnly - true if the user is a readOnly user.

writeConcern - the write concern

Since:

3.4

Method Detail

getCredential

public MongoCredential getCredential()

Gets the users credentials.

Returns:

the users credentials.

isReadOnly

public boolean isReadOnly()

Returns true if the user is a readOnly user.

Returns:

true if the user is a readOnly user.

execute

public Void execute(WriteBinding binding)

Description copied from interface: WriteOperation

General execute which can return anything of type T

Specified by:

execute in interface WriteOperation<Void>

Parameters:

binding - the binding to execute in the context of

Returns:

T, the result of the execution

executeAsync

public void executeAsync(AsyncWriteBinding binding,
                         SingleResultCallback<Void> callback)

Description copied from interface: AsyncWriteOperation

General execute which can return anything of type T

Specified by:

executeAsync in interface AsyncWriteOperation<Void>

Parameters:

binding - the binding to execute in the context of

callback - the callback to be called when the operation has been executed