org.soxmpp.server.xmpp.net.NIOConnection.java Source code

Java tutorial

Introduction

Here is the source code for org.soxmpp.server.xmpp.net.NIOConnection.java

Source

/*
 * Copyright (C) 2010 Moduad Co., Ltd.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
package org.soxmpp.server.xmpp.net;

import java.net.InetSocketAddress;
import java.net.UnknownHostException;
import java.nio.charset.Charset;
import java.nio.charset.CharsetEncoder;
import java.nio.charset.CodingErrorAction;
import java.security.KeyStore;

import javax.net.ssl.KeyManager;
import javax.net.ssl.SSLContext;
import javax.net.ssl.TrustManager;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.mina.core.buffer.IoBuffer;
import org.apache.mina.core.session.IoSession;
import org.apache.mina.filter.ssl.SslFilter;
import org.dom4j.io.OutputFormat;
import org.jivesoftware.util.XMLWriter;
import org.soxmpp.server.util.Config;
import org.soxmpp.server.xmpp.session.LocalSession;
import org.soxmpp.server.xmpp.session.Session;
import org.soxmpp.server.xmpp.ssl.SSLConfig;
import org.soxmpp.server.xmpp.ssl.SSLKeyManagerFactory;
import org.soxmpp.server.xmpp.ssl.SSLTrustManagerFactory;
import org.xmpp.packet.Packet;

/**
 * This class represents a XMPP connection on the server.
 * 
 * @author Sehwan Noh (devnoh@gmail.com)
 */
public class NIOConnection implements Connection {

    private static final Log log = LogFactory.getLog(Connection.class);

    /**
     * The utf-8 charset for decoding and encoding XMPP packet streams.
     */
    public static final String CHARSET = "UTF-8";

    private LocalSession session;
    private IoSession ioSession;

    private ConnectionCloseListener closeListener;

    /**
     * Deliverer to use when the connection is closed or was closed when
     * delivering a packet.
     */
    private int majorVersion = 1;
    private int minorVersion = 0;
    private String language = null;

    // TODO Uso el #checkHealth????
    /**
     * TLS policy currently in use for this connection.
     */
    private TLSPolicy tlsPolicy = TLSPolicy.optional;
    private static ThreadLocal<CharsetEncoder> encoder = new ThreadLocalEncoder();
    /**
     * Flag that specifies if the connection should be considered closed.
     * Closing a NIO connection is an asynch operation so instead of waiting for
     * the connection to be actually closed just keep this flag to avoid using
     * the connection between #close was used and the socket is actually closed.
     */
    private boolean closed;

    public NIOConnection(IoSession session) {
        this.ioSession = session;
        closed = false;
    }

    /**
     * Verifies that the connection is still live.
     * 
     * @return true if the socket remains valid, false otherwise.
     */
    public boolean validate() {
        if (isClosed()) {
            return false;
        }
        deliverRawText(" ");
        return !isClosed();
    }

    /**
     * Registers a listener for close event notification.
     * 
     * @param listener
     *            the listener to register for close events.
     */
    public void registerCloseListener(ConnectionCloseListener listener) {
        if (closeListener != null) {
            throw new IllegalStateException("Close listener already configured");
        }
        if (isClosed()) {
            listener.onConnectionClose(session);
        } else {
            closeListener = listener;
        }
    }

    /**
     * Removes a registered close event listener.
     * 
     * @param listener
     *            the listener to unregister for close events.
     */
    public void removeCloseListener(ConnectionCloseListener listener) {
        if (closeListener == listener) {
            closeListener = null;
        }
    }

    public byte[] getAddress() throws UnknownHostException {
        return ((InetSocketAddress) ioSession.getRemoteAddress()).getAddress().getAddress();
    }

    public String getHostAddress() throws UnknownHostException {
        return ((InetSocketAddress) ioSession.getRemoteAddress()).getAddress().getHostAddress();
    }

    public String getHostName() throws UnknownHostException {
        return ((InetSocketAddress) ioSession.getRemoteAddress()).getAddress().getHostName();
    }

    /**
     * Closes the session including associated socket connection, notifing all
     * listeners that the channel is shutting down.
     */
    public void close() {
        boolean closedSuccessfully = false;
        synchronized (this) {
            if (!isClosed()) {
                try {
                    deliverRawText("</stream:stream>", false);
                } catch (Exception e) {
                    // Ignore
                }
                if (session != null) {
                    session.setStatus(Session.STATUS_CLOSED);
                }
                ioSession.close(false);
                closed = true;
                closedSuccessfully = true;
            }
        }
        if (closedSuccessfully) {
            notifyCloseListeners();
        }
    }

    /**
     * Sends notification message indicating that the server is being shutdown.
     */
    public void systemShutdown() {
        deliverRawText(
                "<stream:error><system-shutdown " + "xmlns='urn:ietf:params:xml:ns:xmpp-streams'/></stream:error>");
        close();
    }

    /**
     * Notifies all close listeners that the connection has been closed. Used by
     * subclasses to properly finish closing the connection.
     */
    private void notifyCloseListeners() {
        if (closeListener != null) {
            try {
                closeListener.onConnectionClose(session);
            } catch (Exception e) {
                log.error("Error notifying listener: " + closeListener, e);
            }
        }
    }

    /**
     * Initializes the connection with it's owning session.
     * 
     * @param session
     *            the session that owns this connection
     */
    public void init(LocalSession owner) {
        session = owner;
    }

    /**
     * Returns true if the connection is closed.
     * 
     * @return true if the connection is closed, false otherwise.
     */
    public synchronized boolean isClosed() {
        return closed;
    }

    /**
     * Returns true if this connection is secure.
     * 
     * @return true if the connection is secure
     */
    public boolean isSecure() {
        return ioSession.getFilterChain().contains("tls");
    }

    /**
     * Delivers the packet to this connection (without checking the recipient).
     * 
     * @param packet
     *            the packet to deliver
     */
    public void deliver(Packet packet) {
        log.info("SENT: " + packet.toXML());
        if (!isClosed()) {
            IoBuffer buffer = IoBuffer.allocate(4096);
            buffer.setAutoExpand(true);

            boolean errorDelivering = false;
            try {
                XMLWriter xmlSerializer = new XMLWriter(new IoBufferWriter(buffer, (CharsetEncoder) encoder.get()),
                        new OutputFormat());
                xmlSerializer.write(packet.getElement());
                xmlSerializer.flush();
                buffer.flip();
                ioSession.write(buffer);
            } catch (Exception e) {
                log.debug("Connection: Error delivering packet" + "\n" + this.toString(), e);
                errorDelivering = true;
            }
            if (errorDelivering) {
                close();
            } else {
                session.incrementServerPacketCount();
            }
        }
    }

    /**
     * Delivers raw text to this connection (in asynchronous mode).
     * 
     * @param text
     *            the XML stanza string to deliver
     */
    public void deliverRawText(String text) {
        deliverRawText(text, true);
    }

    private void deliverRawText(String text, boolean asynchronous) {
        log.info("SENT: " + text);
        if (!isClosed()) {
            IoBuffer buffer = IoBuffer.allocate(text.length());
            buffer.setAutoExpand(true);

            boolean errorDelivering = false;
            try {
                buffer.put(text.getBytes("UTF-8"));
                buffer.flip();
                if (asynchronous) {
                    ioSession.write(buffer);
                } else {
                    // Send stanza and wait for ACK
                    boolean ok = ioSession.write(buffer)
                            .awaitUninterruptibly(Config.getInt("connection.ack.timeout", 2000));
                    if (!ok) {
                        log.warn("No ACK was received when sending stanza to: " + this.toString());
                    }
                }
            } catch (Exception e) {
                log.debug("Connection: Error delivering raw text" + "\n" + this.toString(), e);
                errorDelivering = true;
            }
            // Close the connection if delivering text fails
            if (errorDelivering && asynchronous) {
                close();
            }
        }
    }

    public void startTLS(ClientAuth authentication) throws Exception {
        log.debug("startTLS()...");
        KeyStore ksKeys = SSLConfig.getKeyStore();
        String keypass = SSLConfig.getKeyPassword();
        KeyStore ksTrust = SSLConfig.getc2sTrustStore();
        String trustpass = SSLConfig.getc2sTrustPassword();

        KeyManager[] km = SSLKeyManagerFactory.getKeyManagers(ksKeys, keypass);
        TrustManager[] tm = SSLTrustManagerFactory.getTrustManagers(ksTrust, trustpass);

        SSLContext tlsContext = SSLContext.getInstance("TLS");
        tlsContext.init(km, tm, null);

        SslFilter filter = new SslFilter(tlsContext);
        ioSession.getFilterChain().addFirst("tls", filter);
        // ioSession.getFilterChain().addBefore("executor", "tls", filter);
        ioSession.setAttribute(SslFilter.DISABLE_ENCRYPTION_ONCE, Boolean.TRUE);

        deliverRawText("<proceed xmlns=\"urn:ietf:params:xml:ns:xmpp-tls\"/>");
    }

    /**
     * Returns the major version of XMPP being used by this connection.
     * 
     * @return the major XMPP version
     */
    public int getMajorXMPPVersion() {
        return majorVersion;
    }

    /**
     * Returns the minor version of XMPP being used by this connection.
     * 
     * @return the minor XMPP version
     */
    public int getMinorXMPPVersion() {
        return minorVersion;
    }

    /**
     * Sets the XMPP version information.
     * 
     * @param majorVersion
     *            the major version
     * @param minorVersion
     *            the minor version
     */
    public void setXMPPVersion(int majorVersion, int minorVersion) {
        this.majorVersion = majorVersion;
        this.minorVersion = minorVersion;
    }

    /**
     * Returns the language code that should be used for this connection.
     * 
     * @return the language code
     */
    public String getLanguage() {
        return language;
    }

    /**
     * Sets the language code that should be used for this connection.
     * 
     * @param language
     *            the language code
     */
    public void setLanaguage(String language) {
        this.language = language;
    }

    public TLSPolicy getTlsPolicy() {
        return tlsPolicy;
    }

    public void setTlsPolicy(TLSPolicy tlsPolicy) {
        this.tlsPolicy = tlsPolicy;
    }

    @Override
    public String toString() {
        return super.toString() + " MINA Session: " + ioSession;
    }

    private static class ThreadLocalEncoder extends ThreadLocal<CharsetEncoder> {

        @Override
        protected CharsetEncoder initialValue() {
            return Charset.forName(CHARSET).newEncoder().onMalformedInput(CodingErrorAction.REPORT)
                    .onUnmappableCharacter(CodingErrorAction.REPORT);
        }
    }

}