001 /*
002 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003 *
004 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005 *
006 * The contents of this file are subject to the terms of either the GNU
007 * General Public License Version 2 only ("GPL") or the Common
008 * Development and Distribution License("CDDL") (collectively, the
009 * "License"). You may not use this file except in compliance with the
010 * License. You can obtain a copy of the License at
011 * http://www.netbeans.org/cddl-gplv2.html
012 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013 * specific language governing permissions and limitations under the
014 * License. When distributing the software, include this License Header
015 * Notice in each file and include the License file at
016 * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017 * particular file as subject to the "Classpath" exception as provided
018 * by Sun in the GPL Version 2 section of the License file that
019 * accompanied this code. If applicable, add the following below the
020 * License Header, with the fields enclosed by brackets [] replaced by
021 * your own identifying information:
022 * "Portions Copyrighted [year] [name of copyright owner]"
023 *
024 * Contributor(s):
025 *
026 * The Original Software is NetBeans. The Initial Developer of the Original
027 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028 * Microsystems, Inc. All Rights Reserved.
029 *
030 * If you wish your version of this file to be governed by only the CDDL
031 * or only the GPL Version 2, indicate your decision by adding
032 * "[Contributor] elects to include this software in this distribution
033 * under the [CDDL or GPL Version 2] license." If you do not indicate a
034 * single choice of license, a recipient has the option to distribute
035 * your version of this file under either the CDDL, the GPL Version 2 or
036 * to extend the choice of license to its licensees as provided above.
037 * However, if you add GPL Version 2 code and therefore, elected the GPL
038 * Version 2 license, then the option applies only if the new code is
039 * made subject to such option by the copyright holder.
040 */
041
042 package org.netbeans.modules.j2ee.deployment.profiler.spi;
043
044 import java.util.Map;
045 import javax.enterprise.deploy.spi.status.ProgressObject;
046 import org.netbeans.modules.j2ee.deployment.profiler.api.ProfilerServerSettings;
047
048 /**
049 * Profiler has to implement this interface and register it in the default Lookup.
050 *
051 * @author sherold
052 */
053 public interface Profiler {
054
055 /**
056 * Inform the profiler that some server is starting in the profile mode. It
057 * allows the Profiler to correctly detect STATE_STARTING.
058 */
059 void notifyStarting();
060
061 /**
062 * This method is used from the <code>nbstartprofiledserver</code>
063 * task to connect the Profiler to a server ready for profiling.
064 *
065 * @param projectProperties properties of project the <code>nbstartprofiledserver</code>
066 * ant task was started from.
067 *
068 * @return <code>true</code> if the Profiler successfully attached to the server.
069 */
070 boolean attachProfiler(Map projectProperties);
071
072 /**
073 * This method is used from the Runtime tab to obtain settings for starting
074 * the server. It displays dialog and let the user choose required mode
075 * (direct/dynamic attach) and other settings for the server startup.
076 *
077 * @param serverInstanceID ID of the server instance that is going to be started
078 *
079 * @return required settings or <code>null</code> if user cancelled starting
080 * the server.
081 */
082 ProfilerServerSettings getSettings(String serverInstanceID);
083
084 /**
085 * Returns state of Profiler agent instance started from the IDE. It detects
086 * possible response from an unknown (not started from the IDE) Profiler
087 * agent, in this case it returns STATE_INACTIVE.
088 *
089 * @return state of Profiler agent instance.
090 */
091 int getState();
092
093 /**
094 * Stops execution of the application (its JVM) currently being profiled.
095 * Shutdown is performed by the Profiler agent when in STATE_BLOCKED, STATE_RUNNING
096 * or STATE_PROFILING state.
097 *
098 * @return object used to monitor progress of shutdown.
099 */
100 ProgressObject shutdown();
101 }
|