src/main/java/org/apache/sling/distribution/queue/DistributionQueueProcessor.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.sling.distribution.queue;

import javax.annotation.Nonnull;

import aQute.bnd.annotation.ProviderType;

/**
 * Processor of {@link DistributionQueueItem}s
 */
@ProviderType
public interface DistributionQueueProcessor {

    /**
     * Process an item from a certain {@link org.apache.sling.distribution.queue.DistributionQueue}
     *
     * @param queueName            the name of the {@link org.apache.sling.distribution.queue.DistributionQueue} to be processed
     * @param distributionQueueItem the {@link org.apache.sling.distribution.queue.DistributionQueueItem} to be processed
     * @return {@code true} if the item was successfully processed, {@code false} otherwise
     */
    public boolean process(@Nonnull String queueName, @Nonnull DistributionQueueItem distributionQueueItem);
}