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.extension;
021
022import java.io.Serializable;
023import java.util.Map;
024
025import org.nuxeo.ecm.core.api.blobholder.BlobHolder;
026import org.nuxeo.ecm.core.convert.api.ConversionException;
027import org.nuxeo.ecm.core.convert.cache.CachableBlobHolder;
028
029/**
030 * Interface that must be implemented by any contributer Converter class.
031 * <p>
032 * There is only one instance of each contributed converter class: that means that the implementation must be
033 * thread-safe.
034 *
035 * @author tiry
036 */
037public interface Converter {
038
039    /**
040     * Initializes the Converter.
041     * <p>
042     * This can be used to retrieve some configuration information from the XMap Descriptor.
043     */
044    void init(ConverterDescriptor descriptor);
045
046    /**
047     * Main method to handle the real Conversion Job.
048     * <p>
049     * Returned {@link BlobHolder} must implement {@link CachableBlobHolder}, otherwise result won't be cached.
050     */
051    BlobHolder convert(BlobHolder blobHolder, Map<String, Serializable> parameters) throws ConversionException;
052
053}