pluginmanager.html

开源软件openfire的API文件。进行openfire的二次开发所必需的工具。

shutdown</H3>
<PRE>
public void <B>shutdown</B>()</PRE>
<DL>
<DD>Shuts down all running plugins.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="installPlugin(java.io.InputStream, java.lang.String)"><!-- --></A><H3>
installPlugin</H3>
<PRE>
public boolean <B>installPlugin</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;in,
                             <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;pluginFilename)</PRE>
<DL>
<DD>Installs or updates an existing plugin.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>in</CODE> - the input stream that contains the new plugin definition.<DD><CODE>pluginFilename</CODE> - the filename of the plugin to create or update.
<DT><B>Returns:</B><DD>true if the plugin was successfully installed or updated.</DL>
</DD>
</DL>
<HR>

<A NAME="isPluginDownloaded(java.lang.String)"><!-- --></A><H3>
isPluginDownloaded</H3>
<PRE>
public boolean <B>isPluginDownloaded</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;pluginFilename)</PRE>
<DL>
<DD>Returns true if the specified filename, that belongs to a plugin, exists.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pluginFilename</CODE> - the filename of the plugin to create or update.
<DT><B>Returns:</B><DD>true if the specified filename, that belongs to a plugin, exists.</DL>
</DD>
</DL>
<HR>

<A NAME="getPlugins()"><!-- --></A><H3>
getPlugins</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Collection.html" title="class or interface in java.util">Collection</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/container/Plugin.html" title="interface in org.jivesoftware.openfire.container">Plugin</A>&gt; <B>getPlugins</B>()</PRE>
<DL>
<DD>Returns a Collection of all installed plugins.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>a Collection of all installed plugins.</DL>
</DD>
</DL>
<HR>

<A NAME="getPlugin(java.lang.String)"><!-- --></A><H3>
getPlugin</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/container/Plugin.html" title="interface in org.jivesoftware.openfire.container">Plugin</A> <B>getPlugin</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Returns a plugin by name or <tt>null</tt> if a plugin with that name does not
 exist. The name is the name of the directory that the plugin is in such as
 "broadcast".
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the plugin.
<DT><B>Returns:</B><DD>the plugin.</DL>
</DD>
</DL>
<HR>

<A NAME="getPluginDirectory(org.jivesoftware.openfire.container.Plugin)"><!-- --></A><H3>
getPluginDirectory</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> <B>getPluginDirectory</B>(<A HREF="../../../../org/jivesoftware/openfire/container/Plugin.html" title="interface in org.jivesoftware.openfire.container">Plugin</A>&nbsp;plugin)</PRE>
<DL>
<DD>Returns the plugin's directory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin.
<DT><B>Returns:</B><DD>the plugin's directory.</DL>
</DD>
</DL>
<HR>

<A NAME="getPluginFile(java.lang.String)"><!-- --></A><H3>
getPluginFile</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/io/File.html" title="class or interface in java.io">File</A> <B>getPluginFile</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
<DL>
<DD>Returns the JAR or WAR file that created the plugin.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the plugin.
<DT><B>Returns:</B><DD>the plugin JAR or WAR file.</DL>
</DD>
</DL>
<HR>

<A NAME="isExecuted()"><!-- --></A><H3>
isExecuted</H3>
<PRE>
public boolean <B>isExecuted</B>()</PRE>
<DL>
<DD>Returns true if at least one attempt to load plugins has been done. A true value does not mean
 that available plugins have been loaded nor that plugins to be added in the future are already
 loaded. :)<p>

 TODO Current version does not consider child plugins that may be loaded in a second attempt. It either
 TODO consider plugins that were found but failed to be loaded due to some error.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if at least one attempt to load plugins has been done.</DL>
</DD>
</DL>
<HR>

<A NAME="unloadPlugin(java.lang.String)"><!-- --></A><H3>
unloadPlugin</H3>
<PRE>
public void <B>unloadPlugin</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;pluginName)</PRE>
<DL>
<DD>Unloads a plugin. The <A HREF="../../../../org/jivesoftware/openfire/container/Plugin.html#destroyPlugin()"><CODE>Plugin.destroyPlugin()</CODE></A> method will be called and then
 any resources will be released. The name should be the name of the plugin directory
 and not the name as given by the plugin meta-data. This method only removes
 the plugin but does not delete the plugin JAR file. Therefore, if the plugin JAR
 still exists after this method is called, the plugin will be started again the next
 time the plugin monitor process runs. This is useful for "restarting" plugins.<p>
 <p/>
 This method is called automatically when a plugin's JAR file is deleted.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>pluginName</CODE> - the name of the plugin to unload.</DL>
</DD>
</DL>
<HR>

<A NAME="loadClass(org.jivesoftware.openfire.container.Plugin, java.lang.String)"><!-- --></A><H3>
loadClass</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html" title="class or interface in java.lang">Class</A> <B>loadClass</B>(<A HREF="../../../../org/jivesoftware/openfire/container/Plugin.html" title="interface in org.jivesoftware.openfire.container">Plugin</A>&nbsp;plugin,
                       <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;className)
                throws <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A>,
                       <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalAccessException.html" title="class or interface in java.lang">IllegalAccessException</A>,
                       <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/InstantiationException.html" title="class or interface in java.lang">InstantiationException</A></PRE>
<DL>
<DD>Loads a class from the classloader of a plugin.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin.<DD><CODE>className</CODE> - the name of the class to load.
<DT><B>Returns:</B><DD>the class.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/ClassNotFoundException.html" title="class or interface in java.lang">ClassNotFoundException</A></CODE> - if the class was not found.
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/IllegalAccessException.html" title="class or interface in java.lang">IllegalAccessException</A></CODE> - if not allowed to access the class.
<DD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/InstantiationException.html" title="class or interface in java.lang">InstantiationException</A></CODE> - if the class could not be created.</DL>
</DD>
</DL>
<HR>

<A NAME="getDevEnvironment(org.jivesoftware.openfire.container.Plugin)"><!-- --></A><H3>
getDevEnvironment</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/container/PluginDevEnvironment.html" title="class in org.jivesoftware.openfire.container">PluginDevEnvironment</A> <B>getDevEnvironment</B>(<A HREF="../../../../org/jivesoftware/openfire/container/Plugin.html" title="interface in org.jivesoftware.openfire.container">Plugin</A>&nbsp;plugin)</PRE>
<DL>
<DD>Returns a plugin's dev environment if development mode is enabled for
 the plugin.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin.
<DT><B>Returns:</B><DD>the plugin dev environment, or <tt>null</tt> if development
         mode is not enabled for the plugin.</DL>
</DD>
</DL>
<HR>

<A NAME="getName(org.jivesoftware.openfire.container.Plugin)"><!-- --></A><H3>
getName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getName</B>(<A HREF="../../../../org/jivesoftware/openfire/container/Plugin.html" title="interface in org.jivesoftware.openfire.container">Plugin</A>&nbsp;plugin)</PRE>
<DL>
<DD>Returns the name of a plugin. The value is retrieved from the plugin.xml file
 of the plugin. If the value could not be found, <tt>null</tt> will be returned.
 Note that this value is distinct from the name of the plugin directory.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin.
<DT><B>Returns:</B><DD>the plugin's name.</DL>
</DD>
</DL>
<HR>

<A NAME="getDescription(org.jivesoftware.openfire.container.Plugin)"><!-- --></A><H3>
getDescription</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDescription</B>(<A HREF="../../../../org/jivesoftware/openfire/container/Plugin.html" title="interface in org.jivesoftware.openfire.container">Plugin</A>&nbsp;plugin)</PRE>
<DL>
<DD>Returns the description of a plugin. The value is retrieved from the plugin.xml file
 of the plugin. If the value could not be found, <tt>null</tt> will be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>plugin</CODE> - the plugin.
<DT><B>Returns:</B><DD>the plugin's description.</DL>
</DD>
</DL>
<HR>

<A NAME="getAuthor(org.jivesoftware.openfire.container.Plugin)"><!-- --></A><H3>
getAuthor</H3>
<PRE>