com.netflix.astyanax.query.CheckpointManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of astyanax-cassandra Show documentation

astyanax-cassandra

There is a newer version: 3.9.0

/**
 * Copyright 2013 Netflix, Inc.
 *
 * 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.
 */
package com.netflix.astyanax.query;

import java.util.SortedMap;

import com.netflix.astyanax.connectionpool.exceptions.ConnectionException;

/**
 * Interface for tracking checkpoints for a getAllRows query.  
 * The entire token range is split into a sorted set of start tokens.  Each start token is
 * mapped to a checkpoint with the following possible values
 * 1.  startToken - start of the token range
 * 2.  nextToken  - the checkpoint equals the next token in the sorted set of start tokens.  This means the range is done
 * 3.  > startToken AND < nextToken - a valid checkpoint 
 * 
 * @author elandau
 *
 */
public interface CheckpointManager {
	/**
	 * Track the checkpoint for a specific range
	 * 
	 * @param startToken
	 * @param checkpointToken
	 * @throws Exception 
	 */
	void trackCheckpoint(String startToken, String checkpointToken) throws Exception;
	
	/**
	 * Get the next checkpoint after the specified token.  Will return null if no checkpoint was set.
	 */
	String getCheckpoint(String startToken) throws Exception ;
	
	/**
	 * Return a sorted map of start tokens to their checkpoint
	 * @throws ConnectionException 
	 */
	SortedMap getCheckpoints() throws Exception;
	
}