1 /* 2 * Copyright (c) 2005, 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.tools.attach; 27 28 /** 29 * The exception thrown when an agent fails to initialize in the target 30 * Java virtual machine. 31 * 32 * <p> This exception is thrown by {@link 33 * com.sun.tools.attach.VirtualMachine#loadAgent VirtualMachine.loadAgent}, 34 * {@link com.sun.tools.attach.VirtualMachine#loadAgentLibrary 35 * VirtualMachine.loadAgentLibrary}, {@link 36 * com.sun.tools.attach.VirtualMachine#loadAgentPath VirtualMachine.loadAgentPath} 37 * methods if an agent, or agent library, cannot be initialized. 38 * When thrown by <tt>VirtualMachine.loadAgentLibrary</tt>, or 39 * <tt>VirtualMachine.loadAgentPath</tt> then the exception encapsulates 40 * the error returned by the agent's <code>Agent_OnAttach</code> function. 41 * This error code can be obtained by invoking the {@link #returnValue() returnValue} method. 42 */ 43 @jdk.Exported 44 public class AgentInitializationException extends Exception { 45 46 /** use serialVersionUID for interoperability */ 47 static final long serialVersionUID = -1508756333332806353L; 48 49 private int returnValue; 50 51 /** 52 * Constructs an <code>AgentInitializationException</code> with 53 * no detail message. 54 */ 55 public AgentInitializationException() { 56 super(); 57 this.returnValue = 0; 58 } 59 60 /** 61 * Constructs an <code>AgentInitializationException</code> with 62 * the specified detail message. 63 * 64 * @param s the detail message. 65 */ 66 public AgentInitializationException(String s) { 67 super(s); 68 this.returnValue = 0; 69 } 70 71 /** 72 * Constructs an <code>AgentInitializationException</code> with 73 * the specified detail message and the return value from the 74 * execution of the agent's <code>Agent_OnAttach</code> function. 75 * 76 * @param s the detail message. 77 * @param returnValue the return value 78 */ 79 public AgentInitializationException(String s, int returnValue) { 80 super(s); 81 this.returnValue = returnValue; 82 } 83 84 /** 85 * If the exception was created with the return value from the agent 86 * <code>Agent_OnAttach</code> function then this returns that value, 87 * otherwise returns <code>0</code>. </p> 88 * 89 * @return the return value 90 */ 91 public int returnValue() { 92 return returnValue; 93 } 94 95 }