001/*
002 * (C) Copyright 2016 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 */
017package org.nuxeo.ecm.platform.importer.mqueues.pattern.producer;
018
019import org.nuxeo.ecm.platform.importer.mqueues.pattern.Message;
020
021import java.util.Iterator;
022
023/**
024 * A ProducerIterator returns {@link Message}.
025 *
026 * It also has the logic to return a partition index, that will be used to run concurrent consumers.
027 *
028 * @since 9.1
029 */
030public interface ProducerIterator<M extends Message> extends Iterator<M>, AutoCloseable {
031
032    /**
033     * The remove method is not needed.
034     */
035    @Override
036    default void remove() {
037        throw new UnsupportedOperationException();
038    }
039
040    /**
041     * Returns a partition associated with the {@link Message}.
042     *
043     * The value returned must be between 0 and lower than partitions.
044     *
045     * @param message the message to shard
046     * @param partitions the number of partitions
047     */
048    int getPartition(M message, int partitions);
049
050
051}
052