org.apache.camel.resume.UpdatableConsumerResumeStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-api Show documentation

The Camel API

There is a newer version: 4.9.0

/*
 * 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.camel.resume;

/**
 * An updatable resume strategy
 *
 * @param  the type of the key, name or object that can be addressed by the given offset
 * @param  the type of the addressable value for the resumable object (for example, a file would use a Long value)
 * @param  a resumable type capable of handling/storing/holding resumable information for the addressable and offset
 */
public interface UpdatableConsumerResumeStrategy> {

    /**
     * Updates the last processed offset
     * 
     * @param  offset    the offset to update
     * @throws Exception if unable to update the offset
     */
    void updateLastOffset(T offset) throws Exception;
}