001/*
002 * Copyright 2002-2012 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.jdbc;
018
019import java.sql.SQLException;
020
021import org.springframework.dao.InvalidDataAccessResourceUsageException;
022
023/**
024 * Exception thrown when a ResultSet has been accessed in an invalid fashion.
025 * Such exceptions always have a {@code java.sql.SQLException} root cause.
026 *
027 * <p>This typically happens when an invalid ResultSet column index or name
028 * has been specified. Also thrown by disconnected SqlRowSets.
029 *
030 * @author Juergen Hoeller
031 * @since 1.2
032 * @see BadSqlGrammarException
033 * @see org.springframework.jdbc.support.rowset.SqlRowSet
034 */
035@SuppressWarnings("serial")
036public class InvalidResultSetAccessException extends InvalidDataAccessResourceUsageException {
037
038        private String sql;
039
040
041        /**
042         * Constructor for InvalidResultSetAccessException.
043         * @param task name of current task
044         * @param sql the offending SQL statement
045         * @param ex the root cause
046         */
047        public InvalidResultSetAccessException(String task, String sql, SQLException ex) {
048                super(task + "; invalid ResultSet access for SQL [" + sql + "]", ex);
049                this.sql = sql;
050        }
051
052        /**
053         * Constructor for InvalidResultSetAccessException.
054         * @param ex the root cause
055         */
056        public InvalidResultSetAccessException(SQLException ex) {
057                super(ex.getMessage(), ex);
058        }
059
060
061        /**
062         * Return the wrapped SQLException.
063         */
064        public SQLException getSQLException() {
065                return (SQLException) getCause();
066        }
067
068        /**
069         * Return the SQL that caused the problem.
070         * @return the offending SQL, if known
071         */
072        public String getSql() {
073                return this.sql;
074        }
075
076}