org.xwiki.job.internal.DefaultJobProgressManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-job-default Show documentation
XWiki Commons - Job - Default
There is a newer version: 16.10.0-rc-1
Show newest version
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.job.internal;

import java.util.concurrent.Callable;

import javax.inject.Inject;
import javax.inject.Singleton;

import org.xwiki.component.annotation.Component;
import org.xwiki.job.event.status.EndStepProgressEvent;
import org.xwiki.job.event.status.JobProgressManager;
import org.xwiki.job.event.status.PopLevelProgressEvent;
import org.xwiki.job.event.status.PushLevelProgressEvent;
import org.xwiki.job.event.status.StartStepProgressEvent;
import org.xwiki.job.event.status.StepProgressEvent;
import org.xwiki.logging.Message;
import org.xwiki.observation.ObservationManager;

/**
 * Default implementation of {@link JobProgressManager}.
 *
 * @version $Id: 5ef7c236e2af934ffec5f7f67adbbb9a54733fac $
 * @since 6.1M1
 */
@Component
@Singleton
public class DefaultJobProgressManager implements JobProgressManager
{
    @Inject
    private ObservationManager observationManager;

    @Override
    public void pushLevelProgress(Object source)
    {
        this.observationManager.notify(new PushLevelProgressEvent(), source);
    }

    @Override
    public void pushLevelProgress(int steps, Object source)
    {
        this.observationManager.notify(new PushLevelProgressEvent(steps), source);
    }

    @Override
    @Deprecated
    public void stepPropress(Object source)
    {
        this.observationManager.notify(StepProgressEvent.INSTANCE, source);
    }

    @Override
    public void startStep(Object source)
    {
        startStep(source, (Message) null);
    }

    @Override
    public void startStep(Object source, String name)
    {
        startStep(source, toMessage(name));
    }

    @Override
    public void startStep(Object source, Message message)
    {
        this.observationManager.notify(StartStepProgressEvent.INSTANCE, source, message);
    }

    @Override
    public void startStep(Object source, String translationKey, String message, Object... arguments)
    {
        startStep(source, toMessage(translationKey, message, arguments));
    }

    @Override
    public void endStep(Object source)
    {
        this.observationManager.notify(EndStepProgressEvent.INSTANCE, source);
    }

    @Override
    public void popLevelProgress(Object source)
    {
        this.observationManager.notify(PopLevelProgressEvent.INSTANCE, source);
    }

    @Override
    public  T call(Callable task, Object source) throws Exception
    {
        pushLevelProgress(source);

        try {
            return task.call();
        } finally {
            popLevelProgress(source);
        }
    }

    @Override
    public  T call(Callable task, int steps, Object source) throws Exception
    {
        pushLevelProgress(steps, source);

        try {
            return task.call();
        } finally {
            popLevelProgress(source);
        }
    }

    private Message toMessage(String name)
    {
        return name != null ? new Message(name) : null;
    }

    private Message toMessage(String translationKey, String message, Object[] arguments)
    {
        return new Message(translationKey, message, arguments);
    }
}