svn commit: r990287 - /mina/vysper/trunk/server/core/src/main/java/org/apache/vysper/xmpp/addressing/EntityUtils.java

[be...@apache.org]

Author: berndf
Date: Fri Aug 27 22:18:35 2010
New Revision: 990287

URL: http://svn.apache.org/viewvc?rev=990287&view=rev
Log:
VYSPER-246: javadoc EntityUtils

Modified:
    mina/vysper/trunk/server/core/src/main/java/org/apache/vysper/xmpp/addressing/EntityUtils.java

Modified: mina/vysper/trunk/server/core/src/main/java/org/apache/vysper/xmpp/addressing/EntityUtils.java
URL: http://svn.apache.org/viewvc/mina/vysper/trunk/server/core/src/main/java/org/apache/vysper/xmpp/addressing/EntityUtils.java?rev=990287&r1=990286&r2=990287&view=diff
==============================================================================
--- mina/vysper/trunk/server/core/src/main/java/org/apache/vysper/xmpp/addressing/EntityUtils.java (original)
+++ mina/vysper/trunk/server/core/src/main/java/org/apache/vysper/xmpp/addressing/EntityUtils.java Fri Aug 27 22:18:35 2010
@@ -7,14 +7,32 @@ import org.apache.vysper.xmpp.server.Ser
  */
 public class EntityUtils {
 
+    /**
+     * checks a JID to be addressed to the server's domain
+     * @param toVerify - JID to be verified 
+     * @param serverJID - JID of the server
+     * @return TRUE iff toVerify JID equals the server's JID
+     */
     public static boolean isAddressingServer(Entity toVerify, Entity serverJID) {
         return toVerify.getDomain().equals(serverJID.getDomain());
     }
     
+    /**
+     * checks a JID to be addressed to any of the server's component
+     * @param toVerify - JID to be verified 
+     * @param serverJID - JID of the server
+     * @return TRUE iff toVerify's domain is a component of the given server JID
+     */
     public static boolean isAddressingServerComponent(Entity toVerify, Entity serverJID) {
         return toVerify.getDomain().endsWith("." + serverJID.getDomain());
     }
 
+    /**
+     * creates a JID with only a domain part set, the domain part being assembled from a subdomain and the server domain.
+     * @param subdomain
+     * @param serverRuntimeContext to retrieve the server JID
+     * @return subdomain.serverdomain.tld
+     */
     public static Entity createComponentDomain(String subdomain, ServerRuntimeContext serverRuntimeContext) {
         try {
             return EntityImpl.parse(subdomain + "." + serverRuntimeContext.getServerEnitity().getDomain());