1 /* 2 * Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.jdi.connect; 27 28 import java.io.IOException; 29 import java.util.Map; 30 31 import com.sun.jdi.VirtualMachine; 32 33 /** 34 * A connector which can launch a target VM before connecting to it. 35 * 36 * @author Gordon Hirsch 37 * @since 1.3 38 */ 39 public interface LaunchingConnector extends Connector { 40 41 /** 42 * Launches an application and connects to its VM. Properties 43 * of the launch (possibly including options, 44 * main class, and arguments) are specified in 45 * <code>arguments</code>. 46 * The argument map associates argument name strings to instances 47 * of {@link Connector.Argument}. The default argument map for a 48 * connector can be obtained through {@link Connector#defaultArguments}. 49 * Argument map values can be changed, but map entries should not be 50 * added or deleted. 51 * <p>A target VM launched by a launching connector is not 52 * guaranteed to be stable until after the {@link com.sun.jdi.event.VMStartEvent} has been 53 * received. 54 * <p> 55 * <b>Important note:</b> If a target VM is launched through this 56 * funcctions, its output and error streams must be read as it 57 * executes. These streams are available through the 58 * {@link java.lang.Process Process} object returned by 59 * {@link com.sun.jdi.VirtualMachine#process}. If the streams are not periodically 60 * read, the target VM will stop executing when the buffers for these 61 * streams are filled. 62 * 63 * @param arguments the argument map to be used in launching the VM. 64 * @return the {@link VirtualMachine} mirror of the target VM. 65 * @throws java.io.IOException when unable to launch. 66 * Specific exceptions are dependent on the Connector implementation 67 * in use. 68 * @throws IllegalConnectorArgumentsException when one of the 69 * connector arguments is invalid. 70 * @throws VMStartException when the VM was successfully launched, but 71 * terminated with an error before a connection could be established. 72 */ 73 VirtualMachine launch(Map<String,? extends Connector.Argument> arguments) 74 throws IOException, IllegalConnectorArgumentsException, 75 VMStartException; 76 }