01: /*
02: * Copyright 1998-2004 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any 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: public interface AttachingConnector extends Connector {
39: /**
40: * Attaches to a running application and and returns a
41: * mirror of its VM.
42: * <p>
43: * The connector uses the given argument map in
44: * attaching the application. These arguments will include addressing
45: * information that identifies the VM.
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: *
52: * @param arguments the argument map to be used in launching the VM.
53: * @return the {@link VirtualMachine} mirror of the target VM.
54: *
55: * @throws TransportTimeoutException when the Connector encapsulates
56: * a transport that supports a timeout when attaching, a
57: * {@link Connector.Argument} representing a timeout has been set
58: * in the argument map, and a timeout occurs when trying to attach
59: * to the target VM.
60: *
61: * @throws java.io.IOException when unable to attach.
62: * Specific exceptions are dependent on the Connector implementation
63: * in use.
64: * @throws IllegalConnectorArgumentsException when one of the
65: * connector arguments is invalid.
66: */
67: VirtualMachine attach(
68: Map<String, ? extends Connector.Argument> arguments)
69: throws IOException, IllegalConnectorArgumentsException;
70: }
|