org.xwiki.job.Request 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.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;

import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.Map;

import org.xwiki.job.event.status.JobStatus;

/**
 * A {@link Job} request.
 *
 * @version $Id: e4c5da7b3f4df3a74777f0b1a2eed809de0eaea5 $
 * @since 4.0M1
 */
public interface Request extends Serializable
{
    /**
     * @see #isRemote()
     */
    String PROPERTY_REMOTE = "remote";

    /**
     * @see #isInteractive()
     */
    String PROPERTY_INTERACTIVE = "interactive";

    /**
     * @see #getContext()
     * @since 10.10RC1
     */
    String PROPERTY_CONTEXT = "context";

    /**
     * @return list based identifier used to access the job. If none is provided the job will not be accessible by id
     *         and the status of the job will not be stored.
     * @since 4.1M2
     */
    List getId();

    /**
     * @return indicate if the job has been triggered by a remote event
     */
    boolean isRemote();

    /**
     * @return indicate if the job is allowed to ask questions if it it should be fully automated (i.e. use default
     *         answers)
     */
    boolean isInteractive();

    /**
     * @param key the name of the property
     * @param  the type of the value
     * @return the value of the property
     */
     T getProperty(String key);

    /**
     * @param key the name of the property
     * @param def the default value of the property
     * @param  the type of the value
     * @return the value of the property
     */
     T getProperty(String key, T def);

    /**
     * @return the names of all the properties
     */
    Collection getPropertyNames();

    /**
     * @param key the name of the property
     * @return {@code true} if this map contains a property for the specified key
     * @since 4.2M2
     */
    boolean containsProperty(String key);

    /**
     * @return true if the job should log informations about what is going on
     * @since 5.4RC1
     */
    boolean isVerbose();

    /**
     * @return true if the job status should be serialized, null to fallback on {@link JobStatus#isSerialized()}
     * @since 10.0
     */
    default Boolean isStatusSerialized()
    {
        return null;
    }

    /**
     * @return true if the log should be isolated from standard output, null to fallbacl on
     *         {@link JobStatus#isIsolated()}
     * @since 10.0
     */
    default Boolean isStatusLogIsolated()
    {
        return null;
    }

    /**
     * @return the context to restore in the job thread
     * @since 10.10RC1
     */
    default Map getContext()
    {
        return null;
    }

    /**
     * @param context the context to restore in the job thread.
     * @since 10.10RC1
     */
    default void setContext(Map context)
    {

    }
}