/*
 * Copyright Amherst College
 *
 * 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 edu.amherst.acdc.trellis.spi;

import edu.amherst.acdc.trellis.api.Resource;

import java.time.Instant;
import java.util.Optional;

import org.apache.commons.rdf.api.Dataset;
import org.apache.commons.rdf.api.IRI;

/**
 * The ResourceService provides methods for creating, retrieving and manipulating
 * repository resources.
 *
 * @author acoburn
 */
public interface ResourceService {

    /**
     * Set the event service
     * @param service the event service
     */
    default void setEventService(EventService service) {
        bind(service);
    }

    /**
     * Bind the event service
     * @param service the event service
     */
    void bind(EventService service);

    /**
     * Unbind the event service
     * @param service the event service
     */
    void unbind(EventService service);

    /**
     * Get a resource from the given location
     * @param identifier the resource identifier
     * @return the resource
     */
    Optional<Resource> get(IRI identifier);

    /**
     * Get a resource from the given location and time
     * @param identifier the resource identifier
     * @param time the time
     * @return the resource
     */
    Optional<Resource> get(IRI identifier, Instant time);

    /**
     * Put a resource into the repository
     * @param identifier the identifier for the new resource
     * @param dataset the dataset
     * @return whether the resource was added
     */
    Boolean put(IRI identifier, Dataset dataset);

    /**
     * Get the identifier for the structurally-logical container for the resource
     * @param identifier the identifier
     * @return an identifier for the structurally-logical container
     *
     * Note: The returned identifier is not guaranteed to exist
     */
    Optional<IRI> getContainer(IRI identifier);
}

@@ -725,16 +725,48 @@
 ptional;
+%0Aimport java.util.stream.Stream;
 %0A%0Aimport
@@ -840,16 +840,58 @@
 api.IRI;
+%0Aimport org.apache.commons.rdf.api.Triple;
 %0A%0A/**%0A *
@@ -2474,11 +2474,704 @@
 tifier);
+%0A%0A    /**%0A     * Compact (i.e. remove the history) of a resource%0A     * @param identifier the identifier%0A     * @return true if the compaction operation succeeded; false otherwise%0A     */%0A    Boolean compact(IRI identifier);%0A%0A    /**%0A     * Purge a resource from the repository%0A     * @param identifier the identifier%0A     * @return true if the purge operation succeeded; false otherwise%0A     */%0A    Boolean purge(IRI identifier);%0A%0A    /**%0A     * Get a list of resources in the repository, starting with the listed resource%0A     * @param identifier the identifier%0A     * @return a stream of RDF Triples, containing the resource and its LDP type%0A     */%0A    Stream%3CTriple%3E list(IRI identifier);
 %0A%7D%0A

Add admin-related functions to ResourceService