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