org.glassfish.common.util.admin.AsadminInput Maven / Gradle / Ivy
/*
* Copyright (c) 2010, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.common.util.admin;
import com.sun.enterprise.util.LocalStringManager;
import com.sun.enterprise.util.LocalStringManagerImpl;
import java.io.BufferedReader;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URISyntaxException;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
/**
* Implements in one place the details of providing data to asadmin's
* System.in and consuming it.
*
* Primarily (but not exclusively) for security reasons, it is useful to be
* able to have asadmin read data from its System.in. This class provides
* the logic to do so consistently. It also provides a little help for
* writing data to a stream such that it will be acceptable as input.
*
* The input stream must have the following format:
*
* version=some-version-value
* (lines as expected by the specified version)
*
*
* Currently there is only one version supported. The lines following
* the version spec must be in the format of a properties file, with the convention
* that each property name is (category).(property-within-category)=value
* The {@link InputReader} returned will return a Map from
* its {@link InputReader#settings() } method. The map will contain one entry for
* each category in the input, and the associated Properties object will map each
* property-within-category to its value.
*
*
* @author Tim Quinn
*/
public class AsadminInput {
public final static String CLI_INPUT_OPTION_NAME = "_auxinput";
public final static String CLI_INPUT_OPTION = "--" + CLI_INPUT_OPTION_NAME;
public final static String SYSTEM_IN_INDICATOR = "-"; // option value indicating we should read from stdin
private final static String VERSION_1_0 = "1.0";
private final static String VERSION_INTRODUCER = "version=";
private final static String CURRENT_VERSION = VERSION_1_0;
private final static LocalStringManager localStrings = new LocalStringManagerImpl(AsadminInput.class);
public interface InputReader {
public Map settings();
}
/**
* Returns a string containing a specifier for the current version, suitable
* for use as the first line to write to the asadmin System.in stream.
* @return
*/
public static String versionSpecifier() {
return VERSION_INTRODUCER + CURRENT_VERSION;
}
/**
* Returns an asadmin reader for reading from the specified URI.
* @param inputPath a valid file path or the dash indicating to read from system.in
* @return
* @throws IOException
*/
public static InputReader reader(final String inputPath) throws URISyntaxException, IOException {
if (inputPath.equals(SYSTEM_IN_INDICATOR)) {
return reader(System.in);
}
return reader(new FileInputStream(inputPath));
}
/**
* Returns a reader that can consume the specified version of asadmin input
*
* @return
* @throws IOException
*/
public static InputReader reader(final InputStream is) throws IOException {
final BufferedReader reader = new BufferedReader(new InputStreamReader(is));
final String version = readVersionFromFirstLine(reader);
return newReader(reader, version);
}
private static InputReader newReader(final BufferedReader reader, final String version) throws IOException {
if (version.equals(VERSION_1_0)) {
return new InputReader_1_0(reader);
}
throw new IllegalArgumentException(unknownVersionMsg(version));
}
/**
* Version 1.0 of the input reader.
*
* The expected format of the input stream, after the version=xxx line, is
* (category).name=value
*
* The settings map will contain a Properties object for each different
* category found in the input stream.
*/
private static class InputReader_1_0 implements InputReader {
private final Map settings;
private final BufferedReader reader;
@Override
public Map settings() {
return settings;
}
private InputReader_1_0(final BufferedReader reader) throws IOException {
this.reader = reader;
settings = loadSettings();
reader.close();
}
private Map loadSettings() throws IOException {
final Map result = new HashMap();
final Properties entireContent = new Properties();
entireContent.load(reader);
for (String propName : entireContent.stringPropertyNames()) {
final int firstDot = propName.indexOf('.');
if ( firstDot == -1) {
continue;
}
final String categoryName = propName.substring(0, firstDot);
final String propWithinCategory = propName.substring(firstDot + 1);
Properties category = result.get(categoryName);
if (category == null) {
category = new Properties();
result.put(categoryName, category);
}
category.setProperty(propWithinCategory, entireContent.getProperty(propName));
}
return result;
}
}
private static String readVersionFromFirstLine(final BufferedReader reader) throws IOException {
final String firstLine;
/*
* The first line should be version=some-version-string so
* complain if it is not.
*/
if ( ((firstLine = reader.readLine()) == null)
|| ( ! firstLine.startsWith(VERSION_INTRODUCER))
|| ( firstLine.length() <= VERSION_INTRODUCER.length())) {
throw new IOException(badVersionMsg());
}
return firstLine.substring(VERSION_INTRODUCER.length());
}
private static String badVersionMsg() {
return MessageFormat.format(
localStrings.getLocalString(
"AsadminInputNoVersion",
"Input to asadmin does not specify a version using {0} as the first line"),
VERSION_INTRODUCER);
}
private static String unknownVersionMsg(final String version) {
return MessageFormat.format(
localStrings.getLocalString(
"AsadminInputUnknownVersion",
"Input to asadmin specifies version {0} which is not recognized"),
version);
}
}