1/*
2 * Copyright (c) 1998, 2013, 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
26package com.sun.jdi.connect;
27
28import com.sun.jdi.VirtualMachine;
29import java.util.Map;
30import java.io.IOException;
31
32/**
33 * A connector which can launch a target VM before connecting to it.
34 *
35 * @author Gordon Hirsch
36 * @since  1.3
37 */
38public interface LaunchingConnector extends Connector {
39    /**
40     * Launches an application and connects to its VM. Properties
41     * of the launch (possibly including options,
42     * main class, and arguments) are specified in
43     * <code>arguments</code>.
44     * The argument map associates argument name strings to instances
45     * of {@link Connector.Argument}. The default argument map for a
46     * connector can be obtained through {@link Connector#defaultArguments}.
47     * Argument map values can be changed, but map entries should not be
48     * added or deleted.
49     * <p>A target VM launched by a launching connector is not
50     * guaranteed to be stable until after the {@link com.sun.jdi.event.VMStartEvent} has been
51     * received.
52     * <p>
53     * <b>Important note:</b> If a target VM is launched through this
54     * funcctions, its output and error streams must be read as it
55     * executes. These streams are available through the
56     * {@link java.lang.Process Process} object returned by
57     * {@link com.sun.jdi.VirtualMachine#process}. If the streams are not periodically
58     * read, the target VM will stop executing when the buffers for these
59     * streams are filled.
60     *
61     * @param arguments the argument map to be used in launching the VM.
62     * @return the {@link VirtualMachine} mirror of the target VM.
63     * @throws java.io.IOException when unable to launch.
64     * Specific exceptions are dependent on the Connector implementation
65     * in use.
66     * @throws IllegalConnectorArgumentsException when one of the
67     * connector arguments is invalid.
68     * @throws VMStartException when the VM was successfully launched, but
69     * terminated with an error before a connection could be established.
70     */
71    VirtualMachine launch(Map<String,? extends Connector.Argument> arguments)
72        throws IOException, IllegalConnectorArgumentsException,
73               VMStartException;
74}
75