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

import org.apache.felix.scr.annotations.Activate;
import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.ConfigurationPolicy;
import org.apache.felix.scr.annotations.Properties;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.resource.ResourceResolverFactory;
import org.apache.sling.commons.osgi.PropertiesUtil;
import org.apache.sling.commons.scheduler.Scheduler;
import org.apache.sling.distribution.component.impl.DistributionComponentConstants;
import org.apache.sling.distribution.queue.impl.DistributionQueueProvider;
import org.apache.sling.distribution.queue.impl.DistributionQueueProviderFactory;
import org.osgi.framework.BundleContext;

import java.util.Map;

@Component(metatype = true,
            label = "Apache Sling Resource Queue Provider Factory",
            description = "OSGi configuration factory for Resource-backed queues",
            configurationFactory = true,
            policy = ConfigurationPolicy.REQUIRE)
@Service(DistributionQueueProviderFactory.class)
@Properties({
        @Property(name = DistributionComponentConstants.PN_NAME, value = "resourceQueue"),
        @Property(name = ResourceQueueProviderFactory.PN_IS_ACTIVE,
                label = "Should the Resource-backed queue created with a Queue Processor (i.e., ACTIVE)",
                boolValue = {false})
})
public class ResourceQueueProviderFactory implements DistributionQueueProviderFactory {

    static final String PN_IS_ACTIVE = "queue.isActive";

    @Reference
    ResourceResolverFactory resourceResolverFactory;
    @Reference
    Scheduler scheduler;

    BundleContext context;

    private boolean isActive;

    @Activate
    protected void activate(BundleContext context, Map<String, Object> config)
    {
        this.isActive = PropertiesUtil.toBoolean(PN_IS_ACTIVE, false);
        this.context = context;
    }

    @Override
    public DistributionQueueProvider getProvider(String agentName, String serviceName) {
        return new ResourceQueueProvider(context, resourceResolverFactory, serviceName, agentName, scheduler, isActive);
    }

    @Override
    public void releaseProvider(DistributionQueueProvider queueProvider) {
        if (queueProvider instanceof ResourceQueueProvider) {
            ((ResourceQueueProvider) queueProvider).close();
        }
    }
}