net.scattersphere.job.Job Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scattersphere-core Show documentation

Scattersphere Core library, used to run the main server.

The newest version!

/*
 * Scattersphere
 * Copyright 2014-2015, Scattersphere Project.
 *
 * 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.
 */

package net.scattersphere.job;

/**
 * This is an interface that allows jobs to run in the Scattersphere environment.
 *
 * Created by kenji on 11/26/14.
 */
public interface Job extends Runnable {

    /**
     * This is the preparation of the job to be run.
     *
     * @param arguments {@link String[]} containing a list of arguments.
     * @throws Exception on any errors.
     */
    void prepare(String[] arguments) throws Exception;

    /**
     * Retrieves a description of what the job does.
     *
     * @return {@code String} containing the description of the job.
     */
    String getDescription();

}