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 attaches to a previously running target VM. 34 * 35 * @author Gordon Hirsch 36 * @since 1.3 37 */ 38 @jdk.Exported 39 public interface AttachingConnector extends Connector { 40 /** 41 * Attaches to a running application and and returns a 42 * mirror of its VM. 43 * <p> 44 * The connector uses the given argument map in 45 * attaching the application. These arguments will include addressing 46 * information that identifies the VM. 47 * The argument map associates argument name strings to instances 48 * of {@link Connector.Argument}. The default argument map for a 49 * connector can be obtained through {@link Connector#defaultArguments}. 50 * Argument map values can be changed, but map entries should not be 51 * added or deleted. 52 * 53 * @param arguments the argument map to be used in launching the VM. 54 * @return the {@link VirtualMachine} mirror of the target VM. 55 * 56 * @throws TransportTimeoutException when the Connector encapsulates 57 * a transport that supports a timeout when attaching, a 58 * {@link Connector.Argument} representing a timeout has been set 59 * in the argument map, and a timeout occurs when trying to attach 60 * to the target VM. 61 * 62 * @throws java.io.IOException when unable to attach. 63 * Specific exceptions are dependent on the Connector implementation 64 * in use. 65 * @throws IllegalConnectorArgumentsException when one of the 66 * connector arguments is invalid. 67 */ attach(Map<String,? extends Connector.Argument> arguments)68 VirtualMachine attach(Map<String,? extends Connector.Argument> arguments) 69 throws IOException, IllegalConnectorArgumentsException; 70 } 71