001/*
002 * (C) Copyright 2014 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 *      Vladimir Pasquier <[email protected]>
018 */
019package org.nuxeo.binary.metadata.api;
020
021import java.util.List;
022import java.util.Map;
023
024import org.nuxeo.ecm.core.api.Blob;
025
026/**
027 * Class to extends to contribute processor runner. See extension point 'metadataProcessors'.
028 *
029 * @since 7.1
030 */
031public interface BinaryMetadataProcessor {
032
033    /**
034     * Write given metadata into given blob. Since 7.3 ignorePrefix is added.
035     *
036     * @param blob Blob to write.
037     * @param metadata Metadata to inject.
038     * @param ignorePrefix
039     * @return the updated blob, or {@code null} if there was an error (since 7.4)
040     */
041    public Blob writeMetadata(Blob blob, Map<String, Object> metadata, boolean ignorePrefix);
042
043    /**
044     * Read from a given blob given metadata map. Since 7.3 ignorePrefix is added.
045     *
046     * @param blob Blob to read.
047     * @param metadata Metadata to extract.
048     * @param ignorePrefix
049     * @return Metadata map.
050     */
051    public Map<String, Object> readMetadata(Blob blob, List<String> metadata, boolean ignorePrefix);
052
053    /**
054     * Read all metadata from a given blob. Since 7.3 ignorePrefix is added.
055     *
056     * @param blob Blob to read.
057     * @param ignorePrefix
058     * @return Metadata map.
059     */
060    public Map<String, Object> readMetadata(Blob blob, boolean ignorePrefix);
061
062}