| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0) on Wed May 14 15:16:11 EDT 2008 --> |
| <TITLE> |
| ServerCore |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2008-05-14"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ServerCore"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ServerCore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IServerWorkingCopy.html" title="interface in org.eclipse.wst.server.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/server/core/ServerEvent.html" title="class in org.eclipse.wst.server.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/eclipse/wst/server/core/ServerCore.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ServerCore.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.wst.server.core</FONT> |
| <BR> |
| Class ServerCore</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.server.core.ServerCore</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public final class <B>ServerCore</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Main class for server core API. |
| <p> |
| This class provides API to access most of the types in the server |
| framework, including server runtimes and servers. |
| The methods on this class are thread safe. |
| </p> |
| <p> |
| This class provides all its functionality through static members. |
| It is not intended to be subclassed or instantiated. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>1.0</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#addRuntimeLifecycleListener(org.eclipse.wst.server.core.IRuntimeLifecycleListener)">addRuntimeLifecycleListener</A></B>(<A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeLifecycleListener.html" title="interface in org.eclipse.wst.server.core">IRuntimeLifecycleListener</A> listener)</CODE> |
| |
| <BR> |
| Adds a new runtime lifecycle listener.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#addServerLifecycleListener(org.eclipse.wst.server.core.IServerLifecycleListener)">addServerLifecycleListener</A></B>(<A HREF="../../../../../org/eclipse/wst/server/core/IServerLifecycleListener.html" title="interface in org.eclipse.wst.server.core">IServerLifecycleListener</A> listener)</CODE> |
| |
| <BR> |
| Adds a new server lifecycle listener.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#findRuntime(java.lang.String)">findRuntime</A></B>(java.lang.String id)</CODE> |
| |
| <BR> |
| Returns the runtime with the given id, or <code>null</code> |
| if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html" title="interface in org.eclipse.wst.server.core">IRuntimeType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#findRuntimeType(java.lang.String)">findRuntimeType</A></B>(java.lang.String id)</CODE> |
| |
| <BR> |
| Returns the runtime type with the given id, or <code>null</code> |
| if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core">IServer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#findServer(java.lang.String)">findServer</A></B>(java.lang.String id)</CODE> |
| |
| <BR> |
| Returns the server with the given id, or <code>null</code> |
| if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IServerType.html" title="interface in org.eclipse.wst.server.core">IServerType</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#findServerType(java.lang.String)">findServerType</A></B>(java.lang.String id)</CODE> |
| |
| <BR> |
| Returns the server type with the given id, or <code>null</code> |
| if none.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core">IServer</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getDefaultServer(org.eclipse.wst.server.core.IModule)">getDefaultServer</A></B>(<A HREF="../../../../../org/eclipse/wst/server/core/IModule.html" title="interface in org.eclipse.wst.server.core">IModule</A> module)</CODE> |
| |
| <BR> |
| Returns the preferred runtime server for the given module.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IProjectProperties.html" title="interface in org.eclipse.wst.server.core">IProjectProperties</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getProjectProperties(IProject)">getProjectProperties</A></B>(IProject project)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Project facet support should now be used instead of this API. @see |
| org.eclipse.wst.common.project.facet.core.IFacetedProject#getRuntime()</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getRuntimes()">getRuntimes</A></B>()</CODE> |
| |
| <BR> |
| Returns an array of all known runtime instances.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html" title="interface in org.eclipse.wst.server.core">IRuntimeType</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getRuntimeTypes()">getRuntimeTypes</A></B>()</CODE> |
| |
| <BR> |
| Returns an array of all known runtime types.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core">IServer</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getServers()">getServers</A></B>()</CODE> |
| |
| <BR> |
| Returns an array of all known server instances.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/eclipse/wst/server/core/IServerType.html" title="interface in org.eclipse.wst.server.core">IServerType</A>[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getServerTypes()">getServerTypes</A></B>()</CODE> |
| |
| <BR> |
| Returns an array of all known server types.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#isAutoPublishing()">isAutoPublishing</A></B>()</CODE> |
| |
| <BR> |
| Returns <code>true</code> if the preference is set to automatically |
| publish when starting servers, or <code>false</code> otherwise</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#removeRuntimeLifecycleListener(org.eclipse.wst.server.core.IRuntimeLifecycleListener)">removeRuntimeLifecycleListener</A></B>(<A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeLifecycleListener.html" title="interface in org.eclipse.wst.server.core">IRuntimeLifecycleListener</A> listener)</CODE> |
| |
| <BR> |
| Removes a runtime lifecycle listener.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#removeServerLifecycleListener(org.eclipse.wst.server.core.IServerLifecycleListener)">removeServerLifecycleListener</A></B>(<A HREF="../../../../../org/eclipse/wst/server/core/IServerLifecycleListener.html" title="interface in org.eclipse.wst.server.core">IServerLifecycleListener</A> listener)</CODE> |
| |
| <BR> |
| Removes a server lifecycle listener.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#setDefaultServer(org.eclipse.wst.server.core.IModule, org.eclipse.wst.server.core.IServer, IProgressMonitor)">setDefaultServer</A></B>(<A HREF="../../../../../org/eclipse/wst/server/core/IModule.html" title="interface in org.eclipse.wst.server.core">IModule</A> module, |
| <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core">IServer</A> server, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Sets the preferred runtime server for the given module.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getProjectProperties(IProject)"><!-- --></A><H3> |
| getProjectProperties</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IProjectProperties.html" title="interface in org.eclipse.wst.server.core">IProjectProperties</A> <B>getProjectProperties</B>(IProject project)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Project facet support should now be used instead of this API. @see |
| org.eclipse.wst.common.project.facet.core.IFacetedProject#getRuntime()</I> |
| <P> |
| <DD>Returns the preference information for the project. The project may not |
| be null. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>project</CODE> - a project |
| <DT><B>Returns:</B><DD>the properties of the project</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRuntimeTypes()"><!-- --></A><H3> |
| getRuntimeTypes</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html" title="interface in org.eclipse.wst.server.core">IRuntimeType</A>[] <B>getRuntimeTypes</B>()</PRE> |
| <DL> |
| <DD>Returns an array of all known runtime types. |
| <p> |
| A new array is returned on each call, so clients may store or modify the result. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the array of runtime types <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html" title="interface in org.eclipse.wst.server.core"><CODE>IRuntimeType</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findRuntimeType(java.lang.String)"><!-- --></A><H3> |
| findRuntimeType</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html" title="interface in org.eclipse.wst.server.core">IRuntimeType</A> <B>findRuntimeType</B>(java.lang.String id)</PRE> |
| <DL> |
| <DD>Returns the runtime type with the given id, or <code>null</code> |
| if none. This convenience method searches the list of known |
| runtime types (<A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getRuntimeTypes()"><CODE>getRuntimeTypes()</CODE></A>) for the one with a matching |
| runtime type id (<A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeType.html#getId()"><CODE>IRuntimeType.getId()</CODE></A>). The id may not be null. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - the runtime type id |
| <DT><B>Returns:</B><DD>the runtime type, or <code>null</code> if there is no runtime type |
| with the given id</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getServerTypes()"><!-- --></A><H3> |
| getServerTypes</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IServerType.html" title="interface in org.eclipse.wst.server.core">IServerType</A>[] <B>getServerTypes</B>()</PRE> |
| <DL> |
| <DD>Returns an array of all known server types. |
| <p> |
| A new array is returned on each call, so clients may store or modify the result. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the array of server types <A HREF="../../../../../org/eclipse/wst/server/core/IServerType.html" title="interface in org.eclipse.wst.server.core"><CODE>IServerType</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findServerType(java.lang.String)"><!-- --></A><H3> |
| findServerType</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IServerType.html" title="interface in org.eclipse.wst.server.core">IServerType</A> <B>findServerType</B>(java.lang.String id)</PRE> |
| <DL> |
| <DD>Returns the server type with the given id, or <code>null</code> |
| if none. This convenience method searches the list of known |
| server types (<A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getServerTypes()"><CODE>getServerTypes()</CODE></A>) for the one with a matching |
| server type id (<A HREF="../../../../../org/eclipse/wst/server/core/IServerType.html#getId()"><CODE>IServerType.getId()</CODE></A>). The id may not be null. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - the server type id |
| <DT><B>Returns:</B><DD>the server type, or <code>null</code> if there is no server type |
| with the given id</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findRuntime(java.lang.String)"><!-- --></A><H3> |
| findRuntime</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A> <B>findRuntime</B>(java.lang.String id)</PRE> |
| <DL> |
| <DD>Returns the runtime with the given id, or <code>null</code> |
| if none. This convenience method searches the list of known |
| runtimes (<A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getRuntimes()"><CODE>getRuntimes()</CODE></A>) for the one with a matching |
| runtime id (<A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html#getId()"><CODE>IRuntime.getId()</CODE></A>). The id may not be null. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - the runtime id |
| <DT><B>Returns:</B><DD>the runtime instance, or <code>null</code> if there is no runtime |
| with the given id</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRuntimes()"><!-- --></A><H3> |
| getRuntimes</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core">IRuntime</A>[] <B>getRuntimes</B>()</PRE> |
| <DL> |
| <DD>Returns an array of all known runtime instances. The list will not contain any |
| working copies. |
| <p> |
| A new array is returned on each call, so clients may store or modify the result. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a possibly-empty array of runtime instances <A HREF="../../../../../org/eclipse/wst/server/core/IRuntime.html" title="interface in org.eclipse.wst.server.core"><CODE>IRuntime</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findServer(java.lang.String)"><!-- --></A><H3> |
| findServer</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core">IServer</A> <B>findServer</B>(java.lang.String id)</PRE> |
| <DL> |
| <DD>Returns the server with the given id, or <code>null</code> |
| if none. This convenience method searches the list of known |
| servers (<A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#getServers()"><CODE>getServers()</CODE></A>) for the one with a matching |
| server id (<A HREF="../../../../../org/eclipse/wst/server/core/IServerAttributes.html#getId()"><CODE>IServerAttributes.getId()</CODE></A>). The id must not be null. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - the server id |
| <DT><B>Returns:</B><DD>the server instance, or <code>null</code> if there is no server |
| with the given id</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getServers()"><!-- --></A><H3> |
| getServers</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core">IServer</A>[] <B>getServers</B>()</PRE> |
| <DL> |
| <DD>Returns an array of all known server instances. The array will not include any |
| working copies. |
| <p> |
| A new array is returned on each call, so clients may store or modify the result. |
| </p> |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a possibly-empty array of server instances <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core"><CODE>IServer</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addRuntimeLifecycleListener(org.eclipse.wst.server.core.IRuntimeLifecycleListener)"><!-- --></A><H3> |
| addRuntimeLifecycleListener</H3> |
| <PRE> |
| public static void <B>addRuntimeLifecycleListener</B>(<A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeLifecycleListener.html" title="interface in org.eclipse.wst.server.core">IRuntimeLifecycleListener</A> listener)</PRE> |
| <DL> |
| <DD>Adds a new runtime lifecycle listener. |
| Has no effect if an identical listener is already registered. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - a runtime lifecycle listener<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#removeRuntimeLifecycleListener(org.eclipse.wst.server.core.IRuntimeLifecycleListener)"><CODE>removeRuntimeLifecycleListener(IRuntimeLifecycleListener)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeRuntimeLifecycleListener(org.eclipse.wst.server.core.IRuntimeLifecycleListener)"><!-- --></A><H3> |
| removeRuntimeLifecycleListener</H3> |
| <PRE> |
| public static void <B>removeRuntimeLifecycleListener</B>(<A HREF="../../../../../org/eclipse/wst/server/core/IRuntimeLifecycleListener.html" title="interface in org.eclipse.wst.server.core">IRuntimeLifecycleListener</A> listener)</PRE> |
| <DL> |
| <DD>Removes a runtime lifecycle listener. |
| Has no effect if the listener is not registered. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - a runtime lifecycle listener<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#addRuntimeLifecycleListener(org.eclipse.wst.server.core.IRuntimeLifecycleListener)"><CODE>addRuntimeLifecycleListener(IRuntimeLifecycleListener)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addServerLifecycleListener(org.eclipse.wst.server.core.IServerLifecycleListener)"><!-- --></A><H3> |
| addServerLifecycleListener</H3> |
| <PRE> |
| public static void <B>addServerLifecycleListener</B>(<A HREF="../../../../../org/eclipse/wst/server/core/IServerLifecycleListener.html" title="interface in org.eclipse.wst.server.core">IServerLifecycleListener</A> listener)</PRE> |
| <DL> |
| <DD>Adds a new server lifecycle listener. |
| Has no effect if an identical listener is already registered. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - a server lifecycle listener<DT><B>See Also:</B><DD><A HREF="../../../../../org/eclipse/wst/server/core/ServerCore.html#removeServerLifecycleListener(org.eclipse.wst.server.core.IServerLifecycleListener)"><CODE>removeServerLifecycleListener(IServerLifecycleListener)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="removeServerLifecycleListener(org.eclipse.wst.server.core.IServerLifecycleListener)"><!-- --></A><H3> |
| removeServerLifecycleListener</H3> |
| <PRE> |
| public static void <B>removeServerLifecycleListener</B>(<A HREF="../../../../../org/eclipse/wst/server/core/IServerLifecycleListener.html" title="interface in org.eclipse.wst.server.core">IServerLifecycleListener</A> listener)</PRE> |
| <DL> |
| <DD>Removes a server lifecycle listener. |
| Has no effect if the listener is not registered. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>listener</CODE> - a server lifecycle listener |
| #addServerLifecycleListener(IServerLifecycleListener)</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefaultServer(org.eclipse.wst.server.core.IModule)"><!-- --></A><H3> |
| getDefaultServer</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core">IServer</A> <B>getDefaultServer</B>(<A HREF="../../../../../org/eclipse/wst/server/core/IModule.html" title="interface in org.eclipse.wst.server.core">IModule</A> module)</PRE> |
| <DL> |
| <DD>Returns the preferred runtime server for the given module. This method |
| returns null if the server was never chosen or does not currently exist. (if the |
| server is recreated or was in a closed project, etc. this method will return |
| the original value if it becomes available again) |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>module</CODE> - a module |
| <DT><B>Returns:</B><DD>the current default server, or <code>null</code> if there is no |
| default server</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setDefaultServer(org.eclipse.wst.server.core.IModule, org.eclipse.wst.server.core.IServer, IProgressMonitor)"><!-- --></A><H3> |
| setDefaultServer</H3> |
| <PRE> |
| public static void <B>setDefaultServer</B>(<A HREF="../../../../../org/eclipse/wst/server/core/IModule.html" title="interface in org.eclipse.wst.server.core">IModule</A> module, |
| <A HREF="../../../../../org/eclipse/wst/server/core/IServer.html" title="interface in org.eclipse.wst.server.core">IServer</A> server, |
| IProgressMonitor monitor) |
| throws CoreException</PRE> |
| <DL> |
| <DD>Sets the preferred runtime server for the given module. Set the server to |
| null to clear the setting. If there is a problem saving the file, a CoreException |
| will be thrown. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>module</CODE> - the module to set the default for<DD><CODE>server</CODE> - the server to set the default server, or <code>null</code> |
| to unset the default<DD><CODE>monitor</CODE> - a progress monitor, or <code>null</code> if progress |
| reporting and cancellation are not desired |
| <DT><B>Throws:</B> |
| <DD><CODE>CoreException</CODE> - if there is a problem setting the default server</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isAutoPublishing()"><!-- --></A><H3> |
| isAutoPublishing</H3> |
| <PRE> |
| public static boolean <B>isAutoPublishing</B>()</PRE> |
| <DL> |
| <DD>Returns <code>true</code> if the preference is set to automatically |
| publish when starting servers, or <code>false</code> otherwise |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD><code>true</code> if the preference is set to automatically |
| publish when starting servers, or <code>false</code> otherwise<DT><B>Since:</B></DT> |
| <DD>3.0</DD> |
| </DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ServerCore.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../org/eclipse/wst/server/core/IServerWorkingCopy.html" title="interface in org.eclipse.wst.server.core"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../org/eclipse/wst/server/core/ServerEvent.html" title="class in org.eclipse.wst.server.core"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/eclipse/wst/server/core/ServerCore.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ServerCore.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
