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 2008 Sun Microsystems, Inc.
038: */
039: package org.netbeans.modules.ruby.railsprojects.server;
040:
041: import java.util.List;
042: import javax.swing.event.ChangeListener;
043: import org.netbeans.modules.ruby.railsprojects.server.spi.RubyInstance;
044:
045: /**
046: * An interface specific to Mongrel and WEBrick to facilitate
047: * their handling.
048: *
049: * XXX: a work in progress
050: *
051: * @author Erno Mononen
052: */
053: public interface RubyServer extends RubyInstance {
054:
055: /**
056: * Gets the name for the node displayed in the services tab.
057: *
058: * @return the name for the node.
059: */
060: String getNodeName();
061:
062: /**
063: * Gets the startup param for forcing an instance of this server
064: * to started.
065: *
066: * @return the startup param.
067: */
068: String getStartupParam();
069:
070: /**
071: * Gets the path to the startup script of this server.
072: *
073: * @return the path to the startup script.
074: */
075: String getServerPath();
076:
077: /**
078: * Checks whether the given <code>outputLine</code> represented a startup
079: * message of this server.
080: *
081: * @param outputLine the line to check.
082: * @return true if the given <code>outputLine</code> was a startup message
083: * of this server, false otherwise.
084: */
085: boolean isStartupMsg(String outputLine);
086:
087: /**
088: * @return the applications running on this server.
089: */
090: List<RailsApplication> getApplications();
091:
092: /**
093: * Adds a new running application to this server. Must notify
094: * all registered listeners.
095: *
096: * @param application the application to add.
097: * @return true if adding was successful, false otherwise.
098: */
099: boolean addApplication(RailsApplication application);
100:
101: /**
102: * Removes the application running on the given <code>port</code>. Must
103: * notify all registered listeners.
104: *
105: * @param port the port on which the given application runs.
106: * @return true if removing the identified application was successful, false
107: * otherwise.
108: */
109: boolean removeApplication(int port);
110:
111: /**
112: * Registers a change listener to be notified when a new application has been
113: * started or a running application stopped on this server.
114: * @param listener
115: */
116: void addChangeListener(ChangeListener listener);
117:
118: /**
119: * Removes the given <code>listener</code>.
120: *
121: * @param listener
122: *
123: * @see addChangeListener(listener)
124: */
125: void removeChangeListener(ChangeListener listener);
126: }
|