mediaproxyservice.html

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

</DD>
</DL>
<HR>

<A NAME="getName()"><!-- --></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>()</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../org/jivesoftware/openfire/container/BasicModule.html#getName()">BasicModule</A></CODE></B></DD>
<DD><p>Obtain the name of the module.</p>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/container/Module.html#getName()">getName</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#getName()">getName</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>Returns:</B><DD>The name of the module</DL>
</DD>
</DL>
<HR>

<A NAME="getItems(java.lang.String, java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
getItems</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/disco/DiscoItem.html" title="class in org.jivesoftware.openfire.disco">DiscoItem</A>&gt; <B>getItems</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,
                                    <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;node,
                                    <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;senderJID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoItemsProvider.html#getItems(java.lang.String, java.lang.String, org.xmpp.packet.JID)">DiscoItemsProvider</A></CODE></B></DD>
<DD>Returns an Iterator (of DiscoItem) with the target entity's items or null if none. Each DiscoItem
 must include a JID attribute and may include the name and node attributes of the entity. In
 case that the sender of the disco request is not authorized to discover items an
 UnauthorizedException will be thrown.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoItemsProvider.html#getItems(java.lang.String, java.lang.String, org.xmpp.packet.JID)">getItems</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoItemsProvider.html" title="interface in org.jivesoftware.openfire.disco">DiscoItemsProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the recipient JID's name.<DD><CODE>node</CODE> - the requested disco node.<DD><CODE>senderJID</CODE> - the XMPPAddress of user that sent the disco items request.
<DT><B>Returns:</B><DD>an Iterator (of DiscoItem) with the target entity's items or null if none.</DL>
</DD>
</DL>
<HR>

<A NAME="process(org.xmpp.packet.Packet)"><!-- --></A><H3>
process</H3>
<PRE>
public void <B>process</B>(<A HREF="../../../../org/xmpp/packet/Packet.html" title="class in org.xmpp.packet">Packet</A>&nbsp;packet)
             throws <A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A>,
                    <A HREF="../../../../org/jivesoftware/openfire/PacketException.html" title="class in org.jivesoftware.openfire">PacketException</A></PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/ChannelHandler.html#process(T)">ChannelHandler</A></CODE></B></DD>
<DD>Process an XMPP packet.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/ChannelHandler.html#process(T)">process</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/ChannelHandler.html" title="interface in org.jivesoftware.openfire">ChannelHandler</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>packet</CODE> - a packet to process.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/auth/UnauthorizedException.html" title="class in org.jivesoftware.openfire.auth">UnauthorizedException</A></CODE> - if not allowed to process the packet.
<DD><CODE><A HREF="../../../../org/jivesoftware/openfire/PacketException.html" title="class in org.jivesoftware.openfire">PacketException</A></CODE> - thrown if the packet is malformed (results in the sender's
      session being shutdown).</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>
</DL>
<HR>

<A NAME="getItems()"><!-- --></A><H3>
getItems</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<A HREF="../../../../org/jivesoftware/openfire/disco/DiscoServerItem.html" title="class in org.jivesoftware.openfire.disco">DiscoServerItem</A>&gt; <B>getItems</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/ServerItemsProvider.html#getItems()">ServerItemsProvider</A></CODE></B></DD>
<DD>Returns an Iterator (of DiscoServerItem) with the items associated with the server or null
 if none.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/ServerItemsProvider.html#getItems()">getItems</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/ServerItemsProvider.html" title="interface in org.jivesoftware.openfire.disco">ServerItemsProvider</A></CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>an Iterator (of DiscoServerItem) with the items associated with the server or null
         if none.</DL>
</DD>
</DL>
<HR>

<A NAME="getIdentities(java.lang.String, java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
getIdentities</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;org.dom4j.Element&gt; <B>getIdentities</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,
                                                 <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;node,
                                                 <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;senderJID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html#getIdentities(java.lang.String, java.lang.String, org.xmpp.packet.JID)">DiscoInfoProvider</A></CODE></B></DD>
<DD>Returns an Iterator (of Element) with the target entity's identities. Each Element must
 include the categoty, type and name attributes of the entity.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html#getIdentities(java.lang.String, java.lang.String, org.xmpp.packet.JID)">getIdentities</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html" title="interface in org.jivesoftware.openfire.disco">DiscoInfoProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the recipient JID's name.<DD><CODE>node</CODE> - the requested disco node.<DD><CODE>senderJID</CODE> - the XMPPAddress of user that sent the disco info request.
<DT><B>Returns:</B><DD>an Iterator (of Element) with the target entity's identities.</DL>
</DD>
</DL>
<HR>

<A NAME="getFeatures(java.lang.String, java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
getFeatures</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Iterator.html" title="class or interface in java.util">Iterator</A>&lt;<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>&gt; <B>getFeatures</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,
                                    <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;node,
                                    <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;senderJID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html#getFeatures(java.lang.String, java.lang.String, org.xmpp.packet.JID)">DiscoInfoProvider</A></CODE></B></DD>
<DD>Returns an Iterator (of String) with the supported features. The features to include are the
 features offered and supported protocols by the target entity identified by the requested
 name and node.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html#getFeatures(java.lang.String, java.lang.String, org.xmpp.packet.JID)">getFeatures</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html" title="interface in org.jivesoftware.openfire.disco">DiscoInfoProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the recipient JID's name.<DD><CODE>node</CODE> - the requested disco node.<DD><CODE>senderJID</CODE> - the XMPPAddress of user that sent the disco info request.
<DT><B>Returns:</B><DD>an Iterator (of String) with the supported features.</DL>
</DD>
</DL>
<HR>

<A NAME="getExtendedInfo(java.lang.String, java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
getExtendedInfo</H3>
<PRE>
public <A HREF="../../../../org/jivesoftware/openfire/forms/spi/XDataFormImpl.html" title="class in org.jivesoftware.openfire.forms.spi">XDataFormImpl</A> <B>getExtendedInfo</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,
                                     <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;node,
                                     <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;senderJID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html#getExtendedInfo(java.lang.String, java.lang.String, org.xmpp.packet.JID)">DiscoInfoProvider</A></CODE></B></DD>
<DD>Returns an XDataForm with the extended information about the entity or null if none. Each bit
 of information about the entity must be included as a value of a field of the form.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html#getExtendedInfo(java.lang.String, java.lang.String, org.xmpp.packet.JID)">getExtendedInfo</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html" title="interface in org.jivesoftware.openfire.disco">DiscoInfoProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the recipient JID's name.<DD><CODE>node</CODE> - the requested disco node.<DD><CODE>senderJID</CODE> - the XMPPAddress of user that sent the disco info request.
<DT><B>Returns:</B><DD>an XDataForm with the extended information about the entity or null if none.</DL>
</DD>
</DL>
<HR>

<A NAME="hasInfo(java.lang.String, java.lang.String, org.xmpp.packet.JID)"><!-- --></A><H3>
hasInfo</H3>
<PRE>
public boolean <B>hasInfo</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,
                       <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;node,
                       <A HREF="../../../../org/xmpp/packet/JID.html" title="class in org.xmpp.packet">JID</A>&nbsp;senderJID)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html#hasInfo(java.lang.String, java.lang.String, org.xmpp.packet.JID)">DiscoInfoProvider</A></CODE></B></DD>
<DD>Returns true if we can provide information related to the requested name and node. For
 example, if the requested name refers to a non-existant MUC room then the answer will be
 false. In case that the sender of the disco request is not authorized to discover this
 information an UnauthorizedException will be thrown.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html#hasInfo(java.lang.String, java.lang.String, org.xmpp.packet.JID)">hasInfo</A></CODE> in interface <CODE><A HREF="../../../../org/jivesoftware/openfire/disco/DiscoInfoProvider.html" title="interface in org.jivesoftware.openfire.disco">DiscoInfoProvider</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the recipient JID's name.<DD><CODE>node</CODE> - the requested disco node.<DD><CODE>senderJID</CODE> - the XMPPAddress of user that sent the disco info request.
<DT><B>Returns:</B><DD>true if we can provide information related to the requested name and node.</DL>
</DD>
</DL>
<HR>

<A NAME="getAgents()"><!-- --></A><H3>
getAgents</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/mediaproxy/MediaProxySession.html" title="class in org.jivesoftware.openfire.mediaproxy">MediaProxySession</A>&gt; <B>getAgents</B>()</PRE>
<DL>
<DD>Return the list of active Agents
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>list of active agents</DL>
</DD>
</DL>
<HR>

<A NAME="setKeepAliveDelay(long)"><!-- --></A><H3>
setKeepAliveDelay</H3>
<PRE>
public void <B>setKeepAliveDelay</B>(long&nbsp;delay)</PRE>
<DL>
<DD>Set the keep alive delay of the mediaproxy agents.
 When an agent stay more then this delay, the agent is destroyed.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>delay</CODE> - time in millis</DL>
</DD>
</DL>
<HR>

<A NAME="getIdleTime()"><!-- --></A><H3>
getIdleTime</H3>
<PRE>
public long <B>getIdleTime</B>()</PRE>
<DL>
<DD>Returns the maximum amount of time (in milleseconds) that a session can
 be idle before it's closed.