com.adaptris.core.services.system.AddMetaDataValue.java Source code

Introduction

Here is the source code for com.adaptris.core.services.system.AddMetaDataValue.java

Source

/*
 * Copyright 2015 Adaptris Ltd.
 * 
 * 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.
*/

package com.adaptris.core.services.system;

import java.io.ByteArrayOutputStream;
import java.io.FilterOutputStream;
import java.io.IOException;
import java.io.OutputStream;

import javax.validation.constraints.NotNull;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.lang3.BooleanUtils;

import com.adaptris.annotation.AdvancedConfig;
import com.adaptris.annotation.DisplayOrder;
import com.adaptris.annotation.InputFieldDefault;
import com.adaptris.core.AdaptrisMessage;
import com.adaptris.core.IORunnable;
import com.thoughtworks.xstream.annotations.XStreamAlias;

/**
 * Implementation of {@link CommandOutputCapture} that saves the output of the system command to a metadata value
 * 
 * @author gdries
 * 
 */
@XStreamAlias("system-command-add-metadata-value")
@DisplayOrder(order = { "metadataKey", "strip", "encoding" })
public class AddMetaDataValue implements CommandOutputCapture {

    @NotNull
    private String metadataKey;
    @AdvancedConfig
    @InputFieldDefault(value = "true")
    private Boolean strip;

    @AdvancedConfig
    private String encoding;

    @Override
    public OutputStream startCapture(final AdaptrisMessage msg) throws IOException {
        final ByteArrayOutputStream bos = new ByteArrayOutputStream();

        // Construct a new OutputStream that will set the metadata value when closed
        return new RunAfterCloseOutputStream(bos, new IORunnable() {
            @Override
            public void run() throws IOException {
                String result = getResultAsString(bos.toByteArray());
                if (strip()) {
                    result = StringUtils.strip(result);
                }
                msg.addMetadata(metadataKey, result);
            }

            private String getResultAsString(byte[] result) throws IOException {
                if (StringUtils.isEmpty(encoding)) {
                    return new String(result);
                } else {
                    return new String(result, encoding);
                }
            }
        });
    }

    public String getMetadataKey() {
        return metadataKey;
    }

    /**
     * The metadata key under which the output of the command is to be stored. May not be empty.
     * @param metadataKey
     */
    public void setMetadataKey(String metadataKey) {
        if (StringUtils.isEmpty(metadataKey)) {
            throw new IllegalArgumentException("Metadata key may not be empty");
        }

        this.metadataKey = metadataKey;
    }

    public String getEncoding() {
        return encoding;
    }

    /**
     * Set the character encoding to interpret the output of the command. By default the JVM encoding will be used.
     * @param encoding
     */
    public void setEncoding(String encoding) {
        this.encoding = encoding;
    }

    public Boolean getStrip() {
        return strip;
    }

    /**
     * Whether to strip whitespace like newlines, spaces and tabs from the command output. Default: true
     * @param strip
     */
    public void setStrip(Boolean strip) {
        this.strip = strip;
    }

    private boolean strip() {
        return BooleanUtils.toBooleanDefaultIfNull(getStrip(), false);
    }

    private static class RunAfterCloseOutputStream extends FilterOutputStream {
        private final IORunnable runOnClose;

        public RunAfterCloseOutputStream(OutputStream out, IORunnable runOnClose) {
            super(out);
            this.runOnClose = runOnClose;
        }

        @Override
        public void close() throws IOException {
            super.close();
            runOnClose.run();
        }
    }

}