Package org.jivesoftware.openfire.net

Class SocketConnection

java.lang.Object
org.jivesoftware.openfire.net.AbstractConnection
org.jivesoftware.openfire.net.SocketConnection
All Implemented Interfaces:
Closeable, AutoCloseable, Connection
public class SocketConnection extends AbstractConnection
Deprecated.
Old, pre NIO / MINA code. Should not be used as Netty offers better performance. Currently only in use for server dialback.
An object to track the state of a XMPP client-server session. Currently, this class contains the socket channel connecting the client and server.
Author:
Iain Shigeoka

  • Constructor Details

    • SocketConnection

      public SocketConnection(PacketDeliverer backupDeliverer, Socket socket, boolean isEncrypted) throws IOException
      Deprecated.
      Create a new session using the supplied socket.
      Parameters:
      backupDeliverer - the packet deliverer this connection will use when socket is closed.
      socket - the socket to represent.
      isEncrypted - true if this is a encrypted connection.
      Throws:
      IOException - if there was a socket error while sending the packet.

  • Method Details

    • getInstances

      public static Collection<SocketConnection> getInstances()
      Deprecated.

    • getTLSStreamHandler

      public TLSStreamHandler getTLSStreamHandler()
      Deprecated.
      Returns the stream handler responsible for encrypting the plain connection and providing the corresponding input and output streams.
      Returns:
      the stream handler responsible for encrypting the plain connection and providing the corresponding input and output streams.

    • startTLS

      public void startTLS(boolean clientMode, boolean directTLS) throws IOException
      Deprecated.
      Description copied from interface: Connection
      Encrypts the plain connection by negotiating TLS with the other peer. In a server-2-server connection the server requesting the TLS negotiation will be the client and the other server will be the server during the TLS negotiation. Therefore, the server requesting the TLS negotiation must pass true in the clientMode parameter and the server receiving the TLS request must pass false in the clientMode parameter.

      In the case of client-2-server the XMPP server must pass false in the clientMode parameter since it will behave as the server in the TLS negotiation.

      Parameters:
      clientMode - boolean indicating if this entity is a client or a server in the TLS negotiation.
      directTLS - boolean indicating if the negotiation is directTLS (true) or startTLS (false).
      Throws:
      IOException

    • addCompression

      public void addCompression()
      Deprecated.
      Description copied from interface: Connection
      Adds the compression filter to the connection but only filter incoming traffic. Do not filter outgoing traffic since we still need to send an uncompressed stanza to the client indicating that he can start compressing the traffic. After we sent the uncompresses stanza we can start compression outgoing traffic as well.

    • startCompression

      public void startCompression()
      Deprecated.
      Description copied from interface: Connection
      Start compressing outgoing traffic for this connection. Compression will only be available after TLS has been negotiated. This means that a connection can never be using compression before TLS. However, it is possible to use compression without TLS.

    • getConfiguration

      public ConnectionConfiguration getConfiguration()
      Deprecated.
      Description copied from interface: Connection
      Returns a representation of the desired state for this connection. Note that this is different from the current state of the connection. For example, TLS can be required by configuration, but while the connection has yet to be fully initialized, the current state might not be TLS-encrypted.
      Returns:
      The desired configuration for the connection (never null).

    • validate

      public boolean validate()
      Deprecated.
      Description copied from interface: Connection
      Verifies that the connection is still live. Typically, this is done by sending a whitespace character between packets.
      Returns:
      true if the socket remains valid, false otherwise.

    • isInitialized

      public boolean isInitialized()
      Deprecated.
      Description copied from interface: Connection
      Checks if the connection has finished initialization.
      Returns:
      true if connection has finished initialization.

    • getAddress

      public byte[] getAddress() throws UnknownHostException
      Deprecated.
      Description copied from interface: Connection
      Returns the raw IP address of this InetAddress object. The result is in network byte order: the highest order byte of the address is in getAddress()[0].
      Returns:
      the raw IP address of this object.
      Throws:
      UnknownHostException - if IP address of host could not be determined.

    • getHostAddress

      public String getHostAddress() throws UnknownHostException
      Deprecated.
      Description copied from interface: Connection
      Returns the IP address string in textual presentation.
      Returns:
      the raw IP address in a string format.
      Throws:
      UnknownHostException - if IP address of host could not be determined.

    • getHostName

      public String getHostName() throws UnknownHostException
      Deprecated.
      Description copied from interface: Connection
      Gets the host name for this IP address.

      If this InetAddress was created with a host name, this host name will be remembered and returned; otherwise, a reverse name lookup will be performed and the result will be returned based on the system configured name lookup service. If a lookup of the name service is required, call getCanonicalHostName.

      If there is a security manager, its checkConnect method is first called with the hostname and -1 as its arguments to see if the operation is allowed. If the operation is not allowed, it will return the textual representation of the IP address.

      Returns:
      the host name for this IP address, or if the operation is not allowed by the security check, the textual representation of the IP address.
      Throws:
      UnknownHostException - if IP address of host could not be determined.
      See Also:

    • getPort

      public int getPort()
      Deprecated.
      Returns the port that the connection uses.
      Returns:
      the port that the connection uses.

    • getWriter

      public Writer getWriter()
      Deprecated.
      Returns the Writer used to send data to the connection. The writer should be used with caution. In the majority of cases, the deliver(Packet) method should be used to send data instead of using the writer directly. You must synchronize on the writer before writing data to it to ensure data consistency: 
        Writer writer = connection.getWriter();
 synchronized(writer) {
     // write data....
 }
      Returns:
      the Writer for this connection.

    • isClosed

      public boolean isClosed()
      Deprecated.
      Description copied from interface: Connection
      Returns true if the connection/session is closed.
      Returns:
      true if the connection is closed.

    • isEncrypted

      public boolean isEncrypted()
      Deprecated.
      Description copied from interface: Connection
      Returns true if this connection is encrypted.
      Returns:
      true if the connection is encrypted (e.g. uses TLS)

    • isCompressed

      public boolean isCompressed()
      Deprecated.
      Description copied from interface: Connection
      Returns true if the connection is using compression.
      Returns:
      true if the connection is using compression.

    • getTLSProtocolName

      public Optional<String> getTLSProtocolName()
      Deprecated.
      Description copied from interface: Connection
      Returns the TLS protocol name used by the connection of the session, if any.
      Returns:
      a TLS protocol (version) name.

    • getCipherSuiteName

      public Optional<String> getCipherSuiteName()
      Deprecated.
      Description copied from interface: Connection
      Returns the TLS cipher suite name used by the connection of the session, if any.
      Returns:
      cipher suite name.

    • getIdleTimeout

      public long getIdleTimeout()
      Deprecated.

    • setIdleTimeout

      public void setIdleTimeout(long timeout)
      Deprecated.
      Sets the number of milliseconds a connection has to be idle to be closed. Sending stanzas to the client is not considered as activity. We are only considering the connection active when the client sends some data or hearbeats (i.e. whitespaces) to the server.
      Parameters:
      timeout - the number of milliseconds a connection has to be idle to be closed.

    • getLocalCertificates

      public Certificate[] getLocalCertificates()
      Deprecated.
      Description copied from interface: Connection
      Returns the local underlying X509Certificate chain for the connection.
      Returns:
      an ordered array of certificates, with the local certificate first followed by any certificate authorities. If no certificates is present for the connection, then null is returned.

    • getPeerCertificates

      public Certificate[] getPeerCertificates()
      Deprecated.
      Description copied from interface: Connection
      Returns the underlying X509Certificate for the connection of the peer.
      Returns:
      an ordered array of peer certificates, with the peer's own certificate first followed by any certificate authorities.

    • setUsingSelfSignedCertificate

      public void setUsingSelfSignedCertificate(boolean isSelfSigned)
      Deprecated.
      Description copied from interface: Connection
      Keeps track if the other peer of this session presented a self-signed certificate. When using self-signed certificate for server-2-server sessions then SASL EXTERNAL will not be used and instead server-dialback will be preferred for verifying the identify of the remote server.
      Parameters:
      isSelfSigned - true if the other peer presented a self-signed certificate.

    • isUsingSelfSignedCertificate

      public boolean isUsingSelfSignedCertificate()
      Deprecated.
      Description copied from interface: Connection
      Returns true if the other peer of this session presented a self-signed certificate. When using self-signed certificate for server-2-server sessions then SASL EXTERNAL will not be used and instead server-dialback will be preferred for verifying the identify of the remote server.
      Returns:
      true if the other peer of this session presented a self-signed certificate.

    • getPacketDeliverer

      @Nullable public PacketDeliverer getPacketDeliverer()
      Deprecated.
      Description copied from interface: Connection
      Returns the packet deliverer to use when delivering a packet over the socket fails. The packet deliverer will retry to send the packet using some other connection or will store the packet offline for later retrieval. When null, packets will just be dropped.
      Returns:
      the packet deliverer to use when delivering a packet over the socket fails.

    • close

      public void close(@Nullable org.xmpp.packet.StreamError error, boolean networkInterruption)
      Deprecated.
      Description copied from interface: Connection
      Close this connection including associated session, optionally citing a stream error. The 'networkInterruption' argument should be set to 'true' if the connection is being closed because it is known or assumed that the network connection between Openfire and the peer was unexpectedly terminated (eg: due to a networking failure). These typically are scenarios where a peer becomes unresponsive (without having terminated its session with a </stream:stream> or comparable message). When the 'networkInterruption' argument is set to 'true', then a session is eligible for resumption (if Stream Management was activiated for the session). The events for closing the connection are:
      • Set closing flag to prevent redundant shutdowns.
      • Close the socket.
      • Notify all listeners that the channel is shut down.
      Not all implementations use the same order of events.
      Parameters:
      error - If non-null, the end-stream tag will be preceded with this error.

    • systemShutdown

      public void systemShutdown()
      Deprecated.
      Description copied from interface: Connection
      Notification message indicating that the server is being shutdown. Implementors should send a stream error whose condition is system-shutdown before closing the connection.

    • deliver

      public void deliver(org.xmpp.packet.Packet packet) throws UnauthorizedException, PacketException
      Deprecated.
      Description copied from interface: Connection
      Delivers the packet to this connection without checking the recipient. The method essentially calls socket.send(packet.getWriteBuffer()). Use with caution! This code is unlikely to be called directly. Instead, ensure that data sent to the entities is sent through the appropriate LocalSession object. For clients, this prevents, for example, synchronisation issues with stanza counts related to Stream Management (XEP-0198).
      Parameters:
      packet - the packet to deliver.
      Throws:
      UnauthorizedException - if a permission error was detected.
      PacketException

    • deliverRawText

      public void deliverRawText(String text)
      Deprecated.
      Description copied from interface: Connection
      Delivers raw text to this connection. This is a very low level way for sending XML stanzas to the client. This method should not be used unless you have very good reasons for not using Connection.deliver(org.xmpp.packet.Packet).

      This method avoids having to get the writer of this connection and mess directly with the writer. Therefore, this method ensures a correct delivery of the stanza even if other threads were sending data concurrently.

      Parameters:
      text - the XML stanzas represented kept in a String.

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object

    • setSocketReader

      public void setSocketReader(SocketReader socketReader)
      Deprecated.