ClientSessionConnection.java 7.52 KB
Newer Older
Gaston Dombiak's avatar
Gaston Dombiak committed
1 2 3 4 5
/**
 * $RCSfile: $
 * $Revision: $
 * $Date: $
 *
6
 * Copyright (C) 2005-2008 Jive Software. All rights reserved.
Gaston Dombiak's avatar
Gaston Dombiak committed
7 8
 *
 * This software is published under the terms of the GNU Public License (GPL),
9 10
 * a copy of which is included in this distribution, or a commercial license
 * agreement with Jive.
Gaston Dombiak's avatar
Gaston Dombiak committed
11 12
 */

13
package org.jivesoftware.openfire.multiplex;
Gaston Dombiak's avatar
Gaston Dombiak committed
14 15

import org.dom4j.Element;
16 17 18
import org.jivesoftware.openfire.XMPPServer;
import org.jivesoftware.openfire.net.VirtualConnection;
import org.jivesoftware.openfire.session.ConnectionMultiplexerSession;
Gaston Dombiak's avatar
Gaston Dombiak committed
19 20 21
import org.xmpp.packet.IQ;
import org.xmpp.packet.Packet;

22
import java.net.InetAddress;
23
import java.net.UnknownHostException;
Gaston Dombiak's avatar
Gaston Dombiak committed
24 25 26 27

/**
 * Represents a connection of a Client Session that was established to a Connection Manager.
 * Connection Managers have their own physical connections to the server that are multiplexed
28
 * among connected clients. Each created {@link org.jivesoftware.openfire.session.ClientSession}
29
 * will use an instance of this class as its connection.
Gaston Dombiak's avatar
Gaston Dombiak committed
30 31 32 33 34 35 36 37
 *
 * @author Gaston Dombiak
 */
public class ClientSessionConnection extends VirtualConnection {

    private String connectionManagerName;
    private String serverName;
    private ConnectionMultiplexerManager multiplexerManager;
38 39
    private String hostName;
    private String hostAddress;
Gaston Dombiak's avatar
Gaston Dombiak committed
40

41
    public ClientSessionConnection(String connectionManagerName, String hostName, String hostAddress) {
Gaston Dombiak's avatar
Gaston Dombiak committed
42 43
        this.connectionManagerName = connectionManagerName;
        multiplexerManager = ConnectionMultiplexerManager.getInstance();
44
        serverName = XMPPServer.getInstance().getServerInfo().getXMPPDomain();
45 46
        this.hostName = hostName;
        this.hostAddress = hostAddress;
Gaston Dombiak's avatar
Gaston Dombiak committed
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
    }

    /**
     * Delivers the packet to the Connection Manager that in turn will forward it to the
     * target user. Connection Managers may have one or many connections to the server so
     * just get any connection to the Connection Manager (uses a random) and use it.<p>
     *
     * If the packet to send does not have a TO attribute then wrap the packet with a
     * special IQ packet. The wrapper IQ packet will be sent to the Connection Manager
     * and the stream ID of this Client Session will be used for identifying that the wrapped
     * packet must be sent to the connected user. Since some packets can be exchanged before
     * the user has a binded JID we need to use the stream ID as the unique identifier.
     *
     * @param packet the packet to send to the user.
     */
    public void deliver(Packet packet) {
        ConnectionMultiplexerSession multiplexerSession =
                multiplexerManager.getMultiplexerSession(connectionManagerName);
        if (multiplexerSession != null) {
66 67 68 69 70 71
            // Wrap packet so that the connection manager can figure out the target session
            Route wrapper = new Route(session.getStreamID().getID());
            wrapper.setFrom(serverName);
            wrapper.setTo(connectionManagerName);
            wrapper.setChildElement(packet.getElement().createCopy());
            // Deliver wrapper
72
            multiplexerSession.process(wrapper);
Gaston Dombiak's avatar
Gaston Dombiak committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
            session.incrementServerPacketCount();
        }
    }

    /**
     * Delivers the stanza to the Connection Manager that in turn will forward it to the
     * target user. Connection Managers may have one or many connections to the server so
     * just get any connection to the Connection Manager (uses a random) and use it.<p>
     *
     * The stanza to send wrapped with a special IQ packet. The wrapper IQ packet will be
     * sent to the Connection Manager and the stream ID of this Client Session will be used
     * for identifying that the wrapped stanza must be sent to the connected user.
     *
     * @param text the stanza to send to the user.
     */
    public void deliverRawText(String text) {
        ConnectionMultiplexerSession multiplexerSession =
                multiplexerManager.getMultiplexerSession(connectionManagerName);
        if (multiplexerSession != null) {
            // Wrap packet so that the connection manager can figure out the target session
            StringBuilder sb = new StringBuilder(200 + text.length());
94
            sb.append("<route from=\"").append(serverName);
Gaston Dombiak's avatar
Gaston Dombiak committed
95
            sb.append("\" to=\"").append(connectionManagerName);
96
            sb.append("\" streamid=\"").append(session.getStreamID().getID()).append("\">");
Gaston Dombiak's avatar
Gaston Dombiak committed
97
            sb.append(text);
98
            sb.append("</route>");
Gaston Dombiak's avatar
Gaston Dombiak committed
99
            // Deliver the wrapped stanza
100
            multiplexerSession.deliverRawText(sb.toString());
Gaston Dombiak's avatar
Gaston Dombiak committed
101 102 103
        }
    }

104
    public byte[] getAddress() throws UnknownHostException {
105 106 107
        if (hostAddress != null) {
            return InetAddress.getByName(hostAddress).getAddress();
        }
108 109 110 111
        return null;
    }

    public String getHostAddress() throws UnknownHostException {
112 113 114
        if (hostAddress != null) {
            return hostAddress;
        }
115 116 117 118 119 120 121 122 123 124
        // Return IP address of the connection manager that the client used to log in
        ConnectionMultiplexerSession multiplexerSession =
                multiplexerManager.getMultiplexerSession(connectionManagerName);
        if (multiplexerSession != null) {
            return multiplexerSession.getHostAddress();
        }
        return null;
    }

    public String getHostName() throws UnknownHostException {
125 126 127
        if (hostName != null) {
            return hostName;
        }
Gaston Dombiak's avatar
Gaston Dombiak committed
128 129 130 131
        // Return IP address of the connection manager that the client used to log in
        ConnectionMultiplexerSession multiplexerSession =
                multiplexerManager.getMultiplexerSession(connectionManagerName);
        if (multiplexerSession != null) {
132
            return multiplexerSession.getHostName();
Gaston Dombiak's avatar
Gaston Dombiak committed
133 134 135 136
        }
        return null;
    }

137 138 139 140 141 142
    public void systemShutdown() {
        // Do nothing since a system-shutdown error will be sent to the Connection Manager
        // that in turn will send a system-shutdown to connected clients. This is an
        // optimization to reduce number of packets being sent from the server.
    }

Gaston Dombiak's avatar
Gaston Dombiak committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156
    /**
     * If the Connection Manager or the Client requested to close the connection then just do
     * nothing. But if the server originated the request to close the connection then we need
     * to send to the Connection Manager a packet letting him know that the Client Session needs
     * to be terminated.
     */
    public void closeVirtualConnection() {
        // Figure out who requested the connection to be closed
        String streamID = session.getStreamID().getID();
        if (multiplexerManager.getClientSession(connectionManagerName, streamID) == null) {
            // Client or Connection manager requested to close the session
            // Do nothing since it has already been removed and closed
        }
        else {
157 158 159 160 161 162 163 164 165 166 167 168
            ConnectionMultiplexerSession multiplexerSession =
                    multiplexerManager.getMultiplexerSession(connectionManagerName);
            if (multiplexerSession != null) {
                // Server requested to close the client session so let the connection manager
                // know that he has to finish the client session
                IQ closeRequest = new IQ(IQ.Type.set);
                closeRequest.setFrom(serverName);
                closeRequest.setTo(connectionManagerName);
                Element child = closeRequest.setChildElement("session",
                        "http://jabber.org/protocol/connectionmanager");
                child.addAttribute("id", streamID);
                child.addElement("close");
169
                multiplexerSession.process(closeRequest);
170
            }
Gaston Dombiak's avatar
Gaston Dombiak committed
171 172 173
        }
    }
}