Add core types to be used to replace the use of jcr.Session in the kernel API

fcrepo-kernel-api/src/main/java/org/fcrepo/kernel/api/FedoraRepository.java

@@ -0,0 +1,41 @@
+/*
+ * Licensed to DuraSpace under one or more contributor license agreements.
+ * See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * DuraSpace 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 org.fcrepo.kernel.api;
+
+/**
+ * The basic abstraction for a Fedora repository
+ * @author acoburn
+ */
+public interface FedoraRepository {
+
+    /**
+     * Login to the repository
+     *
+     * @return a FedoraSession
+     */
+    FedoraSession login();
+
+
+    /**
+     * Login to the repository with credentials
+     *
+     * @param credentials the credentials
+     * @return a FedoraSession
+     */
+    FedoraSession login(final Object credentials);
+}

fcrepo-kernel-api/src/main/java/org/fcrepo/kernel/api/FedoraSession.java

@@ -0,0 +1,111 @@
+/*
+ * Licensed to DuraSpace under one or more contributor license agreements.
+ * See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * DuraSpace 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 org.fcrepo.kernel.api;
+
+import java.time.Duration;
+import java.time.Instant;
+import java.util.Collection;
+import java.util.Map;
+import java.util.Optional;
+
+/**
+ * The Fedora Session abstraction
+ *
+ * @author acoburn
+ */
+public interface FedoraSession {
+
+    /**
+     * Expire the session
+     */
+    void expire();
+
+    /**
+     * Commit any batch operations
+     */
+    void commit();
+
+    /**
+     * Update the expiry by the provided amount
+     * @param amountToAdd the amount of time to add
+     * @return the new expiration date
+     */
+    Instant updateExpiry(Duration amountToAdd);
+
+    /**
+     * Get the date this session was created
+     * @return creation date
+     */
+    Instant getCreated();
+
+    /**
+     * Get the date this session expires
+     * @return expiration date, if one exists
+     */
+    Optional<Instant> getExpires();
+
+    /**
+     * Get the session identifier
+     * @return the session id
+     */
+    String getId();
+
+    /**
+     * Get the user identifier associated with this session
+     * @return the user id
+     */
+    String getUserId();
+
+    /**
+     * Get a mapping of registered namespaces
+     * @return the namespace mapping
+     */
+    Map<String, String> getNamespaces();
+
+    /**
+     * Add session-specific data
+     * @param key the key
+     * @param value the value
+     *
+     * Note: it is up to the particular implementation as to whether multi-valued session data
+     * is allowed.
+     */
+    void addSessionData(String key, String value);
+
+    /**
+     * Retrieve the session data for a given key
+     * @param key the key
+     * @return the value
+     */
+    Collection<String> getSessionData(String key);
+
+    /**
+     * Remove a particular session key-value pair
+     * @param key the data key
+     * @param value the data value
+     */
+    void removeSessionData(String key, String value);
+
+    /**
+     * Remove all session data for a particular key
+     * @param key the data key
+     */
+    default void removeSessionData(String key) {
+        getSessionData(key).forEach(v -> removeSessionData(key, v));
+    }
+}

fcrepo-kernel-api/src/main/java/org/fcrepo/kernel/api/services/BatchService.java

@@ -0,0 +1,138 @@
+/*
+ * Licensed to DuraSpace under one or more contributor license agreements.
+ * See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * DuraSpace 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 org.fcrepo.kernel.api.services;
+
+import org.fcrepo.kernel.api.FedoraSession;
+
+/**
+ * @author acoburn
+ * @since Sept 30, 2016
+ */
+public interface BatchService {
+
+    /**
+     * Check for expired batch operations and remove them
+     */
+    void removeExpired();
+
+    /**
+     * Create a new batch operation with a FedoraSession and add it to the currently open ones
+     *
+     * @param session The session to use for this batch operation
+     * @param username the name of the {@link java.security.Principal}
+     */
+    void begin(FedoraSession session, String username);
+
+    /**
+     * Create a new FedoraSession for the anonymous user and add it to the currently open ones
+     *
+     * @param session The session to use for this batch operation
+     */
+    default void begin(FedoraSession session) {
+        begin(session, null);
+    }
+
+    /**
+     * Retrieve an open {@link FedoraSession} for a given user
+     *
+     * @param sessionId the Id of the {@link FedoraSession}
+     * @param username the name of the {@link java.security.Principal}
+     * @return the {@link FedoraSession} with this user
+     */
+    FedoraSession getSession(String sessionId, String username);
+
+    /**
+     * Retrieve an open {@link FedoraSession} for an anonymous user
+     *
+     * @param sessionId the Id of the {@link FedoraSession}
+     * @return the {@link FedoraSession}
+     */
+    default FedoraSession getSession(String sessionId) {
+        return getSession(sessionId, null);
+    }
+
+    /**
+     * Check if a FedoraSession exists for a particular user
+     *
+     * @param sessionId the Id of the {@link FedoraSession}
+     * @param username the name of the {@link java.security.Principal}
+     * @return the {@link FedoraSession} object for the defined user
+     */
+    boolean exists(String sessionId, String username);
+
+    /**
+     * Check if a FedoraSession exists for the anonymous user
+     *
+     * @param sessionId the Id of the {@link FedoraSession}
+     * @return the {@link FedoraSession} object
+     */
+    default boolean exists(String sessionId) {
+        return exists(sessionId, null);
+    }
+
+    /**
+     * Refresh an existing session using an implementation-defined default
+     *
+     * @param sessionId the Id of the {@link FedoraSession}
+     * @param username the name of the {@link java.security.Principal}
+     */
+    void refresh(String sessionId, String username);
+
+    /**
+     * Refresh an existing anonymous session using an implementation-defined default
+     *
+     * @param sessionId the Id of the {@link FedoraSession}
+     */
+    default void refresh(String sessionId) {
+        refresh(sessionId, null);
+    }
+
+    /**
+     * Commit any changes during a {@link FedoraSession} with the given id and username
+     *
+     * @param sessionId the id of the {@link FedoraSession}
+     * @param username the name of the {@link java.security.Principal}
+     */
+    void commit(String sessionId, String username);
+
+    /**
+     * Commit any changes during a {@link FedoraSession} with the given id for the anonymous user
+     *
+     * @param sessionId the id of the {@link FedoraSession}
+     */
+    default void commit(String sessionId) {
+        commit(sessionId, null);
+    }
+
+    /**
+     * Roll back any uncommited changes during a {@link FedoraSession}
+     *
+     * @param sessionId the id of the {@link FedoraSession}
+     * @param username the name of the {@link java.security.Principal}
+     */
+    void abort(String sessionId, String username);
+
+    /**
+     * Roll back any uncommited changes during a {@link FedoraSession} for the anonymous user
+     *
+     * @param sessionId the id of the {@link FedoraSession}
+     */
+    default void abort(String sessionId) {
+        abort(sessionId, null);
+    }
+}

fcrepo-kernel-modeshape/src/main/java/org/fcrepo/kernel/modeshape/FedoraRepositoryImpl.java

@@ -0,0 +1,87 @@
+/*
+ * Licensed to DuraSpace under one or more contributor license agreements.
+ * See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * DuraSpace 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 org.fcrepo.kernel.modeshape;
+
+import javax.jcr.Credentials;
+import javax.jcr.Repository;
+import javax.jcr.RepositoryException;
+
+import org.fcrepo.kernel.api.FedoraRepository;
+import org.fcrepo.kernel.api.FedoraSession;
+import org.fcrepo.kernel.api.exception.RepositoryRuntimeException;
+
+/**
+ * The basic abstraction for a Fedora repository
+ * @author acoburn
+ */
+public class FedoraRepositoryImpl implements FedoraRepository {
+
+    private final Repository repository;
+
+    /**
+     * Create a FedoraRepositoryImpl with a JCR-based Repository
+     *
+     * @param repository the JCR repository
+     */
+    public FedoraRepositoryImpl(final Repository repository) {
+        this.repository = repository;
+    }
+
+    @Override
+    public FedoraSession login() {
+        try {
+            return new FedoraSessionImpl(repository.login());
+        } catch (final RepositoryException ex) {
+            throw new RepositoryRuntimeException(ex);
+        }
+    }
+
+    @Override
+    public FedoraSession login(final Object credentials) {
+        if (credentials instanceof Credentials) {
+            try {
+                return new FedoraSessionImpl(repository.login((Credentials) credentials));
+            } catch (final RepositoryException ex) {
+                throw new RepositoryRuntimeException(ex);
+            }
+        }
+        throw new IllegalArgumentException("Credentials are of the wrong type");
+    }
+
+    /**
+     * Retrieve the internal JCR Repository object
+     *
+     * @return the JCR Repository
+     */
+    public Repository getJcrRepository() {
+        return repository;
+    }
+
+    /**
+     * Retrieve the internal JCR Repository from a FedoraRepository object
+     *
+     * @param repository the FedoraRepository
+     * @return the JCR Repository
+     */
+    public static Repository getJcrRepository(final FedoraRepository repository) {
+        if (repository instanceof FedoraRepositoryImpl) {
+            return ((FedoraRepositoryImpl)repository).getJcrRepository();
+        }
+        throw new ClassCastException("FedoraRepository is not a " + FedoraRepositoryImpl.class.getCanonicalName());
+    }
+}