path: root/protocols/bundles/org.jivesoftware.smack/src/org/jivesoftware/smackx/packet/JingleTransport.java

package org.jivesoftware.smackx.packet;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.jivesoftware.smack.packet.PacketExtension;
import org.jivesoftware.smackx.nat.TransportCandidate;

/**
 * A jingle transport extension
 * 
 * @author Alvaro Saurin <alvaro.saurin@gmail.com>
 */
public class JingleTransport implements PacketExtension {

	// static

	public static final String NODENAME = "transport";

	// non-static

	protected String namespace;

	protected final List candidates = new ArrayList();

	/**
	 * Default constructor.
	 */
	public JingleTransport() {
		super();
	}
	
	/**
	 * Utility constructor, with a transport candidate element.
	 * 
	 * @param candidate A transport candidate element to add.
	 */
	public JingleTransport(final JingleTransportCandidate candidate) {
		super();
		addCandidate(candidate);
	}

	/**
	 * Copy constructor.
	 * 
	 * @param tr the other jingle transport.
	 */
	public JingleTransport(final JingleTransport tr) {
		if (tr != null) {
			namespace = tr.namespace;

			if (tr.candidates.size() > 0) {
				candidates.addAll(tr.candidates);
			}
		}
	}

	/**
	 * Adds a transport candidate.
	 * 
	 * @param candidate the candidate
	 */
	public void addCandidate(final JingleTransportCandidate candidate) {
		if (candidate != null) {
			synchronized (candidates) {
				candidates.add(candidate);
			}
		}
	}

	/**
	 * Get an iterator for the candidates
	 * 
	 * @return an iterator
	 */
	public Iterator getCandidates() {
		return Collections.unmodifiableList(getCandidatesList()).iterator();
	}

	/**
	 * Get the list of candidates.
	 * 
	 * @return The candidates list.
	 */
	public ArrayList getCandidatesList() {
		ArrayList res = null;
		synchronized (candidates) {
			res = new ArrayList(candidates);
		}
		return res;
	}

	/**
	 * Get the number of transport candidates.
	 * 
	 * @return The number of transport candidates contained.
	 */
	public int getCandidatesCount() {
		return getCandidatesList().size();
	}

	/**
	 * Returns the XML element name of the element.
	 * 
	 * @return the XML element name of the element.
	 */
	public String getElementName() {
		return NODENAME;
	}

	/**
	 * Set the namespace.
	 * 
	 * @param ns The namespace
	 */
	protected void setNamespace(final String ns) {
		namespace = ns;
	}

	/**
	 * Get the namespace.
	 * 
	 * @return The namespace
	 */
	public String getNamespace() {
		return namespace;
	}

	/**
	 * Return the XML representation for this element.
	 */
	public String toXML() {
		StringBuffer buf = new StringBuffer();

		buf.append("<").append(getElementName()).append(" xmlns=\"");
		buf.append(getNamespace()).append("\" ");

		synchronized (candidates) {
			if (getCandidatesCount() > 0) {
				buf.append(">");
				Iterator iter = getCandidates();
				while (iter.hasNext()) {
					JingleTransportCandidate candidate = (JingleTransportCandidate) iter
							.next();
					buf.append(candidate.toXML());
				}
				buf.append("</").append(getElementName()).append(">");
			} else {
				buf.append("/>");
			}
		}

		return buf.toString();
	}

	/**
	 * Candidate element in the transport. This class acts as a view of the
	 * "TransportCandidate" in the Jingle space.
	 * 
	 * @see TransportCandidate
	 * @author Alvaro Saurin
	 */
	public static abstract class JingleTransportCandidate {

		public static final String NODENAME = "candidate";

		// The transport candidate contained in the element.
		protected TransportCandidate transportCandidate;

		/**
		 * Creates a new JingleTransport child.
		 */
		public JingleTransportCandidate() {
			super();
		}

		/**
		 * Creates a new JingleTransport child.
		 * 
		 * @param candidate the media transport candidate
		 */
		public JingleTransportCandidate(final TransportCandidate candidate) {
			super();
			setMediaTransport(candidate);
		}

		/**
		 * Returns the XML element name of the element.
		 * 
		 * @return the XML element name of the element.
		 */
		public static String getElementName() {
			return NODENAME;
		}

		/**
		 * Get the current transportElement candidate.
		 * 
		 * @return the transportElement candidate
		 */
		public TransportCandidate getMediaTransport() {
			return transportCandidate;
		}

		/**
		 * Set the transportElement candidate.
		 * 
		 * @param cand the transportElement candidate
		 */
		public void setMediaTransport(final TransportCandidate cand) {
			if (cand != null) {
				transportCandidate = cand;
			}
		}

		/**
		 * Get the list of attributes.
		 * 
		 * @return a string with the list of attributes.
		 */
		protected String getChildElements() {
			return null;
		}

		/**
		 * Obtain a valid XML representation of a trancport candidate
		 * 
		 * @return A string containing the XML dump of the transport candidate.
		 */
		public String toXML() {
			StringBuffer buf = new StringBuffer();
			String childElements = getChildElements();

			if (transportCandidate != null && childElements != null) {
				buf.append("<").append(getElementName()).append(" ");
				buf.append(childElements);
				buf.append("/>");
			}

			return buf.toString();
		}
	}

	// Subclasses

	/**
	 * RTP-ICE profile
	 */
	public static class Ice extends JingleTransport {
		public static final String NAMESPACE = "http://jabber.org/protocol/jingle/transport/ice";

		public Ice() {
			super();
			setNamespace(NAMESPACE);
		}

		public static class Candidate extends JingleTransportCandidate {
			/**
			 * Default constructor
			 */
			public Candidate() {
				super();
			}

			/**
			 * Constructor with a transport candidate.
			 */
			public Candidate(final TransportCandidate tc) {
				super(tc);
			}

			/**
			 * Get the elements of this candidate.
			 */
			protected String getChildElements() {
				StringBuffer buf = new StringBuffer();

				if (transportCandidate != null && transportCandidate instanceof TransportCandidate.Ice) {
					TransportCandidate.Ice tci = (TransportCandidate.Ice) transportCandidate;

					// We convert the transportElement candidate to XML here...
					buf.append(" generation=\"").append(tci.getGeneration()).append("\"");
					buf.append(" ip=\"").append(tci.getIP()).append("\"");
					buf.append(" port=\"").append(tci.getPort()).append("\"");
					buf.append(" network=\"").append(tci.getNetwork()).append("\"");
					buf.append(" username=\"").append(tci.getUsername()).append("\"");
					buf.append(" password=\"").append(tci.getPassword()).append("\"");
					buf.append(" preference=\"").append(tci.getPreference()).append("\"");

					// Optional elements
					if (transportCandidate.getName() != null) {
						buf.append(" name=\"").append(tci.getName()).append("\"");
					}
				}

				return buf.toString();
			}

		}
	}

	/**
	 * Raw UDP profile.
	 */
	public static class RawUdp extends JingleTransport {
		public static final String NAMESPACE = "http://jabber.org/protocol/jingle/transport/raw-udp";

		public RawUdp() {
			super();
			setNamespace(NAMESPACE);
		}

		/**
		 * Add a transport candidate
		 * 
		 * @see org.jivesoftware.smackx.packet.JingleTransport#addCandidate(org.jivesoftware.smackx.packet.JingleTransport.JingleTransportCandidate)
		 */
		public void addCandidate(final JingleTransportCandidate candidate) {
			candidates.clear();
			super.addCandidate(candidate);
		}

		/**
		 * Get the list of candidates. As a "raw-udp" transport can only contain
		 * one candidate, we use the first in the list...
		 * 
		 * @see org.jivesoftware.smackx.packet.JingleTransport#getCandidates()
		 */
		public ArrayList getCandidatesList() {
			ArrayList copy = new ArrayList();
			ArrayList superCandidatesList = super.getCandidatesList();
			
			if(superCandidatesList.size() > 0) {
				copy.add(superCandidatesList.get(0));				
			}
			
			return copy;
		}

		/**
		 * Raw-udp transport candidate.
		 */
		public static class Candidate extends JingleTransportCandidate {
			/**
			 * Default constructor
			 */
			public Candidate() {
				super();
			}

			/**
			 * Constructor with a transport candidate.
			 */
			public Candidate(final TransportCandidate tc) {
				super(tc);
			}

			/**
			 * Get the elements of this candidate.
			 */
			protected String getChildElements() {
				StringBuffer buf = new StringBuffer();

				if (transportCandidate != null && transportCandidate instanceof TransportCandidate.Fixed) {
					TransportCandidate.Fixed tcf = (TransportCandidate.Fixed) transportCandidate;

					buf.append(" generation=\"").append(tcf.getGeneration()).append("\"");
					buf.append(" ip=\"").append(tcf.getIP()).append("\"");
					buf.append(" port=\"").append(tcf.getPort()).append("\"");
					
					// Optional parameters
					String name = tcf.getName();
					if(name != null) {
						buf.append(" name=\"").append(name).append("\"");
					}
				}
				return buf.toString();
			}

		}
	}
}