alluxio-master-2.x/core/server/master/src/main/java/alluxio/master/file/contexts/CompleteFileContext.java
/*
 * The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
 * (the "License"). You may not use this work except in compliance with the License, which is
 * available at www.apache.org/licenses/LICENSE-2.0
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied, as more fully set forth in the License.
 *
 * See the NOTICE file distributed with this work for information regarding copyright ownership.
 */

package alluxio.master.file.contexts;

import alluxio.grpc.CompleteFilePOptions;
import alluxio.master.file.FileSystemMasterOptions;
import alluxio.underfs.UfsStatus;
import alluxio.wire.OperationId;

import com.google.common.base.MoreObjects;

/**
 * Used to merge and wrap {@link CompleteFilePOptions}.
 */
public class CompleteFileContext
    extends OperationContext<CompleteFilePOptions.Builder, CompleteFileContext> {

  private long mOperationTimeMs;
  private UfsStatus mUfsStatus;
  private boolean mMetadataLoad = false;

  /**
   * Creates rename context with given option data.
   *
   * @param mergedOptionsBuilder options builder
   */
  private CompleteFileContext(CompleteFilePOptions.Builder mergedOptionsBuilder) {
    super(mergedOptionsBuilder);
    mOperationTimeMs = System.currentTimeMillis();
    mUfsStatus = null;
  }

  /**
   * @param metadataLoad the flag value to use; if true, the operation is a result of a metadata
   *        load
   * @return the updated context
   */
  public CompleteFileContext setMetadataLoad(boolean metadataLoad) {
    mMetadataLoad = metadataLoad;
    return this;
  }

  /**
   * @return the metadataLoad flag; if true, the operation is a result of a metadata load
   */
  public boolean isMetadataLoad() {
    return mMetadataLoad;
  }

  /**
   * @param optionsBuilder Builder for proto {@link CompleteFilePOptions}
   * @return the instance of {@link CompleteFileContext} with given options
   */
  public static CompleteFileContext create(CompleteFilePOptions.Builder optionsBuilder) {
    return new CompleteFileContext(optionsBuilder);
  }

  /**
   * Merges and embeds the given {@link CompleteFilePOptions} with the corresponding master options.
   *
   * @param optionsBuilder Builder for proto {@link CompleteFilePOptions} to merge with defaults
   * @return the instance of {@link CompleteFileContext} with default values for master
   */
  public static CompleteFileContext mergeFrom(CompleteFilePOptions.Builder optionsBuilder) {
    CompleteFilePOptions masterOptions = FileSystemMasterOptions.completeFileDefaults();
    CompleteFilePOptions.Builder mergedOptionsBuilder =
        masterOptions.toBuilder().mergeFrom(optionsBuilder.build());
    return create(mergedOptionsBuilder);
  }

  /**
   * @return the instance of {@link CompleteFileContext} with default values for master
   */
  public static CompleteFileContext defaults() {
    return create(FileSystemMasterOptions.completeFileDefaults().toBuilder());
  }

  /**
   * @return the ufs status
   */
  public UfsStatus getUfsStatus() {
    return mUfsStatus;
  }

  /**
   * Sets ufs status.
   *
   * @param ufsStatus ufs status
   * @return the updated context instance
   */
  public CompleteFileContext setUfsStatus(UfsStatus ufsStatus) {
    mUfsStatus = ufsStatus;
    return this;
  }

  /**
   * @return the operation system time in ms
   */
  public long getOperationTimeMs() {
    return mOperationTimeMs;
  }

  /**
   * Sets operation time.
   *
   * @param operationTimeMs operation system time in ms
   * @return the updated context instance
   */
  public CompleteFileContext setOperationTimeMs(long operationTimeMs) {
    mOperationTimeMs = operationTimeMs;
    return this;
  }

  @Override
  public OperationId getOperationId() {
    if (getOptions().hasCommonOptions() && getOptions().getCommonOptions().hasOperationId()) {
      return OperationId.fromFsProto(getOptions().getCommonOptions().getOperationId());
    }
    return super.getOperationId();
  }

  @Override
  public String toString() {
    return MoreObjects.toStringHelper(this)
        .add("ProtoOptions", getOptions().build())
        .add("UfsStatus", mUfsStatus.toString())
        .add("OperationTimeMs", mOperationTimeMs)
        .toString();
  }
}
