Package org.jivesoftware.openfire.nio

Class NIOConnection

    • Field Detail

      • CHARSET

        public static final String CHARSET
        The utf-8 charset for decoding and encoding XMPP packet streams.
        See Also:
        Constant Field Values

    • Method Detail

      • validate

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

      • registerCloseListener

        public void registerCloseListener​(ConnectionCloseListener listener,
                                  Object callback)
        Description copied from interface: Connection
        Registers a listener for close event notification. Registrations after the Session is closed will be immediately notified before the registration call returns (within the context of the registration call). An optional handback object can be associated with the registration if the same listener is registered to listen for multiple connection closures.
        Specified by:
        registerCloseListener in interface Connection
        Parameters:
        listener - the listener to register for events.
        callback - the object to send in the event notification.

      • removeCloseListener

        public void removeCloseListener​(ConnectionCloseListener listener)
        Description copied from interface: Connection
        Removes a registered close event listener. Registered listeners must be able to receive close events up until the time this method returns. (i.e. it is possible to call unregister, receive a close event registration, and then have the unregister call return.)
        Specified by:
        removeCloseListener in interface Connection
        Parameters:
        listener - the listener to deregister for close events.

      • getAddress

        public byte[] getAddress()
                  throws UnknownHostException
        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].
        Specified by:
        getAddress in interface Connection
        Returns:
        the raw IP address of this object.
        Throws:
        UnknownHostException - if IP address of host could not be determined.

      • getHostName

        public String getHostName()
                   throws UnknownHostException
        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.

        Specified by:
        getHostName in interface Connection
        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:
        InetAddress.getCanonicalHostName(), SecurityManager.checkConnect(java.lang.String, int)

      • getLocalCertificates

        public Certificate[] getLocalCertificates()
        Description copied from interface: Connection
        Returns the local underlying X509Certificate chain for the connection.
        Specified by:
        getLocalCertificates in interface 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()
        Description copied from interface: Connection
        Returns the underlying X509Certificate for the connection of the peer.
        Specified by:
        getPeerCertificates in interface Connection
        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)
        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 vcerifying the identify of the remote server.
        Specified by:
        setUsingSelfSignedCertificate in interface Connection
        Parameters:
        isSelfSigned - true if the other peer presented a self-signed certificate.

      • isUsingSelfSignedCertificate

        public boolean isUsingSelfSignedCertificate()
        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 vcerifying the identify of the remote server.
        Specified by:
        isUsingSelfSignedCertificate in interface Connection
        Returns:
        true if the other peer of this session presented a self-signed certificate.

      • getPacketDeliverer

        public PacketDeliverer getPacketDeliverer()
        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, will store the packet offline for later retrieval or will just drop it.
        Specified by:
        getPacketDeliverer in interface Connection
        Returns:
        the packet deliverer to use when delivering a packet over the socket fails.

      • close

        public void close()
        Description copied from interface: Connection
        Close this session including associated socket connection. The order of events for closing the session is:
        • Set closing flag to prevent redundant shutdowns.
        • Call notifyEvent all listeners that the channel is shutting down.
        • Close the socket.
        Note this method overrides the base interface to suppress exceptions. However, it otherwise fulfills the requirements of the Closeable.close() contract (idempotent, try-with-resources, etc.)
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable
        Specified by:
        close in interface Connection

      • systemShutdown

        public void systemShutdown()
        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.
        Specified by:
        systemShutdown in interface Connection

      • init

        public void init​(LocalSession owner)
        Description copied from interface: Connection
        Initializes the connection with it's owning session. Allows the connection class to configure itself with session related information (e.g. stream ID).
        Specified by:
        init in interface Connection
        Parameters:
        owner - the session that owns this connection

      • reinit

        public void reinit​(LocalSession owner)
        Description copied from interface: Connection
        Reinitializes the connection to switch to a different session. This allows for XEP-0198 resumption and transport-switching.
        Specified by:
        reinit in interface Connection
        Parameters:
        owner - The new session now owning the connection.

      • isClosed

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

      • isSecure

        public boolean isSecure()
        Description copied from interface: Connection
        Returns true if this connection is secure.
        Specified by:
        isSecure in interface Connection
        Returns:
        true if the connection is secure (e.g. SSL/TLS)

      • deliver

        public void deliver​(org.xmpp.packet.Packet packet)
             throws UnauthorizedException
        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).
        Specified by:
        deliver in interface Connection
        Parameters:
        packet - the packet to deliver.
        Throws:
        UnauthorizedException - if a permission error was detected.

      • deliverRawText

        public void deliverRawText​(String text)
        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.

        Specified by:
        deliverRawText in interface Connection
        Parameters:
        text - the XML stanzas represented kept in a String.

      • startTLS

        public void startTLS​(boolean clientMode,
                     boolean directTLS)
              throws Exception
        Description copied from interface: Connection
        Secures 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.

        Specified by:
        startTLS in interface Connection
        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:
        Exception - if an error occured while securing the connection.

      • addCompression

        public void addCompression()
        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.
        Specified by:
        addCompression in interface Connection

      • startCompression

        public void startCompression()
        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.
        Specified by:
        startCompression in interface Connection

      • getConfiguration

        public ConnectionConfiguration getConfiguration()
        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.
        Specified by:
        getConfiguration in interface Connection
        Returns:
        The desired configuration for the connection (never null).

      • isFlashClient

        public boolean isFlashClient()
        Description copied from interface: Connection
        Returns true if the connected client is a flash client. Flash clients need to receive a special character (i.e. \0) at the end of each xml packet. Flash clients may send the character \0 in incoming packets and may start a connection using another openning tag such as: "flash:client".
        Specified by:
        isFlashClient in interface Connection
        Returns:
        true if the connected client is a flash client.

      • setFlashClient

        public void setFlashClient​(boolean flashClient)
        Description copied from interface: Connection
        Sets whether the connected client is a flash client. Flash clients need to receive a special character (i.e. \0) at the end of each xml packet. Flash clients may send the character \0 in incoming packets and may start a connection using another openning tag such as: "flash:client".
        Specified by:
        setFlashClient in interface Connection
        Parameters:
        flashClient - true if the if the connection is a flash client.

      • getMajorXMPPVersion

        public int getMajorXMPPVersion()
        Description copied from interface: Connection
        Returns the major version of XMPP being used by this connection (major_version.minor_version. In most cases, the version should be "1.0". However, older clients using the "Jabber" protocol do not set a version. In that case, the version is "0.0".
        Specified by:
        getMajorXMPPVersion in interface Connection
        Returns:
        the major XMPP version being used by this connection.

      • getMinorXMPPVersion

        public int getMinorXMPPVersion()
        Description copied from interface: Connection
        Returns the minor version of XMPP being used by this connection (major_version.minor_version. In most cases, the version should be "1.0". However, older clients using the "Jabber" protocol do not set a version. In that case, the version is "0.0".
        Specified by:
        getMinorXMPPVersion in interface Connection
        Returns:
        the minor XMPP version being used by this connection.

      • setXMPPVersion

        public void setXMPPVersion​(int majorVersion,
                           int minorVersion)
        Description copied from interface: Connection
        Sets the XMPP version information. In most cases, the version should be "1.0". However, older clients using the "Jabber" protocol do not set a version. In that case, the version is "0.0".
        Specified by:
        setXMPPVersion in interface Connection
        Parameters:
        majorVersion - the major version.
        minorVersion - the minor version.

      • isCompressed

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

      • setCompressionPolicy

        public void setCompressionPolicy​(Connection.CompressionPolicy compressionPolicy)
        Description copied from interface: Connection
        Sets whether compression is enabled or is disabled.
        Specified by:
        setCompressionPolicy in interface Connection
        Parameters:
        compressionPolicy - whether Compression is enabled or is disabled.

      • getTlsPolicy

        public Connection.TLSPolicy getTlsPolicy()
        Description copied from interface: Connection
        Returns whether TLS is mandatory, optional or is disabled. When TLS is mandatory clients are required to secure their connections or otherwise their connections will be closed. On the other hand, when TLS is disabled clients are not allowed to secure their connections using TLS. Their connections will be closed if they try to secure the connection. in this last case.
        Specified by:
        getTlsPolicy in interface Connection
        Returns:
        whether TLS is mandatory, optional or is disabled.

      • setTlsPolicy

        public void setTlsPolicy​(Connection.TLSPolicy tlsPolicy)
        Description copied from interface: Connection
        Sets whether TLS is mandatory, optional or is disabled. When TLS is mandatory clients are required to secure their connections or otherwise their connections will be closed. On the other hand, when TLS is disabled clients are not allowed to secure their connections using TLS. Their connections will be closed if they try to secure the connection. in this last case.
        Specified by:
        setTlsPolicy in interface Connection
        Parameters:
        tlsPolicy - whether TLS is mandatory, optional or is disabled.