001/*
002 * (C) Copyright 2006-2011 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.convert.cache;
021
022import java.io.IOException;
023
024import org.nuxeo.ecm.core.api.blobholder.BlobHolder;
025
026/**
027 * Extended interface for {@link BlobHolder} that can be cached.
028 * <p>
029 * A BlobHolder can be cached if it can be persisted to disk and reloaded from a file. Converters need to return
030 * BlobHolders that implement this interface to make the result cachable.
031 *
032 * @author tiry
033 */
034public interface CachableBlobHolder extends BlobHolder {
035
036    /**
037     * Persists the blobHolder to disk.
038     *
039     * @param basePath the base path (existing directory) as determined by the caller
040     * @return the full path of the newly created FileSystem resource
041     */
042    String persist(String basePath) throws IOException;
043
044    /**
045     * Reloads the {@link BlobHolder} from a file.
046     */
047    void load(String path) throws IOException;
048
049}