/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mongodb.operation;

import com.mongodb.DuplicateKeyException;
import com.mongodb.ErrorCategory;
import com.mongodb.MongoBulkWriteException;
import com.mongodb.MongoException;
import com.mongodb.MongoNamespace;
import com.mongodb.WriteConcern;
import com.mongodb.WriteConcernException;
import com.mongodb.WriteConcernResult;
import com.mongodb.async.SingleResultCallback;
import com.mongodb.binding.AsyncWriteBinding;
import com.mongodb.binding.WriteBinding;
import com.mongodb.bulk.BulkWriteError;
import com.mongodb.bulk.BulkWriteResult;
import com.mongodb.bulk.WriteRequest;
import org.bson.BsonBoolean;
import org.bson.BsonDocument;
import org.bson.BsonInt32;
import org.bson.BsonString;

import java.util.List;

import static com.mongodb.assertions.Assertions.notNull;
import static com.mongodb.bulk.WriteRequest.Type.DELETE;
import static com.mongodb.bulk.WriteRequest.Type.INSERT;
import static com.mongodb.bulk.WriteRequest.Type.REPLACE;
import static com.mongodb.bulk.WriteRequest.Type.UPDATE;


Abstract base class for write operations.
Since:3.0
/** * Abstract base class for write operations. * * @since 3.0 */
@Deprecated public abstract class BaseWriteOperation implements AsyncWriteOperation<WriteConcernResult>, WriteOperation<WriteConcernResult> { private final WriteConcern writeConcern; private final MongoNamespace namespace; private final boolean ordered; private final boolean retryWrites; private Boolean bypassDocumentValidation;
Construct an instance
Params:
  • namespace – the database and collection namespace for the operation.
  • ordered – whether the writes are ordered.
  • writeConcern – the write concern for the operation.
Deprecated: use BaseWriteOperation(MongoNamespace, boolean, WriteConcern, boolean) instead
/** * Construct an instance * * @param namespace the database and collection namespace for the operation. * @param ordered whether the writes are ordered. * @param writeConcern the write concern for the operation. * @deprecated use {@link #BaseWriteOperation(MongoNamespace, boolean, WriteConcern, boolean)} instead */
@Deprecated public BaseWriteOperation(final MongoNamespace namespace, final boolean ordered, final WriteConcern writeConcern) { this(namespace, ordered, writeConcern, false); }
Construct an instance
Params:
  • namespace – the database and collection namespace for the operation.
  • ordered – whether the writes are ordered.
  • writeConcern – the write concern for the operation.
  • retryWrites – if writes should be retried if they fail due to a network error.
Since:3.6
/** * Construct an instance * * @param namespace the database and collection namespace for the operation. * @param ordered whether the writes are ordered. * @param writeConcern the write concern for the operation. * @param retryWrites if writes should be retried if they fail due to a network error. * @since 3.6 */
public BaseWriteOperation(final MongoNamespace namespace, final boolean ordered, final WriteConcern writeConcern, final boolean retryWrites) { this.ordered = ordered; this.namespace = notNull("namespace", namespace); this.writeConcern = notNull("writeConcern", writeConcern); this.retryWrites = retryWrites; } protected abstract List<? extends WriteRequest> getWriteRequests(); protected abstract WriteRequest.Type getType();
Gets the namespace of the collection to write to.
Returns:the namespace
/** * Gets the namespace of the collection to write to. * * @return the namespace */
public MongoNamespace getNamespace() { return namespace; }
Gets the write concern to apply
Returns:the write concern
/** * Gets the write concern to apply * * @return the write concern */
public WriteConcern getWriteConcern() { return writeConcern; }
Gets whether the writes are ordered. If true, no more writes will be executed after the first failure.
Returns:whether the writes are ordered
/** * Gets whether the writes are ordered. If true, no more writes will be executed after the first failure. * * @return whether the writes are ordered */
public boolean isOrdered() { return ordered; }
Gets the the bypass document level validation flag
Returns:the bypass document level validation flag
Since:3.2
@mongodb.server.release3.2
/** * Gets the the bypass document level validation flag * * @return the bypass document level validation flag * @since 3.2 * @mongodb.server.release 3.2 */
public Boolean getBypassDocumentValidation() { return bypassDocumentValidation; }
Sets the bypass document level validation flag.
Params:
  • bypassDocumentValidation – If true, allows the write to opt-out of document level validation.
Returns:this
Since:3.2
@mongodb.server.release3.2
/** * Sets the bypass document level validation flag. * * @param bypassDocumentValidation If true, allows the write to opt-out of document level validation. * @return this * @since 3.2 * @mongodb.server.release 3.2 */
public BaseWriteOperation bypassDocumentValidation(final Boolean bypassDocumentValidation) { this.bypassDocumentValidation = bypassDocumentValidation; return this; } @Override public WriteConcernResult execute(final WriteBinding binding) { try { BulkWriteResult result = getMixedBulkOperation().execute(binding); if (result.wasAcknowledged()) { return translateBulkWriteResult(result); } else { return WriteConcernResult.unacknowledged(); } } catch (MongoBulkWriteException e) { throw convertBulkWriteException(e); } } @Override public void executeAsync(final AsyncWriteBinding binding, final SingleResultCallback<WriteConcernResult> callback) { getMixedBulkOperation().executeAsync(binding, new SingleResultCallback<BulkWriteResult>() { @Override public void onResult(final BulkWriteResult result, final Throwable t) { if (t != null) { if (t instanceof MongoBulkWriteException) { callback.onResult(null, convertBulkWriteException((MongoBulkWriteException) t)); } else { callback.onResult(null, t); } } else if (result.wasAcknowledged()) { callback.onResult(translateBulkWriteResult(result), null); } else { callback.onResult(WriteConcernResult.unacknowledged(), null); } } } ); } private MixedBulkWriteOperation getMixedBulkOperation() { return new MixedBulkWriteOperation(namespace, getWriteRequests(), ordered, writeConcern, retryWrites) .bypassDocumentValidation(bypassDocumentValidation); } @SuppressWarnings("deprecation") private MongoException convertBulkWriteException(final MongoBulkWriteException e) { BulkWriteError lastError = getLastError(e); if (lastError != null) { if (ErrorCategory.fromErrorCode(lastError.getCode()) == ErrorCategory.DUPLICATE_KEY) { return new DuplicateKeyException(manufactureGetLastErrorResponse(e), e.getServerAddress(), translateBulkWriteResult(e.getWriteResult())); } else { return new WriteConcernException(manufactureGetLastErrorResponse(e), e.getServerAddress(), translateBulkWriteResult(e.getWriteResult())); } } else { return new WriteConcernException(manufactureGetLastErrorResponse(e), e.getServerAddress(), translateBulkWriteResult(e.getWriteResult())); } } private BsonDocument manufactureGetLastErrorResponse(final MongoBulkWriteException e) { BsonDocument response = new BsonDocument(); addBulkWriteResultToResponse(e.getWriteResult(), response); if (e.getWriteConcernError() != null) { response.putAll(e.getWriteConcernError().getDetails()); } if (getLastError(e) != null) { response.put("err", new BsonString(getLastError(e).getMessage())); response.put("code", new BsonInt32(getLastError(e).getCode())); response.putAll(getLastError(e).getDetails()); } else if (e.getWriteConcernError() != null) { response.put("err", new BsonString(e.getWriteConcernError().getMessage())); response.put("code", new BsonInt32(e.getWriteConcernError().getCode())); } return response; } private void addBulkWriteResultToResponse(final BulkWriteResult bulkWriteResult, final BsonDocument response) { response.put("ok", new BsonInt32(1)); if (getType() == INSERT) { response.put("n", new BsonInt32(0)); } else if (getType() == DELETE) { response.put("n", new BsonInt32(bulkWriteResult.getDeletedCount())); } else if (getType() == UPDATE || getType() == REPLACE) { response.put("n", new BsonInt32(bulkWriteResult.getMatchedCount() + bulkWriteResult.getUpserts().size())); if (bulkWriteResult.getUpserts().isEmpty()) { response.put("updatedExisting", BsonBoolean.TRUE); } else { response.put("updatedExisting", BsonBoolean.FALSE); response.put("upserted", bulkWriteResult.getUpserts().get(0).getId()); } } } private WriteConcernResult translateBulkWriteResult(final BulkWriteResult bulkWriteResult) { return WriteConcernResult.acknowledged(getCount(bulkWriteResult), getUpdatedExisting(bulkWriteResult), bulkWriteResult.getUpserts().isEmpty() ? null : bulkWriteResult.getUpserts().get(0).getId()); } private int getCount(final BulkWriteResult bulkWriteResult) { int count = 0; if (getType() == UPDATE || getType() == REPLACE) { count = bulkWriteResult.getMatchedCount() + bulkWriteResult.getUpserts().size(); } else if (getType() == DELETE) { count = bulkWriteResult.getDeletedCount(); } return count; } private boolean getUpdatedExisting(final BulkWriteResult bulkWriteResult) { if (getType() == UPDATE) { return bulkWriteResult.getMatchedCount() > 0; } return false; } private BulkWriteError getLastError(final MongoBulkWriteException e) { return e.getWriteErrors().isEmpty() ? null : e.getWriteErrors().get(e.getWriteErrors().size() - 1); } }