XMPPAddress.java 10.4 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5
/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
Matt Tucker's avatar
Matt Tucker committed
6
 * Copyright (C) 2004 Jive Software. All rights reserved.
Matt Tucker's avatar
Matt Tucker committed
7
 *
Matt Tucker's avatar
Matt Tucker committed
8 9
 * This software is published under the terms of the GNU Public License (GPL),
 * a copy of which is included in this distribution.
Matt Tucker's avatar
Matt Tucker committed
10
 */
Matt Tucker's avatar
Matt Tucker committed
11

Matt Tucker's avatar
Matt Tucker committed
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
package org.jivesoftware.messenger;

import org.jivesoftware.util.CacheSizes;
import org.jivesoftware.util.Cacheable;

/**
 * Represents a single XMPP delivery node, identified by
 * a XMPPAddress.<p>
 *
 * A normal full address is of the form: user@server/resource. However
 * a 'bare address' is only composed of user@server and omits or ignores
 * the resource. The bare address is useful for referring to a generic
 * delivery node, without specifying the resource (allowing the normal
 * resource priority routing to determine where it is being delivered).
 *
 * @author Iain Shigeoka
 */
public class XMPPAddress implements Cacheable {

    private transient String cached;
    private transient String cachedBare;
    private transient String cachedPrep;
    private transient String cachedBarePrep;

    /**
     * The user name associated with this address.
     */
    private String name;
    private transient String namePrep;

    /**
     * The name of the XMPP host domain (server host name).
     */
    private String host;
    private transient String hostPrep;

    /**
     * The address resource attribute typically identifying
     * specific delivery points associated with a user account
     */
    private String resource;
    private transient String resourcePrep;

    /**
     * Dirty flag indicating that the cached address string must
     * be regenerated because a set*() method
     * was called.
     */
    private transient boolean dirty = true;

    /**
     * Create a local XMPPAddress.
     *
     * @param username the user name for the id.
     * @param resource the resource for the id.
     */
    public XMPPAddress(String username, String host, String resource) {
        setHost(host);
        setName(username);
        setResource(resource);
    }

    /**
     * Create a XMPP ID by parsing the given address string.
     *
     * @param address the address string to parse.
     */
    public static XMPPAddress parseJID(String address) {
        String name;
        String host;
        String resource;
        if (address == null) {
            return null;
        }
        else {
            address = address.trim();
            int atPos = address.indexOf('@');
            int slashPos = address.indexOf('/');
            if (atPos != -1) {
                name = address.substring(0, atPos);
            }
            else {
                name = "";
            }
            if (slashPos == -1 || slashPos == address.length() - 1) {
                slashPos = address.length();
                resource = "";
            }
            else {
                resource = address.substring(slashPos + 1);
            }
            host = address.substring(atPos + 1, slashPos);
        }
        return new XMPPAddress(name, host, resource);
    }

    /**
     * Returns the XMPP address with any resource information removed. For example,
     * for the address "matt@jivesoftware.com/Smack", "matt@jivesoftware.com" would
     * be returned.
     *
     * @param XMPPAddress the XMPP address.
     * @return the bare XMPP address without resource information.
     */
    public static String parseBareAddress(String XMPPAddress) {
        if (XMPPAddress == null) {
            return null;
        }
        int slashIndex = XMPPAddress.indexOf("/");
        if (slashIndex < 0) {
            return XMPPAddress;
        }
        else if (slashIndex == 0) {
            return "";
        }
        else {
            return XMPPAddress.substring(0, slashIndex);
        }
    }

    /**
     * Obtain the XMPP name for this address.
     *
     * @return the name or null if no id has been set or no name is defined (server ID).
     */
    public String getName() {
        return name;
    }

    /**
     * Obtain the XMPP nameprep name for this address.
     *
     * @return The name or null if no id has been set or no name is defined (server ID).
     */
    public String getNamePrep() {
        if (name != null) {
            if (namePrep == null) {
                namePrep = NodePrep.prep(name);
            }
        }
        return namePrep;
    }

    /**
     * Set the XMPP name for this address.
     *
     * @param name the name.
     */
    public void setName(String name) {
        dirty = true;
        if (name == null) {
            this.name = null;
        }
        else {
            this.name = name.trim();
        }
        namePrep = null;
    }

    /**
     * Obtain the XMPP host domain for this address.
     *
     * @return the name of the XMPP domain (server host name) or null if undefined.
     */
    public String getHost() {
        return host;
    }

    /**
     * Obtain the XMPP host domain for this address.
     *
     * @return the name of the XMPP domain (server host name) or null if undefined
     */
    public String getHostPrep() {
        if (host != null) {
            if (hostPrep == null) {
                hostPrep = NamePrep.prep(host);
            }
        }
        return hostPrep;
    }

    /**
     * Set the XMPP host domain for this address.
     *
     * @param host the name of the XMPP domain (server host name) or null if undefined.
     */
    public void setHost(String host) {
        dirty = true;
        if (host == null) {
            this.host = null;
        }
        else {
            this.host = host.trim();
        }
        hostPrep = null;
    }

    /**
     * Obtain the resource identified by this address.
     *
     * @return The name of the resource or null if none defined.
     */
    public String getResource() {
        return resource;
    }

    /**
     * Obtain the resource identified by this address.
     *
     * @return The name of the resource or null if none defined.
     */
    public String getResourcePrep() {
        if (resource != null) {
            if (resourcePrep == null) {
                resourcePrep = ResourcePrep.prep(resource);
            }
        }
        return resourcePrep;
    }

    /**
     * Set the resource identified by this address.
     *
     * @param resource the name of the resource or null if none defined.
     */
    public void setResource(String resource) {
        dirty = true;
        if (resource == null) {
            this.resource = null;
        }
        else {
            this.resource = resource.trim();
        }
        resourcePrep = null;
    }

    private synchronized void generateCachedJID() {
        dirty = false;
        StringBuffer buf = new StringBuffer();
        StringBuffer bufprep = new StringBuffer();
        if (name != null && !"".equals(name)) {
            bufprep.append(NodePrep.prep(name));
            bufprep.append('@');
            buf.append(name);
            buf.append('@');
        }
        if (host != null) {
            bufprep.append(NamePrep.prep(host));
            buf.append(host);
        }
        if (resource != null && !"".equals(resource)) {
            cachedBarePrep = bufprep.toString();
            cachedBare = buf.toString();
            buf.append('/');
            buf.append(resource);
            bufprep.append('/');
            bufprep.append(ResourcePrep.prep(resource));
            cached = buf.toString();
            cachedPrep = bufprep.toString();
        }
        else {
            if (buf.length() == 0) {
                cached = Integer.toHexString(hashCode());
                cachedBare = cached;
                cachedPrep = cached;
                cachedBarePrep = cached;
            }
            else {
                cached = buf.toString();
                cachedBare = cached;
                cachedPrep = bufprep.toString();
                cachedBarePrep = cachedPrep;
            }
        }
    }

    /**
     * Obtain an easer to read string for this address.
     *
     * @return The XMPP ID as a URI or a simple "XMPPAddress" string if no URI has been set
     */
    public String toString() {
        if (dirty) {
            generateCachedJID();
        }
        return cached;
    }

    /**
     * Obtain the XMPP ID in normal XMPP format.
     */
    public String toStringPrep() {
        if (dirty) {
            generateCachedJID();
        }
        return cachedPrep;
    }

    /**
     * Obtain the XMPP ID in normal XMPP format excluding any resource information.
     *
     * @return the bare jid as a string (no resource)
     */
    public String toBareString() {
        if (dirty) {
            generateCachedJID();
        }
        return cachedBare;
    }

    /**
     * Obtain the XMPP ID in normal XMPP format excluding any resource information.
     *
     * @return the bare jid processed by stringprep and returned as a string (no resource)
     */
    public String toBareStringPrep() {
        if (dirty) {
            generateCachedJID();
        }
        return cachedBarePrep;
    }

    public int getCachedSize() {
        int size = CacheSizes.sizeOfString(name);
        size += CacheSizes.sizeOfString(host);
        size += CacheSizes.sizeOfString(resource);
        return size;
    }

    public boolean equalsBare(XMPPAddress sender) {
        return equal(getHostPrep(), sender.getHostPrep())
                && equal(getNamePrep(), sender.getNamePrep());
    }

    private boolean equal(String lhs, String rhs) {
        boolean equals = true;
        if (lhs == null) {
            if (rhs != null) {
                equals = false;
            }
        }
        else {
            if (!lhs.equals(rhs)) {
                equals = false;
            }
        }
        return equals;
    }

    public boolean equals(Object address) {
        if (address instanceof XMPPAddress) {
            XMPPAddress addr = (XMPPAddress)address;
            if (equalsBare(addr) && equal(resource, addr.resource)) {
                return true;
            }
        }
        return false;
    }

    public int hashCode() {
        if (dirty) {
            generateCachedJID();
        }
        if (cachedPrep == null) {
            return 0;
        }
        else {
            return cachedPrep.hashCode();
        }
    }
383 384 385 386 387 388 389 390 391

    /**
     * Returns true if all the portions of the addresss are null.
     *
     * @return true if all the portions of the addresss are null.
     */
    public boolean isEmpty() {
        return name == null && host == null && resource == null;
    }
Matt Tucker's avatar
Matt Tucker committed
392
}