View Javadoc
1   /*
2    *    Copyright 2009-2023 the original author or authors.
3    *
4    *    Licensed under the Apache License, Version 2.0 (the "License");
5    *    you may not use this file except in compliance with the License.
6    *    You may obtain a copy of the License at
7    *
8    *       https://www.apache.org/licenses/LICENSE-2.0
9    *
10   *    Unless required by applicable law or agreed to in writing, software
11   *    distributed under the License is distributed on an "AS IS" BASIS,
12   *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *    See the License for the specific language governing permissions and
14   *    limitations under the License.
15   */
16  package org.apache.ibatis.scripting.defaults;
17  
18  import org.apache.ibatis.builder.BuilderException;
19  import org.apache.ibatis.mapping.SqlSource;
20  import org.apache.ibatis.parsing.XNode;
21  import org.apache.ibatis.scripting.xmltags.XMLLanguageDriver;
22  import org.apache.ibatis.session.Configuration;
23  
24  /**
25   * As of 3.2.4 the default XML language is able to identify static statements and create a {@link RawSqlSource}. So
26   * there is no need to use RAW unless you want to make sure that there is not any dynamic tag for any reason.
27   *
28   * @since 3.2.0
29   *
30   * @author Eduardo Macarron
31   */
32  public class RawLanguageDriver extends XMLLanguageDriver {
33  
34    @Override
35    public SqlSource createSqlSource(Configuration configuration, XNode script, Class<?> parameterType) {
36      SqlSource source = super.createSqlSource(configuration, script, parameterType);
37      checkIsNotDynamic(source);
38      return source;
39    }
40  
41    @Override
42    public SqlSource createSqlSource(Configuration configuration, String script, Class<?> parameterType) {
43      SqlSource source = super.createSqlSource(configuration, script, parameterType);
44      checkIsNotDynamic(source);
45      return source;
46    }
47  
48    private void checkIsNotDynamic(SqlSource source) {
49      if (!RawSqlSource.class.equals(source.getClass())) {
50        throw new BuilderException("Dynamic content is not allowed when using RAW language");
51      }
52    }
53  
54  }