io.uhndata.cards.vocabularies.spi.VocabularyIndexer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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 io.uhndata.cards.vocabularies.spi;
import java.io.IOException;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
/**
* A {@code VocabularyIndexer} can index a vocabulary into the repository. In general, based on specific request
* parameters the {@link io.uhndata.cards.vocabularies.VocabularyIndexerServlet} will pick an implementation of this
* service, which will then download the source for a vocabulary using a {@link RepositoryHandler}, parse it using a
* {@link SourceParser} into a collection of {@code VocabularyTerm} nodes, and store these nodes in the repository.
*
* @version $Id: 73abfb58dadb32349c3189de26e282b9bbeed982 $
*/
public interface VocabularyIndexer
{
/**
* Checks whether the given source is parsable by this indexer. This only checks the format of the source value, for
* a theoretical ability to parse the data. It does not check the actual data indicated by the source, so even if
* this method returns {@code true}, the actual data may be corrupted, or in a newer or older incompatible format
* not supported. If this method returns {@code true} but the data cannot be actually parsed, then
* {@link #index(String, SlingHttpServletRequest, SlingHttpServletResponse)} will throw a
* {@link VocabularyIndexException}, which will cause
* {@link io.uhndata.cards.vocabularies.VocabularyIndexerServlet} to try the next available parser.
*
* @param source the source parameter passed in the request, usually a URL or an identifier
* @return {@code true} if the source is known to be parsable by this vocabulary parser
*/
boolean canIndex(String source);
/**
* Main method for handling vocabulary indexing.
*
* @param source the source to parse from, the value of the mandatory {@code source} request parameter; no format is
* imposed for this parameter, as each indexer will treat it differently, but in general it should be a
* short identifier that simply activates the right indexer
* @param request the original request that triggered the indexing process, may contain additional parameters for
* customizing the process
* @param response HTTP response where the status should be written to
* @throws IOException when writing the json response fails
* @throws VocabularyIndexException when parsing the vocabulary or storing the parsed data fail
*/
void index(String source, SlingHttpServletRequest request, SlingHttpServletResponse response)
throws IOException, VocabularyIndexException;
}