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
020/**
021 * Interface to access PersistentStorageSessions.
022 *
023 * @author whikloj
024 * @author dbernstein
025 * @since 2019-09-19
026 */
027public interface PersistentStorageSessionManager {
028
029    /**
030     * Retrieve a PersistentStorageSession.
031     *
032     * @param sessionId the externally generated session ID.
033     * @return the PersistentStorageSession instance.
034     */
035    PersistentStorageSession getSession(final String sessionId);
036
037    /**
038     * Retrieve a read-only PersistentStorageSession. Clients should expect
039     * invocation on storage modifying methods to throw exception.
040     *
041     * @return the PersistentStorageSession instance.
042     */
043    PersistentStorageSession getReadOnlySession();
044
045    /**
046     * Removes the indicated session. If the session does not exist, null is returned.
047     *
048     * @param sessionId the id of the session to remove
049     * @return the session, if it exists
050     */
051    PersistentStorageSession removeSession(final String sessionId);
052
053}