JobLogResource.java

/*
 * 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.rest.resources.job;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;

import org.xwiki.rest.XWikiRestException;
import org.xwiki.rest.model.jaxb.JobLog;

/**
 * @version $Id: b799ccd3c46fa01e92ecd8eca3b82e96381b8f63 $
 * @since 7.2M3
 */
@Path("/" + JobLogResource.NAME + "/{jobId: .+}")
public interface JobLogResource
{
    /**
     * The entry name of the resource.
     * 
     * @since 8.0
     */
    String NAME = "joblog";

    /**
     * @param jobId the identifier of the job
     * @param level the level of the log to filter (exact level)
     * @param fromLevel the level of the log to filter from
     * @return the job log
     * @throws XWikiRestException when failing to get the job log
     */
    @GET
    JobLog getJobLog(@PathParam("jobId") String jobId, @QueryParam("level") String level,
        @QueryParam("fromLevel") String fromLevel) throws XWikiRestException;
}