JNDIDataSourceProvider.java 5.15 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
 * Copyright (C) 2004 Jive Software. All rights reserved.
 *
 * This software is published under the terms of the GNU Public License (GPL),
 * a copy of which is included in this distribution.
 */

package org.jivesoftware.database;

import org.jivesoftware.util.Log;
import org.jivesoftware.messenger.JiveGlobals;

import java.sql.Connection;
import java.sql.SQLException;
import java.util.*;
import javax.naming.Context;
import javax.naming.InitialContext;
import javax.sql.DataSource;

/**
 * An implementation of ConnectionProvider that utilizes a JDBC 2.0 DataSource
 * made available via JNDI. This is useful for application servers where a pooled
 * data connection is already provided so Jive can share the pool with the
 * other applications.<p>
 * <p/>
 * The JNDI location of the DataSource stored as the Jive property
 * <code>database.JNDIProvider.name</code>. This can be overridden by setting
 * the provider's <code>name</code> property if required.
 *
 * @author <a href="mailto:joe@truemesh.com">Joe Walnes</a>
 * @see ConnectionProvider
 */
public class JNDIDataSourceProvider implements ConnectionProvider {

    private String dataSourceName;
    private DataSource dataSource;

    /**
     * Keys of JNDI properties to query PropertyManager for.
     */
    private static final String[] jndiPropertyKeys = {
        Context.APPLET,
        Context.AUTHORITATIVE,
        Context.BATCHSIZE,
        Context.DNS_URL,
        Context.INITIAL_CONTEXT_FACTORY,
        Context.LANGUAGE,
        Context.OBJECT_FACTORIES,
        Context.PROVIDER_URL,
        Context.REFERRAL,
        Context.SECURITY_AUTHENTICATION,
        Context.SECURITY_CREDENTIALS,
        Context.SECURITY_PRINCIPAL,
        Context.SECURITY_PROTOCOL,
        Context.STATE_FACTORIES,
        Context.URL_PKG_PREFIXES
    };

    /**
     * Initialize.
     */
    public JNDIDataSourceProvider() {
67
        dataSourceName = JiveGlobals.getXMLProperty("database.JNDIProvider.name");
Matt Tucker's avatar
Matt Tucker committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
    }

    public String getName() {
        return "JNDI DataSource Connection Provider";
    }

    public String getDescription() {
        return "Connection Provider for Jive to lookup pooled "
                + "DataSource from JNDI location. Requires 'name' "
                + "property with JNDI location. This can be set in "
                + "the properties file as 'JNDIDataSource.name'";
    }

    public String getAuthor() {
        return "Joe Walnes - joe@truemesh.com";
    }

    public int getMajorVersion() {
        return 2;
    }

    public int getMinorVersion() {
        return 1;
    }

    public boolean isPooled() {
        return true;
    }

    public void start() {
        if (dataSourceName == null || dataSourceName.equals("")) {
            error("No name specified for DataSource. JNDI lookup will fail", null);
            return;
        }
        try {
            Properties contextProperties = new Properties();
            for (int i = 0; i < jndiPropertyKeys.length; i++) {
                String k = jndiPropertyKeys[i];
106
                String v = JiveGlobals.getXMLProperty(k);
Matt Tucker's avatar
Matt Tucker committed
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
                if (v != null) {
                    contextProperties.setProperty(k, v);
                }
            }
            Context context = null;
            if (contextProperties.size() > 0) {
                context = new InitialContext(contextProperties);
            }
            else {
                context = new InitialContext();
            }
            dataSource = (DataSource)context.lookup(dataSourceName);
        }
        catch (Exception e) {
            error("Could not lookup DataSource at '" + dataSourceName + "'", e);
        }
    }

    public void restart() {
        destroy();
        start();
    }

    public void destroy() {

    }

    public Connection getConnection() {
        if (dataSource == null) {
            error("DataSource has not been initialized.", null);
            return null;
        }
        try {
            return dataSource.getConnection();
        }
        catch (SQLException e) {
            error("Could not retrieve Connection from DataSource", e);
            return null;
        }
    }

    public String getProperty(String name) {
        if ("name".equals(name)) {
            return dataSourceName;
        }
        else {
            return null;
        }
    }

    public void setProperty(String name, String value) {
        if ("name".equals(name)) {
            this.dataSourceName = value;
160
            JiveGlobals.setXMLProperty("database.JNDIProvider.name", value);
Matt Tucker's avatar
Matt Tucker committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
        }
    }

    public Iterator propertyNames() {
        List list = new ArrayList();
        list.add("name");
        return Collections.unmodifiableList(list).iterator();
    }

    public String getPropertyDescription(String name) {
        if ("name".equals(name)) {
            return "JNDI name to lookup. eg: java:comp/env/jdbc/MyDataSource";
        }
        else {
            return null;
        }
    }

    /**
     * Log an error.
     *
     * @param msg Description of error
     * @param e   Exception to printStackTrace (may be null)
     */
    private final void error(String msg, Exception e) {
        Log.error(msg, e);
    }
188
}