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 020import org.nuxeo.common.annotation.Experimental; 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 */ 028@Experimental(comment = "https://jira.nuxeo.com/browse/NXP-16577") 029public interface TransientStoreService { 030 031 /** 032 * Retrieves a {@link TransientStore} by it's name. 033 * <p> 034 * If the {@link TransientStore} is not found, returns the default one. 035 * 036 * @param name the name of the target {@link TransientStore} 037 * @return the target {@link TransientStore} or the default one if not found 038 */ 039 TransientStore getStore(String name); 040 041 /** 042 * Triggers Garbage collecting of all {@link TransientStore} 043 */ 044 void doGC(); 045}