com.adobe.acs.commons.util.RunnableOnMaster Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of acs-aem-commons-bundle Show documentation

Main ACS AEM Commons OSGi Bundle. Includes commons utilities.

There is a newer version: 6.6.0

Show newest version

/*
 * #%L
 * ACS AEM Commons Bundle
 * %%
 * Copyright (C) 2013 Adobe
 * %%
 * 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.
 * #L%
 */
package com.adobe.acs.commons.util;

import org.osgi.annotation.versioning.ConsumerType;
import org.apache.sling.discovery.TopologyEvent;

import org.apache.sling.discovery.TopologyEventListener;

/**
 * Abstract base class for scheduled job to be run only on the cluster master.
 * @deprecated Depend on marker interface {@link ClusterLeader} instead.
 */
@Deprecated
@ConsumerType
public abstract class RunnableOnMaster implements TopologyEventListener, Runnable {

    private volatile boolean isLeader;

    /**
     * Run the scheduled job.
     */
    protected abstract void runOnMaster();

    /**
     * {@inheritDoc}
     */
    @Override
    public void handleTopologyEvent(TopologyEvent te) {
        this.isLeader = te.getNewView().getLocalInstance().isLeader();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public final void run() {
        if (isLeader) {
            runOnMaster();
        }
    }

}