WikiInitializerRequest.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 com.xpn.xwiki.internal;

import java.util.Arrays;
import java.util.List;

import org.xwiki.job.AbstractRequest;
import org.xwiki.job.Request;

/**
 * Request to use with {@link WikiInitializerJob}.
 *
 * @version $Id: de4d7e8fe06869f184d054a013fd99546a0e78ce $
 * @since 8.4RC1
 */
public class WikiInitializerRequest extends AbstractRequest
{
    private String wikiId;

    /**
     * @param wikiId the identifier of the wiki to initialize
     */
    public WikiInitializerRequest(String wikiId)
    {
        setId(toJobId(wikiId));
        setInteractive(false);

        this.wikiId = wikiId;
    }

    /**
     * @param request the request to copy
     */
    public WikiInitializerRequest(Request request)
    {
        super(request);
    }

    /**
     * @param wikiId the identifier of the wiki
     * @return the Job id corresponding to the passed wiki identifier
     */
    public static List<String> toJobId(String wikiId)
    {
        return Arrays.asList("initialization", "wiki", wikiId);
    }

    /**
     * @return The identifier of the wiki to initialize
     */
    public String getWikiId()
    {
        return this.wikiId;
    }
}