filetransferproxy.html

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

<!-- ============ 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="handleIQ(org.xmpp.packet.IQ)"><!-- --></A><H3>
handleIQ</H3>
<PRE>
public boolean <B>handleIQ</B>(<A HREF="../../../../../org/xmpp/packet/IQ.html" title="class in org.xmpp.packet">IQ</A>&nbsp;packet)
                 throws <A HREF="../../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getInfo()"><!-- --></A><H3>
getInfo</H3>
<PRE>
public <A HREF="../../../../../org/jivesoftware/openfire/IQHandlerInfo.html" title="class in org.jivesoftware.openfire">IQHandlerInfo</A> <B>getInfo</B>()</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="initialize(org.jivesoftware.openfire.XMPPServer)"><!-- --></A><H3>
initialize</H3>
<PRE>
public void <B>initialize</B>(<A HREF="../../../../../org/jivesoftware/openfire/XMPPServer.html" title="class in org.jivesoftware.openfire">XMPPServer</A>&nbsp;server)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html#initialize(org.jivesoftware.openfire.XMPPServer)">BasicModule</A></CODE></B></DD>
<DD><p>Initializes the basic module.</p>
 <p/>
 <p>Inheriting classes that choose to override this method MUST
 call this initialize() method before accessing BasicModule resources.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/container/Module.html#initialize(org.jivesoftware.openfire.XMPPServer)">initialize</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html#initialize(org.jivesoftware.openfire.XMPPServer)">initialize</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>server</CODE> - the server hosting this module.</DL>
</DD>
</DL>
<HR>

<A NAME="start()"><!-- --></A><H3>
start</H3>
<PRE>
public void <B>start</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html#start()">BasicModule</A></CODE></B></DD>
<DD><p>Starts the basic module.</p>
 <p/>
 <p>Inheriting classes that choose to override this method MUST
 call this start() method before accessing BasicModule resources.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/container/Module.html#start()">start</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html#start()">start</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="stop()"><!-- --></A><H3>
stop</H3>
<PRE>
public void <B>stop</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html#stop()">BasicModule</A></CODE></B></DD>
<DD><p>Stops the basic module.</p>
 <p/>
 <p>Inheriting classes that choose to override this method MUST
 call this stop() method before accessing BasicModule resources.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/container/Module.html#stop()">stop</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html#stop()">stop</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="destroy()"><!-- --></A><H3>
destroy</H3>
<PRE>
public void <B>destroy</B>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html#destroy()">BasicModule</A></CODE></B></DD>
<DD><p>Destroys the module.</p>
 <p/>
 <p>Does nothing in the basic module.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/container/Module.html#destroy()">destroy</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/Module.html" title="interface in org.jivesoftware.openfire.container">Module</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html#destroy()">destroy</A></CODE> in class <CODE><A HREF="../../../../../org/jivesoftware/openfire/container/BasicModule.html" title="class in org.jivesoftware.openfire.container">BasicModule</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="enableFileTransferProxy(boolean)"><!-- --></A><H3>
enableFileTransferProxy</H3>
<PRE>
public void <B>enableFileTransferProxy</B>(boolean&nbsp;isEnabled)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isProxyEnabled()"><!-- --></A><H3>
isProxyEnabled</H3>
<PRE>
public boolean <B>isProxyEnabled</B>()</PRE>
<DL>
<DD>Returns true if the file transfer proxy is currently enabled and false if it is not.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Returns true if the file transfer proxy is currently enabled and false if it is not.</DL>
</DD>
</DL>
<HR>

<A NAME="setProxyPort(int)"><!-- --></A><H3>
setProxyPort</H3>
<PRE>
public void <B>setProxyPort</B>(int&nbsp;port)</PRE>
<DL>
<DD>Sets the port that the proxy operates on. This requires a restart of the file transfer proxy.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>port</CODE> - The port.</DL>
</DD>
</DL>
<HR>

<A NAME="getProxyPort()"><!-- --></A><H3>
getProxyPort</H3>
<PRE>
public int <B>getProxyPort</B>()</PRE>
<DL>
<DD>Returns the port that the file transfer proxy is opertating on.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Returns the port that the file transfer proxy is opertating on.</DL>
</DD>
</DL>
<HR>

<A NAME="getServiceDomain()"><!-- --></A><H3>
getServiceDomain</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>getServiceDomain</B>()</PRE>
<DL>
<DD>Returns the fully-qualifed domain name of this chat service.
 The domain is composed by the service name and the
 name of the XMPP server where the service is running.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the file transfer server domain (service name + host name).</DL>
</DD>
</DL>
<HR>

<A NAME="getAddress()"><!-- --></A><H3>
getAddress</H3>
<PRE>
public <A HREF="../../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A> <B>getAddress</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/jivesoftware/openfire/RoutableChannelHandler.html#getAddress()">RoutableChannelHandler</A></CODE></B></DD>
<DD>Returns the XMPP address. The address is used by services like the core
 server packet router to determine if a packet should be sent to the handler.
 Handlers that are working on behalf of the server should use the generic server
 hostname address (e.g. server.com).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/jivesoftware/openfire/RoutableChannelHandler.html#getAddress()">getAddress</A></CODE> in interface <CODE><A HREF="../../../../../org/jivesoftware/openfire/RoutableChannelHandler.html" title="interface in org.jivesoftware.openfire">RoutableChannelHandler</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the XMPP address.</DL>
</DD>