001/*
002 * (C) Copyright 2015 Nuxeo SAS (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 * Nuxeo - initial API and implementation
016 */
017
018package org.nuxeo.ecm.core.transientstore.api;
019
020/**
021 * Service to expose access to {@link TransientStore}
022 *
023 * @author <a href="mailto:tdelprat@nuxeo.com">Tiry</a>
024 * @since 7.2
025 */
026public interface TransientStoreService {
027
028    /**
029     * Retrieves a {@link TransientStore} by it's name.
030     * <p>
031     * If the {@link TransientStore} is not found, returns the default one.
032     *
033     * @param name the name of the target {@link TransientStore}
034     * @return the target {@link TransientStore} or the default one if not found
035     */
036    TransientStore getStore(String name);
037
038    /**
039     * Triggers Garbage collecting of all {@link TransientStore}
040     */
041    void doGC();
042}