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 <vpasquier@nuxeo.com>
018 */
019package org.nuxeo.binary.metadata.internals.operations;
020
021import java.util.Map;
022
023import org.nuxeo.binary.metadata.api.BinaryMetadataService;
024import org.nuxeo.ecm.automation.core.Constants;
025import org.nuxeo.ecm.automation.core.annotations.Context;
026import org.nuxeo.ecm.automation.core.annotations.Operation;
027import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
028import org.nuxeo.ecm.automation.core.annotations.Param;
029import org.nuxeo.ecm.core.api.Blob;
030
031/**
032 * @since 7.1
033 */
034@Operation(id = ReadMetadataFromBinary.ID, category = Constants.CAT_BLOB, label = "Read Metadata From Binary", description = "Read Metadata "
035        + "From Binary with the default Nuxeo processor.", since = "7.1", addToStudio = false, aliases = { "Binary.ReadMetadata" })
036public class ReadMetadataFromBinary {
037
038    public static final String ID = "Blob.ReadMetadata";
039
040    @Context
041    protected BinaryMetadataService binaryMetadataService;
042
043    @Param(name = "ignorePrefix", required = false, description = "Ignore metadata prefixes or not")
044    boolean ignorePrefix = true;
045
046    @OperationMethod
047    public Map<String, Object> run(Blob blob) {
048        return binaryMetadataService.readMetadata(blob, ignorePrefix);
049    }
050}