sipprovider.html

jsip开发文档,对于开发SIP软电话和presence服务很有用

<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="addSipListener(javax.sip.SipListener)"><!-- --></A><H3>
addSipListener</H3>
<PRE>
void <B>addSipListener</B>(<A HREF="../../javax/sip/SipListener.html" title="interface in javax.sip">SipListener</A>&nbsp;sipListener)
                    throws java.util.TooManyListenersException</PRE>
<DL>
<DD>This method registers the SipListener object to this SipProvider, once
 registered the SIP Listener recieve events emitted from the SipProvider. 
 This specification restricts a unicast Listener model, that is only one 
 Listener may be registered on the SipProvider. If an 
 attempt is made to re-register the existing registered SipListener this
 method returns silently.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sipListener</CODE> - the SipListener to be registered with the SipProvider.
<DT><B>Throws:</B>
<DD><CODE>java.util.TooManyListenersException</CODE> - when a new SipListener attempts to 
 register with the SipProvider when another SipListener is already 
 registered with this SipProvider.</DL>
</DD>
</DL>
<HR>

<A NAME="removeSipListener(javax.sip.SipListener)"><!-- --></A><H3>
removeSipListener</H3>
<PRE>
void <B>removeSipListener</B>(<A HREF="../../javax/sip/SipListener.html" title="interface in javax.sip">SipListener</A>&nbsp;sipListener)</PRE>
<DL>
<DD>Removes the specified SipListener from this SipProvider. This method 
 returns silently if the SipListener is not registered with the SipProvider.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sipListener</CODE> - the SipListener to be removed from this SipProvider.</DL>
</DD>
</DL>
<HR>

<A NAME="getSipStack()"><!-- --></A><H3>
getSipStack</H3>
<PRE>
<A HREF="../../javax/sip/SipStack.html" title="interface in javax.sip">SipStack</A> <B>getSipStack</B>()</PRE>
<DL>
<DD>Returns the SipStack that created this SipProvider. A SipProvider
 can only be attached to a single SipStack object that belongs to the same
 implementation as this SipProvider.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the SipStack that created this SipProvider.<DT><B>See Also:</B><DD><A HREF="../../javax/sip/SipStack.html" title="interface in javax.sip"><CODE>SipStack</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getListeningPoint()"><!-- --></A><H3>
getListeningPoint</H3>
<PRE>
<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A> <B>getListeningPoint</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since v1.2. Note that in v1.1 a SipProvider could only be
 associated to a single listening point, this restriction has been lifted to allow
 a SipProvider to have a specific ListeningPoints for each transport. 
 For backwards compatibility, this method will return the first 
 ListeningPoint of the list of ListeningPoints associated with the 
 SipProvider. This method has been replaced with 
 <A HREF="../../javax/sip/SipProvider.html#getListeningPoints()"><CODE>getListeningPoints()</CODE></A>.</I>
<P>
<DD>Returns the ListeningPoint of this SipProvider. A SipProvider has a 
 single Listening Point at any specific point in time.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getListeningPoints()"><!-- --></A><H3>
getListeningPoints</H3>
<PRE>
<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A>[] <B>getListeningPoints</B>()</PRE>
<DL>
<DD>Returns all the ListeningPoints of this SipProvider. A SipProvider may have 
 a Listening Point for each specific transport type at any specific point 
 in time. A SipProvider must use the same transport for 
 sending responses that was used for sending the outbound request.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>an array of ListeningPoints associated to this SipProvider.<DT><B>Since:</B></DT>
  <DD>1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="setListeningPoint(javax.sip.ListeningPoint)"><!-- --></A><H3>
setListeningPoint</H3>
<PRE>
void <B>setListeningPoint</B>(<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A>&nbsp;listeningPoint)
                       throws <A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Since v1.2. Note that in v1.1 a SipProvider could only
 be associated to a single listening point, this restriction has been lifted 
 to allow a SipProvider to have a specific ListeningPoints for each transport. 
 For backwards compatibility, this method will add the ListeningPoint to
 the list of ListeningPoints associated with the SipProvider. This method
 has been replaced with <A HREF="../../javax/sip/SipProvider.html#addListeningPoint(javax.sip.ListeningPoint)"><CODE>addListeningPoint(ListeningPoint)</CODE></A>,
 the same semantics apply to this method.</I>
<P>
<DD>This method sets the ListeningPoint of the SipProvider.
<P>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="addListeningPoint(javax.sip.ListeningPoint)"><!-- --></A><H3>
addListeningPoint</H3>
<PRE>
void <B>addListeningPoint</B>(<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A>&nbsp;listeningPoint)
                       throws <A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A>,
                              <A HREF="../../javax/sip/TransportAlreadySupportedException.html" title="class in javax.sip">TransportAlreadySupportedException</A></PRE>
<DL>
<DD>This method adds the supplied ListeningPoint to the list of 
 ListeningPoints associated to this SipProvider. A SipProvider can only
 have a single ListeningPoint for each transport type at any specific time.
 Multiple SipProviders are prohibited to listen on the same ListeningPoints.
 This method returns silently if the same ListeningPoint argument is re-set on 
 the SipProvider. If there is a ListeningPoint with the same transport but
 different IP or port, the implementation is expected to throw
 an exception.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listeningPoint</CODE> - - the listening point to add to this ListeningPoint
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></CODE> - if the supplied ListeningPoint is being used
 by another SipProvider or if there is already a ListeningPoint for the given transport.
<DD><CODE><A HREF="../../javax/sip/TransportAlreadySupportedException.html" title="class in javax.sip">TransportAlreadySupportedException</A></CODE> - if there is already a 
 ListeningPoint associated to this SipProvider with the same transport of 
 the ListeningPoint.<DT><B>Since:</B></DT>
  <DD>1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getListeningPoint(java.lang.String)"><!-- --></A><H3>
getListeningPoint</H3>
<PRE>
<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A> <B>getListeningPoint</B>(java.lang.String&nbsp;transport)</PRE>
<DL>
<DD>Get the listening point for a given transport. Null is returned if there is no 
 listening point for that transport.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>transport</CODE> - -- the transport for the listening point<DT><B>Since:</B></DT>
  <DD>1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="removeListeningPoint(javax.sip.ListeningPoint)"><!-- --></A><H3>
removeListeningPoint</H3>
<PRE>
void <B>removeListeningPoint</B>(<A HREF="../../javax/sip/ListeningPoint.html" title="interface in javax.sip">ListeningPoint</A>&nbsp;listeningPoint)
                          throws <A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></PRE>
<DL>
<DD>Removes the specified ListeningPoint from this SipProvider. This method 
 returns silently if the ListeningPoint is not associated to this 
 SipProvider. A SipProvider must have at least a single ListeningPoint at 
 all times. When the ListeningPoint is removed the SipProvider no further 
 requests will be sent out over this ListeningPoint.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>listeningPoint</CODE> - the ListenPoint to be removed from this SipProvider.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/ObjectInUseException.html" title="class in javax.sip">ObjectInUseException</A></CODE> - if the ListeningPoint is already in use or 
 is the last ListeningPoint associated with this SipProvider.<DT><B>Since:</B></DT>
  <DD>1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="getNewCallId()"><!-- --></A><H3>
getNewCallId</H3>
<PRE>
<A HREF="../../javax/sip/header/CallIdHeader.html" title="interface in javax.sip.header">CallIdHeader</A> <B>getNewCallId</B>()</PRE>
<DL>
<DD>Returns a unique CallIdHeader for identifying dialogues between two
 SIP applications.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the new CallIdHeader unique within the SipProvider.</DL>
</DD>
</DL>
<HR>

<A NAME="getNewClientTransaction(javax.sip.message.Request)"><!-- --></A><H3>
getNewClientTransaction</H3>
<PRE>
<A HREF="../../javax/sip/ClientTransaction.html" title="interface in javax.sip">ClientTransaction</A> <B>getNewClientTransaction</B>(<A HREF="../../javax/sip/message/Request.html" title="interface in javax.sip.message">Request</A>&nbsp;request)
                                          throws <A HREF="../../javax/sip/TransactionUnavailableException.html" title="class in javax.sip">TransactionUnavailableException</A></PRE>
<DL>
<DD>Before an application can send a new request it must first request 
 a new client transaction to handle that Request. This method is called 
 by the application to create the new client transaction befores it sends 
 the Request on that transaction. This methods returns 
 a new unique client transaction that can be passed to send Requests 
 statefully.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the new Request message that is to handled statefully by 
 the ClientTransaction.
<DT><B>Returns:</B><DD>a new unique client transaction.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../javax/sip/TransactionUnavailableException.html" title="class in javax.sip">TransactionUnavailableException</A></CODE> - if a new transaction can not be created, for example
 the next hop of the request can not be determined.<DT><B>See Also:</B><DD><A HREF="../../javax/sip/ClientTransaction.html" title="interface in javax.sip"><CODE>ClientTransaction</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getNewServerTransaction(javax.sip.message.Request)"><!-- --></A><H3>
getNewServerTransaction</H3>
<PRE>
<A HREF="../../javax/sip/ServerTransaction.html" title="interface in javax.sip">ServerTransaction</A> <B>getNewServerTransaction</B>(<A HREF="../../javax/sip/message/Request.html" title="interface in javax.sip.message">Request</A>&nbsp;request)
                                          throws <A HREF="../../javax/sip/TransactionAlreadyExistsException.html" title="class in javax.sip">TransactionAlreadyExistsException</A>,