ICSWConfigurer.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.ws;

import java.io.File;
import java.util.List;
import org.constellation.configuration.AcknowlegementType;
import org.constellation.configuration.BriefNode;
import org.constellation.configuration.ConfigurationException;
import org.constellation.configuration.StringList;
import org.constellation.metadata.io.MetadataType;
import org.w3c.dom.Node;

/**
 *
 * @author Guilhem Legal (Geomatys)
 */
public interface ICSWConfigurer {
    
    AcknowlegementType refreshIndex(final String id, final boolean asynchrone, final boolean forced) throws ConfigurationException;
    
    /**
     * Add some CSW record to the index.
     *
     * @param id identifier of the CSW service.
     * @param identifierList list of metadata identifier to add into the index.
     *
     * @return
     * @throws ConfigurationException
     */
    AcknowlegementType addToIndex(final String id, final List<String> identifierList) throws ConfigurationException;

    /**
     * Remove some CSW record to the index.
     *
     * @param id identifier of the CSW service.
     * @param identifierList list of metadata identifier to add into the index.
     *
     * @return
     * @throws ConfigurationException
     */
    AcknowlegementType removeFromIndex(final String id, final List<String> identifierList) throws ConfigurationException;


    /**
     * Stop all the indexation going on.
     *
     * @param id identifier of the CSW service.
     * @return an Acknowledgment.
     */
    AcknowlegementType stopIndexation(final String id);

    AcknowlegementType importRecords(final String id, final File f, final String fileName) throws ConfigurationException ;
    
    AcknowlegementType importRecord(final String id, final Node n) throws ConfigurationException;

    AcknowlegementType removeRecords(final String id, final String identifierList) throws ConfigurationException;
    
    AcknowlegementType removeAllRecords(final String id) throws ConfigurationException;

    AcknowlegementType metadataExist(final String id, final String metadataName) throws ConfigurationException;

    List<BriefNode> getMetadataList(final String id, final int count, final int startIndex) throws ConfigurationException;
    
    List<Node> getFullMetadataList(final String id, final int count, final int startIndex, MetadataType type) throws ConfigurationException;

    Node getMetadata(final String id, final String metadataName) throws ConfigurationException;
    
    int getMetadataCount(final String id) throws ConfigurationException;

    StringList getAvailableCSWDataSourceType();
    
    String getImplementation(final String id) throws ConfigurationException;
   
}