geode-core/src/main/java/org/apache/geode/cache/persistence/PartitionOfflineException.java

/*
 * 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.util.Set;

import org.apache.geode.GemFireException;

/**
 * Thrown when a paritioned region is configured for disk persistence, and part of the data is
 * stored on members that are known to be offline.
 *
 * With a partitioned region, the keyspace is segmented into buckets which are assigned to
 * individual members. If all members that are storing data for a particular bucket are offline, any
 * attempt to access or update data in that bucket will throw this exception.
 *
 * If you see this exception, that means that you need to restart the members that host the missing
 * data.
 *
 * If you receive this exception when attempting an operation that modifies the region (such as a
 * put), it is possible that the change was actually persisted to disk before the member went
 * offline.
 *
 * @since GemFire 6.5
 *
 */
public class PartitionOfflineException extends GemFireException {

  private static final long serialVersionUID = -6471045959318795870L;

  private Set<PersistentID> offlineMembers;

  public PartitionOfflineException(Set<PersistentID> offlineMembers) {
    super();
    this.offlineMembers = offlineMembers;
  }

  public PartitionOfflineException(Set<PersistentID> offlineMembers, String message) {
    super(message);
    this.offlineMembers = offlineMembers;
  }

  public PartitionOfflineException(Set<PersistentID> offlineMembers, String message,
      Throwable cause) {
    super(message, cause);
    this.offlineMembers = offlineMembers;
  }

  public PartitionOfflineException(Set<PersistentID> offlineMembers, Throwable cause) {
    super(cause);
    this.offlineMembers = offlineMembers;
  }

  /**
   * Retrieve the set of disk directories which are known to hold data for the missing buckets, but
   * are not online.
   */
  public Set<PersistentID> getOfflineMembers() {
    return (Set<PersistentID>) offlineMembers;
  }

}