psiprobe.controllers.sql.ConnectionTestController.java Source code

Introduction

Here is the source code for psiprobe.controllers.sql.ConnectionTestController.java

Source

/**
 * Licensed under the GPL License. You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 *
 * THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */
package psiprobe.controllers.sql;

import org.apache.catalina.Context;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.ServletRequestUtils;
import org.springframework.web.servlet.ModelAndView;

import psiprobe.controllers.ContextHandlerController;

import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import javax.naming.NamingException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.sql.DataSource;

/**
 * Verifies if a database connection can be established through a given datasource. Displays basic
 * information about the database.
 * 
 * @author Andy Shapoval
 * @author Vlad Ilyushchenko
 * @author jackdimm
 */
public class ConnectionTestController extends ContextHandlerController {

    /** The Constant logger. */
    private static final Logger logger = LoggerFactory.getLogger(ConnectionTestController.class);

    @Override
    protected ModelAndView handleContext(String contextName, Context context, HttpServletRequest request,
            HttpServletResponse response) throws Exception {

        String resourceName = ServletRequestUtils.getStringParameter(request, "resource");
        DataSource dataSource = null;

        try {
            dataSource = getContainerWrapper().getResourceResolver().lookupDataSource(context, resourceName,
                    getContainerWrapper());
        } catch (NamingException e) {
            request.setAttribute("errorMessage", getMessageSourceAccessor()
                    .getMessage("probe.src.dataSourceTest.resource.lookup.failure", new Object[] { resourceName }));
            logger.trace("", e);
        }

        if (dataSource == null) {
            request.setAttribute("errorMessage", getMessageSourceAccessor()
                    .getMessage("probe.src.dataSourceTest.resource.lookup.failure", new Object[] { resourceName }));
        } else {
            try {
                // TODO: use Spring's jdbc template?
                try (Connection conn = dataSource.getConnection()) {
                    DatabaseMetaData md = conn.getMetaData();

                    List<Map<String, String>> dbMetaData = new ArrayList<>();

                    addDbMetaDataEntry(dbMetaData, "probe.jsp.dataSourceTest.dbMetaData.dbProdName",
                            md.getDatabaseProductName());
                    addDbMetaDataEntry(dbMetaData, "probe.jsp.dataSourceTest.dbMetaData.dbProdVersion",
                            md.getDatabaseProductVersion());
                    addDbMetaDataEntry(dbMetaData, "probe.jsp.dataSourceTest.dbMetaData.jdbcDriverName",
                            md.getDriverName());
                    addDbMetaDataEntry(dbMetaData, "probe.jsp.dataSourceTest.dbMetaData.jdbcDriverVersion",
                            md.getDriverVersion());
                    // addDbMetaDataEntry(dbMetaData, "probe.jsp.dataSourceTest.dbMetaData.jdbcVersion",
                    // String.valueOf(md.getJDBCMajorVersion()));

                    return new ModelAndView(getViewName(), "dbMetaData", dbMetaData);
                }
            } catch (SQLException e) {
                String message = getMessageSourceAccessor()
                        .getMessage("probe.src.dataSourceTest.connection.failure", new Object[] { e.getMessage() });
                logger.error(message, e);
                request.setAttribute("errorMessage", message);
            }
        }

        return new ModelAndView(getViewName());
    }

    @Override
    protected boolean isContextOptional() {
        return true;
    }

    /**
     * Adds the db meta data entry.
     *
     * @param list the list
     * @param name the name
     * @param value the value
     */
    private void addDbMetaDataEntry(List<Map<String, String>> list, String name, String value) {
        Map<String, String> entry = new LinkedHashMap<>();
        entry.put("propertyName", getMessageSourceAccessor().getMessage(name));
        entry.put("propertyValue", value);
        list.add(entry);
    }

}