/** * $RCSfile: ICECandidate.java,v $ * $Revision: 1.2 $ * $Date: 2007/07/03 16:36:31 $ * * Copyright (C) 2002-2006 Jive Software. All rights reserved. * ==================================================================== * The Jive Software License (based on Apache Software License, Version 1.1) * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by * Jive Software (http://www.jivesoftware.com)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Smack" and "Jive Software" must not be used to * endorse or promote products derived from this software without * prior written permission. For written permission, please * contact webmaster@jivesoftware.com. * * 5. Products derived from this software may not be called "Smack", * nor may "Smack" appear in their name, without prior written * permission of Jive Software. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== */ package org.jivesoftware.smackx.jingle.nat; import java.net.InetAddress; import java.net.UnknownHostException; import java.util.List; import org.jivesoftware.smackx.jingle.SmackLogger; /** * ICE Transport candidate. *
* A candidate represents the possible transport for data interchange between * the two endpoints. * * @author Thiago Camargo */ public class ICECandidate extends TransportCandidate implements Comparable { private static final SmackLogger LOGGER = SmackLogger.getLogger(ICECandidate.class); private String id; // An identification private String username; private int preference; private Protocol proto; private Channel channel; private int network; private Type type; public enum Type { relay, srflx, prflx, local, host } public ICECandidate() { super(); } /** * Constructor with the basic elements of a transport definition. * * @param ip the IP address to use as a local address * @param generation used to keep track of the candidates * @param network used for diagnostics (used when the machine has * several NICs) * @param password user name, as it is used in ICE * @param port the port at the candidate IP address * @param username user name, as it is used in ICE * @param preference preference for this transportElement, as it is used * in ICE * @param type type as defined in ICE-12 */ public ICECandidate(String ip, int generation, int network, String password, int port, String username, int preference, Type type) { super(ip, port, generation); proto = Protocol.UDP; channel = Channel.MYRTPVOICE; this.network = network; this.password = password; this.username = username; this.preference = preference; this.type = type; } /** * Get the ID * * @return the id */ public String getId() { return id; } /** * Set the ID * * @param id the id to set */ public void setId(String id) { this.id = id; } /** * Get the protocol used for the transmission * * @return the protocol used for transmission */ public Protocol getProto() { return proto; } /** * Set the protocol for the transmission * * @param proto the protocol to use */ public void setProto(Protocol proto) { this.proto = proto; } /** * Get the network interface used for this connection * * @return the interface number */ public int getNetwork() { return network; } /** * Set the interface for this connection * * @param network the interface number */ public void setNetwork(int network) { this.network = network; } /** * Get the username for this transportElement in ICE * * @return a username string */ public String getUsername() { return username; } /** * Get the channel * * @return the channel associated */ public Channel getChannel() { return channel; } /** * Set the channel for this transportElement * * @param channel the new channel */ public void setChannel(Channel channel) { this.channel = channel; } /** * Set the username for this transportElement in ICE * * @param username the username used in ICE */ public void setUsername(String username) { this.username = username; } /** * Get the preference number for this transportElement * * @return the preference for this transportElement */ public int getPreference() { return preference; } /** * Set the preference order for this transportElement * * @param preference a number identifying the preference (as defined in * ICE) */ public void setPreference(int preference) { this.preference = preference; } /** * Get the Candidate Type * * @return candidate Type */ public Type getType() { return type; } /** * Set the Candidate Type * * @param type candidate type. */ public void setType(Type type) { this.type = type; } /** * Check if a transport candidate is usable. The transport resolver should * check if the transport candidate the other endpoint has provided is * usable. * * ICE Candidate can check connectivity using UDP echo Test. */ public void check(final List