/*
 * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional information regarding
 * copyright ownership. The ASF licenses this file to You 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 org.apache.geode.cache.persistence;

import java.net.InetAddress;
import java.util.UUID;

import org.apache.geode.DataSerializable;
import org.apache.geode.admin.AdminDistributedSystem;
import org.apache.geode.cache.DataPolicy;

/**
 * A pattern describing a single member's a set of persistent files for a region. When a member has
 * a region defined with the a data policy of {@link DataPolicy#PERSISTENT_REPLICATE}, that members
 * persistent files are assigned a unique ID. After a failure of all members, during recovery, the
 * persistent members will wait for all persistent copies of the region to be recovered before
 * completing region initialization.
 *
 * This pattern describes what unique ids the currently recovering persistent members are waiting
 * for. See {@link AdminDistributedSystem#getMissingPersistentMembers()}
 *
 * @since GemFire 6.5
 *
 */
public interface PersistentID extends DataSerializable {

  /**
   * The host on which the persistent data was last residing
   *
   * @return the host on which the persistent data was last residing
   */
  InetAddress getHost();

  /**
   * The directory which the persistent data was last residing in.
   *
   * @return the directory which the persistent data was last residing in
   */
  String getDirectory();

  /**
   * The unique identifier for the persistent data.
   *
   * @return the unique identifier for the persistent data
   *
   * @since GemFire 7.0
   */
  UUID getUUID();
}
