RefreshIndexDescriptor.java

/*
 *    Constellation - An open source and standard compliant SDI
 *    http://www.constellation-sdi.org
 *
 * Copyright 2014 Geomatys.
 *
 * 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 org.constellation.admin.process;

import org.apache.sis.parameter.ParameterBuilder;
import org.apache.sis.util.iso.SimpleInternationalString;
import org.constellation.process.ConstellationProcessFactory;
import org.geotoolkit.client.AbstractClientFactory;
import org.geotoolkit.process.Process;
import org.geotoolkit.processing.AbstractProcessDescriptor;
import org.opengis.parameter.GeneralParameterDescriptor;
import org.opengis.parameter.ParameterDescriptor;
import org.opengis.parameter.ParameterDescriptorGroup;
import org.opengis.parameter.ParameterValueGroup;

/**
 *
 * @author Guilhem Legal (Geomatys)
 */
public class RefreshIndexDescriptor extends AbstractProcessDescriptor {
 
    public static final String NAME = "refreshIndex";

    private static final ParameterBuilder BUILDER = new ParameterBuilder();

    // Constellation
    public static final GeneralParameterDescriptor CSTL_CSW_INSTANCE = BUILDER
            .addName("CSWInstance")
            .setRemarks("Name of the CSW instance.")
            .setRequired(true)
            .create(String.class, null);

    public static final GeneralParameterDescriptor CSTL_ASYNCHRONOUS = BUILDER
            .addName("Asynchronous")
            .setRemarks("Flag for asynchronous refresh index mode.")
            .setRequired(true)
            .create(Boolean.class, Boolean.TRUE);

    public static final ParameterDescriptor<String> USER = BUILDER
            .addName("User")
            .setRemarks("User login")
            .setRequired(true)
            .create(String.class,null);

    public static final ParameterDescriptor<String> PASSWORD = BUILDER
            .addName("Password")
            .setRemarks("User password")
            .setRequired(true)
            .create(String.class,null);

    public static final ParameterDescriptorGroup CSTL_DESCRIPTOR_GROUP = BUILDER.addName("Constellation").setRequired(true)
                    .createGroup(AbstractClientFactory.URL,
                            USER,
                            PASSWORD,
                            CSTL_CSW_INSTANCE,
                            CSTL_ASYNCHRONOUS);

    /**Input parameters */
    public static final ParameterDescriptorGroup INPUT_DESC = BUILDER.addName("InputParameters").setRequired(true)
            .createGroup(CSTL_DESCRIPTOR_GROUP);

    /** Output parameters : nothing */
    public static final ParameterDescriptorGroup OUTPUT_DESC = BUILDER.addName("OutputParameters").setRequired(true)
            .createGroup();

    /**
     * Public constructor use by the ServiceRegistry to find and intanciate all ProcessDescriptor.
     */
    public RefreshIndexDescriptor() {
        super(NAME, ConstellationProcessFactory.IDENTIFICATION,
                new SimpleInternationalString("Refresh CSW lucene Index"), 
                INPUT_DESC, OUTPUT_DESC);
    }

    /**
     *  {@inheritDoc }
     */
    @Override
    public Process createProcess(ParameterValueGroup pvg) {
        return new RefreshIndex(this, pvg);
    }
}