org.xwiki.job.JobStatusStore Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-job-api Show documentation

XWiki Commons - Job - API

There is a newer version: 16.10.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;

import java.util.List;

import org.xwiki.component.annotation.Role;
import org.xwiki.job.event.status.JobStatus;
import org.xwiki.logging.LogQueue;
import org.xwiki.logging.tail.LoggerTail;

/**
 * Store and retrieve {@link JobStatus} instances.
 *
 * @version $Id: 9e4d7426de391d6c141d382d4da13a0342d869cd $
 * @since 6.1M2
 */
@Role
public interface JobStatusStore
{
    /**
     * @param id the id of the job
     * @return the job status or null if there's no matching job id
     */
    JobStatus getJobStatus(List id);

    /**
     * @param status the job status
     */
    void store(JobStatus status);

    /**
     * @param status the job status
     */
    void storeAsync(JobStatus status);

    /**
     * @param id the id of the job
     */
    void remove(List id);

    /**
     * @param jobId the identifier of the job
     * @param readonly true of the log is readonly
     * @return the {@link LoggerTail} instance
     * @since 11.9RC1
     */
    default LoggerTail createLoggerTail(List jobId, boolean readonly)
    {
        return new LogQueue();
    }
}