org.jboss.as.controller.client.OperationBuilder Maven / Gradle / Ivy

Go to download
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2011, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.jboss.as.controller.client;

import org.jboss.as.controller.client.impl.InputStreamEntry;
import org.jboss.as.protocol.StreamUtils;
import org.jboss.dmr.ModelNode;

import static org.jboss.as.controller.client.ControllerClientMessages.MESSAGES;

import java.io.DataOutput;
import java.io.File;
import java.io.FileInputStream;
import java.io.FilterInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

/**
 * Builder for a {@link Operation}.
 *
 * @author Kabir Khan
 * @author Brian Stansberry (c) 2011 Red Hat Inc.
 */
public class OperationBuilder {

    private final ModelNode operation;
    private volatile List inputStreams;
    private boolean autoCloseStreams = false;

    public OperationBuilder(final ModelNode operation) {
        this(operation, false);
    }

    public OperationBuilder(final ModelNode operation, boolean autoCloseStreams) {
        if (operation == null) {
            throw MESSAGES.nullVar("operation");
        }
        this.operation = operation;
        this.autoCloseStreams = autoCloseStreams;
    }

    /**
     * Associate a file with the operation. This will create a {@code FileInputStream}
     * and add it as attachment.
     *
     * @param file the file
     * @return the operation builder
     */
    public OperationBuilder addFileAsAttachment(final File file) {
        if(file == null) {
            throw MESSAGES.nullVar("file");
        }
        try {
            FileStreamEntry entry = new FileStreamEntry(file);
            if (inputStreams == null) {
                inputStreams = new ArrayList();
            }
            inputStreams.add(entry);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }
        return this;
    }

    /**
     * Associate an input stream with the operation. Closing the input stream
     * is the responsibility of the caller.
     *
     * @param in  the input stream. Cannot be {@code null}
     * @return a builder than can be used to continue building the operation
     */
    public OperationBuilder addInputStream(final InputStream in) {
        if(in == null) {
            throw MESSAGES.nullVar("input-stream");
        }
        if (inputStreams == null) {
            inputStreams = new ArrayList();
        }
        inputStreams.add(in);
        return this;
    }

    /**
     * Gets the number of input streams currently associated with the operation,
     *
     * @return  the number of input streams
     */
    public int getInputStreamCount() {
        List list = inputStreams;
        return list == null ? 0 : list.size();
    }

    /**
     * Automatically try to close the stream, once the operation finished executing.
     *
     * @param autoCloseStreams whether to close the streams or not
     */
    public void setAutoCloseStreams(boolean autoCloseStreams) {
        this.autoCloseStreams = autoCloseStreams;
    }

    /**
     * Builds the operation.
     *
     * @return the operation
     */
    public Operation build() {
        return new OperationImpl(operation, inputStreams, autoCloseStreams);
    }

    /**
     * Create an operation builder.
     *
     * @param operation the operation
     * @return the builder
     */
    public static OperationBuilder create(final ModelNode operation) {
        return new OperationBuilder(operation);
    }

    /**
     * Create an operation builder.
     *
     * @param operation the operation
     * @param autoCloseStreams whether streams should be automatically closed
     * @return the builder
     */
    public static OperationBuilder create(final ModelNode operation, final boolean autoCloseStreams) {
        return new OperationBuilder(operation, autoCloseStreams);
    }

    // Wrap the FIS in a streamEntry so that the controller-client has access to the underlying File
    private static class FileStreamEntry extends FilterInputStream implements InputStreamEntry {

        private final File file;
        private FileStreamEntry(final File file) throws IOException {
            super(new FileInputStream(file)); // This stream will get closed regardless of autoClose
            this.file = file;
        }

        @Override
        public int initialize() throws IOException {
            return (int) file.length();
        }

        @Override
        public void copyStream(final DataOutput output) throws IOException {
            final FileInputStream is = new FileInputStream(file);
            try {
                StreamUtils.copyStream(is, output);
                is.close();
            } finally {
                StreamUtils.safeClose(is);
            }
        }

    }

}