Persistence.java

/*
 * *********************************************************************************************************************
 *
 * blueMarine II: Semantic Media Centre
 * http://tidalwave.it/projects/bluemarine2
 *
 * Copyright (C) 2015 - 2021 by Tidalwave s.a.s. (http://tidalwave.it)
 *
 * *********************************************************************************************************************
 *
 * 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.
 *
 * *********************************************************************************************************************
 *
 * git clone https://bitbucket.org/tidalwave/bluemarine2-src
 * git clone https://github.com/tidalwave-it/bluemarine2-src
 *
 * *********************************************************************************************************************
 */
package it.tidalwave.bluemarine2.persistence;

import javax.annotation.Nonnull;
import java.io.IOException;
import java.nio.file.Path;
import org.eclipse.rdf4j.repository.Repository;
import org.eclipse.rdf4j.repository.RepositoryConnection;
import org.eclipse.rdf4j.repository.RepositoryException;
import org.eclipse.rdf4j.rio.RDFHandlerException;

/***********************************************************************************************************************
 *
 * This interface should not exist. For storing data into Persistence we're firing events to the messageBus. Why instead
 * we retrieve data by directly accessing the repository? Perhaps we could switch to a coherently sync model for
 * Persistence. In this case, AddStatementsRequest should me a private affair of DefaultMediaScanner.
 *
 * @author  Fabrizio Giudici
 *
 **********************************************************************************************************************/
public interface Persistence
  {
    public static final Class<Persistence> _Persistence_ = Persistence.class;

    public static interface TransactionalTask<E extends Exception>
      {
        public void run (@Nonnull RepositoryConnection connection)
          throws E, RepositoryException;
      }

    @Nonnull
    public Repository getRepository();

    public <E extends Exception> void runInTransaction (@Nonnull TransactionalTask<E> task)
      throws E, RepositoryException;

    public void exportToFile (@Nonnull final Path path)
      throws RDFHandlerException, IOException, RepositoryException;
  }