ProcessConfiguration.java

/*
 * Copyright 2010-2013 the original author or authors.
 *
 * 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 org.springframework.data.gemfire.process;

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.data.gemfire.test.support.FileSystemUtils;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

/**
 * The {@link ProcessConfiguration} class is a container encapsulating configuration and context meta-data
 * for a running process.
 *
 * @author John Blum
 * @see java.lang.ProcessBuilder
 * @see org.springframework.data.gemfire.process.ProcessExecutor
 * @since 1.5.0
 */
@SuppressWarnings("unused")
public class ProcessConfiguration {

	private final boolean redirectingErrorStream;

	private final File workingDirectory;

	private final List<String> command;

	private final Map<String, String> environment;

	public static ProcessConfiguration create(ProcessBuilder processBuilder) {
		Assert.notNull(processBuilder, "The ProcessBuilder used to configure and start the Process must not be null");

		return new ProcessConfiguration(processBuilder.command(), processBuilder.directory(),
			processBuilder.environment(), processBuilder.redirectErrorStream());
	}

	public ProcessConfiguration(List<String> command, File workingDirectory, Map<String, String> environment,
			boolean redirectErrorStream) {

		Assert.notEmpty(command, "Process command must be specified");

		Assert.isTrue(FileSystemUtils.isDirectory(workingDirectory), String.format(
			"Process working directory [%s] is not valid", workingDirectory));

		this.command = new ArrayList<String>(command);
		this.workingDirectory = workingDirectory;
		this.redirectingErrorStream = redirectErrorStream;

		this.environment = (environment != null
			? Collections.unmodifiableMap(new HashMap<String, String>(environment))
			: Collections.<String, String>emptyMap());
	}

	public List<String> getCommand() {
		return Collections.unmodifiableList(command);
	}

	public String getCommandString() {
		return StringUtils.arrayToDelimitedString(getCommand().toArray(), " ");
	}

	public Map<String, String> getEnvironment() {
		return environment;
	}

	public boolean isRedirectingErrorStream() {
		return redirectingErrorStream;
	}

	public File getWorkingDirectory() {
		return workingDirectory;
	}

	@Override
	public String toString() {
		return "{ command = ".concat(getCommandString())
			.concat(", workingDirectory = ".concat(getWorkingDirectory().getAbsolutePath()))
			.concat(", environment = ".concat(String.valueOf(getEnvironment())))
			.concat(", redirectingErrorStream = ".concat(String.valueOf(isRedirectingErrorStream())))
			.concat(" }");
	}
}