Package org.jivesoftware.smackx.jingleold.nat

Class TransportCandidate

java.lang.Object
org.jivesoftware.smackx.jingleold.nat.TransportCandidate
Direct Known Subclasses:
ICECandidate, TransportCandidate.Fixed
public abstract class TransportCandidate extends Object
Transport candidate. A candidate represents the possible transport for data interchange between the two endpoints.

  • Field Details

  • Constructor Details

    • TransportCandidate

      public TransportCandidate()
      Empty constructor.

    • TransportCandidate

      public TransportCandidate(String ip, int port)
      Constructor with IP address and port.
      Parameters:
      ip - The IP address.
      port - The port number.

    • TransportCandidate

      public TransportCandidate(String ip, int port, int generation)
      Constructor with IP address and port.
      Parameters:
      ip - The IP address.
      port - The port number.
      generation - The generation

  • Method Details

    • addCandidateEcho

      public void addCandidateEcho(JingleSession session) throws SocketException, UnknownHostException
      Throws:
      SocketException
      UnknownHostException

    • removeCandidateEcho

      public void removeCandidateEcho()

    • getCandidateEcho

      public TransportCandidate.CandidateEcho getCandidateEcho()

    • getIp

      public String getIp()

    • setIp

      public void setIp(String ip)
      Set the IP address.
      Parameters:
      ip - the IP address

    • getLocalIp

      public String getLocalIp()
      Get local IP to bind to this candidate.
      Returns:
      the local IP

    • setLocalIp

      public void setLocalIp(String localIp)
      Set local IP to bind to this candidate.
      Parameters:
      localIp - TODO javadoc me please

    • getSymmetric

      public TransportCandidate getSymmetric()
      Get the symmetric candidate for this candidate if it exists.
      Returns:
      the symmetric candidate

    • setSymmetric

      public void setSymmetric(TransportCandidate symmetric)
      Set the symmetric candidate for this candidate.
      Parameters:
      symmetric - TODO javadoc me please

    • getPassword

      public String getPassword()
      Get the password used by ICE or relayed candidate.
      Returns:
      a password

    • setPassword

      public void setPassword(String password)
      Set the password used by ICE or relayed candidate.
      Parameters:
      password - a password

    • getConnection

      public XMPPConnection getConnection()
      Get the XMPPConnection use to send or receive this candidate.
      Returns:
      the connection

    • setConnection

      public void setConnection(XMPPConnection connection)
      Set the XMPPConnection use to send or receive this candidate.
      Parameters:
      connection - TODO javadoc me please

    • getSessionId

      public String getSessionId()
      Get the jingle's sessionId that is using this candidate.
      Returns:
      the session ID

    • setSessionId

      public void setSessionId(String sessionId)
      Set the jingle's sessionId that is using this candidate.
      Parameters:
      sessionId - TODO javadoc me please

    • isNull

      public boolean isNull()
      Return true if the candidate is not valid.
      Returns:
      true if the candidate is null.

    • getPort

      public int getPort()
      Get the port, or 0 for any port.
      Returns:
      the port or 0

    • setPort

      public void setPort(int port)
      Set the port, using 0 for any port.
      Parameters:
      port - the port

    • getGeneration

      public int getGeneration()
      Get the generation for a transportElement definition.
      Returns:
      the generation

    • setGeneration

      public void setGeneration(int generation)
      Set the generation for a transportElement definition.
      Parameters:
      generation - the generation number

    • getName

      public String getName()
      Get the name used for identifying this transportElement method (optional).
      Returns:
      a name used for identifying this transportElement (ie, "myrtpvoice1")

    • setName

      public void setName(String name)
      Set a name for identifying this transportElement.
      Parameters:
      name - the name used for the transportElement

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • check

      public void check(List<TransportCandidate> localCandidates)
      Check if a transport candidate is usable. The transport resolver should check if the transport candidate the other endpoint has provided is usable. Subclasses should provide better methods if they can...
      Parameters:
      localCandidates - a list of local candidates.

    • getListenersList

      public List<TransportResolverListener.Checker> getListenersList()
      Get the list of listeners.
      Returns:
      the list of listeners

    • addListener

      public void addListener(TransportResolverListener.Checker li)
      Add a transport resolver listener.
      Parameters:
      li - The transport resolver listener to be added.