001/*
002 * (C) Copyright 2015 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 * Nuxeo - initial API and implementation
018 */
019
020package org.nuxeo.ecm.core.transientstore.api;
021
022/**
023 * Service to expose access to {@link TransientStore}
024 *
025 * @author <a href="mailto:tdelprat@nuxeo.com">Tiry</a>
026 * @since 7.2
027 */
028public interface TransientStoreService {
029
030    /**
031     * Retrieves a {@link TransientStore} by it's name.
032     * <p>
033     * If the {@link TransientStore} is not found, returns the default one.
034     *
035     * @param name the name of the target {@link TransientStore}
036     * @return the target {@link TransientStore} or the default one if not found
037     */
038    TransientStore getStore(String name);
039
040    /**
041     * Triggers Garbage collecting of all {@link TransientStore}
042     */
043    void doGC();
044}