001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.fcrepo.persistence.api;
019
020import org.fcrepo.kernel.api.Transaction;
021
022/**
023 * Interface to access PersistentStorageSessions.
024 *
025 * @author whikloj
026 * @author dbernstein
027 * @since 2019-09-19
028 */
029public interface PersistentStorageSessionManager {
030
031    /**
032     * Retrieve a PersistentStorageSession.
033     *
034     * @param transaction the externally generated transaction.
035     * @return the PersistentStorageSession instance.
036     */
037    PersistentStorageSession getSession(final Transaction transaction);
038
039    /**
040     * Retrieve a read-only PersistentStorageSession. Clients should expect
041     * invocation on storage modifying methods to throw exception.
042     *
043     * @return the PersistentStorageSession instance.
044     */
045    PersistentStorageSession getReadOnlySession();
046
047    /**
048     * Removes the indicated session. If the session does not exist, null is returned.
049     *
050     * @param sessionId the id of the session to remove
051     * @return the session, if it exists
052     */
053    PersistentStorageSession removeSession(final String sessionId);
054
055}