RunConverter.java

/*
 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * Contributors:
 *     Vincent Vergnolle
 */
package org.nuxeo.ecm.automation.core.operations.blob;

import java.io.Serializable;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nuxeo.ecm.automation.core.Constants;
import org.nuxeo.ecm.automation.core.annotations.Context;
import org.nuxeo.ecm.automation.core.annotations.Operation;
import org.nuxeo.ecm.automation.core.annotations.OperationMethod;
import org.nuxeo.ecm.automation.core.annotations.Param;
import org.nuxeo.ecm.automation.core.util.Properties;
import org.nuxeo.ecm.core.api.Blob;
import org.nuxeo.ecm.core.api.blobholder.BlobHolder;
import org.nuxeo.ecm.core.api.blobholder.SimpleBlobHolder;
import org.nuxeo.ecm.core.convert.api.ConversionService;

/**
 * @since 7.1
 * @author Vincent Vergnolle
 */
@Operation(id = RunConverter.ID, category = Constants.CAT_CONVERSION, label = RunConverter.ID, description = "Simply call a converter based on the 'converter' parameter. You can pass the converter properties with the 'properties' parameter.", since = "7.1")
public class RunConverter {

    public static final String ID = "Blob.RunConverter";

    public static final Log log = LogFactory.getLog(RunConverter.class);

    @Param(name = "converter", description = "The name of the converter to call")
    protected String converter;

    @Param(name = "parameters", description = "The converter parameters to pass", required = false)
    protected Properties parameters;

    @Context
    protected ConversionService conversionService;

    @OperationMethod
    public Blob run(Blob blob) {
        if (log.isDebugEnabled()) {
            log.debug("Call converter named: " + converter);
        }

        BlobHolder holder = conversionService.convert(converter, new SimpleBlobHolder(blob), propertiesToMap());

        return holder.getBlob();
    }

    private Map<String, Serializable> propertiesToMap() {
        if (parameters == null) {
            return Collections.emptyMap();
        }

        Map<String, Serializable> params = new HashMap<>(parameters.size());
        for (Entry<String, String> entry : parameters.entrySet()) {
            params.put(entry.getKey(), entry.getValue());
        }

        return params;
    }
}