com.hcl.domino.admin.replication.ReplicaInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * 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 .
 *
 * 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.hcl.domino.admin.replication;

import java.time.temporal.TemporalAccessor;
import java.util.Optional;
import java.util.Set;

import com.hcl.domino.data.Database;
import com.hcl.domino.data.DominoDateTime;
import com.hcl.domino.data.IAdaptable;

public interface ReplicaInfo extends IAdaptable {

  public enum Priority {
    LOW, MEDIUM, HIGH
  }

  /**
   * Replication cutoff date
   *
   * @return an {@link Optional} describing the cutoff date if set, or an empty
   *         one otherwise
   */
  Optional getCutOff();

  /**
   * Automatic Replication Cutoff Interval (Days)
   *
   * @return interval
   */
  int getCutOffInterval();

  /**
   * Returns the database this replica info belongs to
   *
   * @return parent database
   */
  Database getParentDatabase();

  /**
   * Reads the current replication priority
   *
   * @return priority
   */
  Priority getPriority();

  /**
   * Returns the replica ID as hex encoded string with 16 characters
   *
   * @return replica id
   */
  String getReplicaID();

  /**
   * Returns the replication ID which is same for all replica files
   *
   * @return ID
   */
  DominoDateTime getReplicaIDAsDate();

  Set getReplicationFlags();

  /**
   * Checks if the database design is hidden
   *
   * @return true if hidden
   */
  boolean isDesignHidden();

  /**
   * Returns true if a replication flag is set
   *
   * @param flag flag
   * @return true if set
   */
  boolean isReplicationFlagSet(ReplicationFlags flag);

  /**
   * Sets the new cutoff date
   *
   * @param cutOff date
   */
  void setCutOff(TemporalAccessor cutOff);

  /**
   * Sets the Automatic Replication Cutoff Interval (Days)
   *
   * @param interval (WORD)
   */
  void setCutOffInterval(int interval);

  /**
   * Computes a new replica id and calls {@link #setReplicaID(String)}
   *
   * @return the new replica id
   */
  String setNewReplicaId();

  /**
   * Changes the replication priority
   *
   * @param priority new priority
   */
  void setPriority(Priority priority);

  /**
   * Method to set the replica ID as hex encoded string with 16 characters
   *
   * @param replicaId new replica id, either 16 characters of 8:8 format
   */
  void setReplicaID(String replicaId);

  /**
   * Sets the replication ID which is same for all replica files
   *
   * @param newID new ID
   */
  void setReplicaIDAsDate(TemporalAccessor newID);

  /**
   * Method to change a replication flag
   *
   * @param flag flag to change
   * @param on   new flag value (on or off)
   */
  void setReplicationFlag(ReplicationFlags flag, boolean on);

}