[Asterisk-java-cvs] CVS: asterisk-java/src/java/net/sf/asterisk/manager/event RegistryEvent.java,1.3,1.4

[Stefan R. <sr...@us...>]

Update of /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/event
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv23356/src/java/net/sf/asterisk/manager/event

Modified Files:
	RegistryEvent.java 
Log Message:
Updated javadoc for setUser() as patch for Asterisk bug 4916 has been commited to CVS-HEAD.

Index: RegistryEvent.java
===================================================================
RCS file: /cvsroot/asterisk-java/asterisk-java/src/java/net/sf/asterisk/manager/event/RegistryEvent.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -p -r1.3 -r1.4
--- RegistryEvent.java	7 Aug 2005 18:31:30 -0000	1.3
+++ RegistryEvent.java	8 Aug 2005 04:17:50 -0000	1.4
@@ -17,8 +17,8 @@
 package net.sf.asterisk.manager.event;
 
 /**
- * A RegistryEvent is triggered when this asterisk server attempts to registrer as a client at
- * another SIP or IAX server.<br>
+ * A RegistryEvent is triggered when this asterisk server attempts to registrer
+ * as a client at another SIP or IAX server.<br>
  * This event is implemented in <code>channels/chan_iax2.c</code> and
  * <code>channels/chan_sip.c</code>
  * 
@@ -45,8 +45,8 @@ public class RegistryEvent extends Manag
     }
 
     /**
-     * Returns the type of channel that is registered, i.e. "IAX2" for an IAX2 channel or "SIP" for
-     * a SIP channel.
+     * Returns the type of channel that is registered, i.e. "IAX2" for an IAX2
+     * channel or "SIP" for a SIP channel.
      */
     public String getChannel()
     {
@@ -63,8 +63,8 @@ public class RegistryEvent extends Manag
 
     /**
      * Returns the domain or host name of the SIP or IAX2 server.<br>
-     * This is the host part used in the <code>register</code> lines in <code>iax.conf</code>
-     * and <code>sip.conf</code>.
+     * This is the host part used in the <code>register</code> lines in
+     * <code>iax.conf</code> and <code>sip.conf</code>.
      */
     public String getDomain()
     {
@@ -81,8 +81,8 @@ public class RegistryEvent extends Manag
 
     /**
      * Returns the username used for registration.<br>
-     * For SIP channels this is not used at all, IAX2 sends the username in case of a registration
-     * failure.
+     * SIP send the username in case of a registration timeout, IAX2 in case of
+     * a registration failure. Otherwise the username is <code>null</code>.
      */
     public String getUsername()
     {
@@ -96,12 +96,12 @@ public class RegistryEvent extends Manag
     {
         this.username = username;
     }
-    
 
     /**
-     * Sets the username used for registration.<br>
-     * Please do not use this method it is a temporary workaround until
-     * Asterisk bug 4916 is acted upon.
+     * Sets the username used for registration.
+     * 
+     * @deprecated Please do not use this method it is a workaround for Asterisk
+     *             1.0.x servers. See Asterisk bug 4916.
      */
     public void setUser(String username)
     {
@@ -110,8 +110,8 @@ public class RegistryEvent extends Manag
 
     /**
      * Returns the registration state.<br>
-     * For sip this may be one of (not sure if all of these are exposed via the manager api, at
-     * least "Registered" and "Timeout" are used though)
+     * For sip this may be one of (not sure if all of these are exposed via the
+     * manager api, at least "Registered" and "Timeout" are used though)
      * <ul>
      * <li>Unregistered</li>
      * <li>Request Sent</li>
@@ -121,11 +121,11 @@ public class RegistryEvent extends Manag
      * <li>Timeout</li>
      * <li>No Authentication</li>
      * </ul>
-     * iax2 only uses
+     * IAX2 only uses
      * <ul>
      * <li>Rejected</li>
      * </ul>
-     * Successful iax2 registrations do not use the this property at all.
+     * Successful IAX2 registrations do not use the this property at all.
      */
     public String getStatus()
     {