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: * If you wish your version of this file to be governed by only the CDDL
025: * or only the GPL Version 2, indicate your decision by adding
026: * "[Contributor] elects to include this software in this distribution
027: * under the [CDDL or GPL Version 2] license." If you do not indicate a
028: * single choice of license, a recipient has the option to distribute
029: * your version of this file under either the CDDL, the GPL Version 2 or
030: * to extend the choice of license to its licensees as provided above.
031: * However, if you add GPL Version 2 code and therefore, elected the GPL
032: * Version 2 license, then the option applies only if the new code is
033: * made subject to such option by the copyright holder.
034: *
035: * Contributor(s):
036: *
037: * Portions Copyrighted 2007 Sun Microsystems, Inc.
038: */
039:
040: package org.netbeans.spi.server;
041:
042: import javax.swing.JComponent;
043: import org.openide.nodes.Node;
044:
045: /**
046: * The representation of the single server instance. Interface describes
047: * the instance and provides needed operations.
048: *
049: * @author Petr Hejl
050: * @see ServerInstanceProvider
051: */
052: public interface ServerInstanceImplementation {
053:
054: /**
055: * Returns the display name of the instance.
056: *
057: * @return the display name of the instance
058: */
059: String getDisplayName();
060:
061: /**
062: * Returns the display name of the server type to which this instance belongs.
063: *
064: * @return the display name of the server type to which this instance belongs
065: */
066: String getServerDisplayName();
067:
068: /**
069: * Returns the node representing the runtime instance. The node should
070: * display instance status and provide actions to manage the server.
071: *
072: * @return the node representing the instance, may return <code>null</code>
073: */
074: Node getFullNode();
075:
076: /**
077: * Returns the node representing the instance while configuring it.
078: * The node should not display any status, actions or children.
079: *
080: * @return the node representing the instance, may return <code>null</code>
081: */
082: Node getBasicNode();
083:
084: /**
085: * Returns the component allowing the customization of the instance. May
086: * return <code>null</code>.
087: * <p>
088: * Always called from Event Dispatch Thread.
089: *
090: * @return the component allowing the customization of the instance,
091: * may return <code>null</code>
092: */
093: JComponent getCustomizer();
094:
095: /**
096: * Removes the instance. No {@link ServerInstanceProvider} should return
097: * this instance once it is removed.
098: */
099: void remove();
100:
101: /**
102: * Returns <code>true</code> if the instance can be removed by
103: * {@link #remove()}. Otherwise returns <code>false</code>.
104: *
105: * @return <code>true</code> if the instance can be removed
106: */
107: boolean isRemovable();
108:
109: }
|