com.gemstone.gemfire.cache.snapshot.RegionSnapshotService Maven / Gradle / Ivy
/*
* Copyright (c) 2010-2015 Pivotal Software, Inc. 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
*
* 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. See accompanying
* LICENSE file.
*/
package com.gemstone.gemfire.cache.snapshot;
import java.io.File;
import java.io.IOException;
import com.gemstone.gemfire.DataSerializer;
import com.gemstone.gemfire.Instantiator;
import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.cache.snapshot.SnapshotOptions.SnapshotFormat;
import com.gemstone.gemfire.pdx.PdxSerializer;
/**
* Allows a snapshot of region data to be imported and exported. Example usage:
*
*
* // obtain a snapshot
* RegionSnapshot snapshot = region.getSnapshotService();
*
* // export the snapshot, every region in the cache will be exported
* snapshot.save(new File("snapshot"), SnapshotOptions.GEMFIRE);
*
* // import the snapshot file, updates any existing entries in the region
* snapshot.load(new File("snapshot"), SnapshotOptions.GEMFIRE);
*
*
* The default behavior is to perform all I/O operations on the node where the
* snapshot operations are invoked. This will involve either collecting or
* dispersing data over the network if the region is a partitioned region.
* The snapshot behavior can be changed using {@link SnapshotOptions}. For example:
*
* RegionSnapshotService snapshot = region.getSnapshotService();
* SnapshotFilter filter = new SnapshotFilter() {
* public boolean accept(Entry entry) {
* return true;
* }
* };
*
* SnapshotOptions options = snapshot.createOptions();
* options.setFilter(filter);
*
* snapshot.save(new File("snapshot"), SnapshotFormat.GEMFIRE, options);
*
* Note that the snapshot does not provide a consistency guarantee. Updates to
* data during the course of import/export operations could result data
* inconsistencies.
*
* @param the cache entry key type
* @param the cache entry value type
*
* @see Region#getSnapshotService()
* @see SnapshotOptions
*
* @author bakera
* @since 7.0
*/
public interface RegionSnapshotService {
/**
* Creates a SnapshotOptions object configured with default
* settings. The options can be used to configure snapshot behavior.
*
* @return the default options
*/
SnapshotOptions createOptions();
/**
* Exports the region data into the snapshot file.
*
* @param snapshot the snapshot file
* @param format the snapshot format
*
* @throws IOException error writing snapshot
*/
void save(File snapshot, SnapshotFormat format)
throws IOException;
/**
* Exports the region data into the snapshot file by applying user-configured
* options.
*
* @param snapshot the snapshot file
* @param format the snapshot format
* @param options the snapshot options
*
* @throws IOException error writing snapshot
*/
void save(File snapshot, SnapshotFormat format, SnapshotOptions options)
throws IOException;
/**
* Imports the snapshot file into the specified region.
*
* Prior to loading data, the region should have been created and
* any necessary serializers (either {@link DataSerializer} or
* {@link PdxSerializer}) and {@link Instantiator}s should have been
* registered.
*
* @param snapshot the snapshot file
* @param format the snapshot file format
*
* @throws IOException Unable to import data
* @throws ClassNotFoundException Unable to import data
*/
void load(File snapshot, SnapshotFormat format)
throws IOException, ClassNotFoundException;
/**
* Imports the snapshot file into the specified region by applying user-
* configured options.
*
* Prior to loading data, the region should have been created and
* any necessary serializers (either {@link DataSerializer} or
* {@link PdxSerializer}) and {@link Instantiator}s should have been
* registered.
*
* @param snapshot the snapshot file
* @param format the snapshot file format
* @param options the snapshot options
*
* @throws IOException Unable to import data
* @throws ClassNotFoundException Unable to import data
*/
void load(File snapshot, SnapshotFormat format, SnapshotOptions options)
throws IOException, ClassNotFoundException;
}