View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shardingsphere.db.protocol.mysql.packet.generic;
19  
20  import com.google.common.base.Preconditions;
21  import lombok.Getter;
22  import org.apache.shardingsphere.db.protocol.mysql.packet.MySQLPacket;
23  import org.apache.shardingsphere.db.protocol.mysql.payload.MySQLPacketPayload;
24  import org.apache.shardingsphere.infra.exception.core.external.sql.vendor.VendorError;
25  
26  import java.sql.SQLException;
27  
28  /**
29   * ERR packet protocol for MySQL.
30   * 
31   * @see <a href="https://dev.mysql.com/doc/dev/mysql-server/latest/page_protocol_basic_err_packet.html">ERR Packet</a>
32   */
33  @Getter
34  public final class MySQLErrPacket extends MySQLPacket {
35      
36      /**
37       * Header of ERR packet.
38       */
39      public static final int HEADER = 0xff;
40      
41      private static final String SQL_STATE_MARKER = "#";
42      
43      private final int errorCode;
44      
45      private final String sqlState;
46      
47      private final String errorMessage;
48      
49      public MySQLErrPacket(final SQLException exception) {
50          errorCode = exception.getErrorCode();
51          sqlState = exception.getSQLState();
52          errorMessage = exception.getMessage();
53      }
54      
55      public MySQLErrPacket(final VendorError vendorError, final Object... errorMessageArgs) {
56          errorCode = vendorError.getVendorCode();
57          sqlState = vendorError.getSqlState().getValue();
58          errorMessage = String.format(vendorError.getReason(), errorMessageArgs);
59      }
60      
61      public MySQLErrPacket(final MySQLPacketPayload payload) {
62          Preconditions.checkArgument(HEADER == payload.readInt1(), "Header of MySQL ERR packet must be `0xff`.");
63          errorCode = payload.readInt2();
64          payload.readStringFix(1);
65          sqlState = payload.readStringFix(5);
66          errorMessage = payload.readStringEOF();
67      }
68      
69      @Override
70      protected void write(final MySQLPacketPayload payload) {
71          payload.writeInt1(HEADER);
72          payload.writeInt2(errorCode);
73          payload.writeStringFix(SQL_STATE_MARKER);
74          payload.writeStringFix(sqlState);
75          payload.writeStringEOF(errorMessage);
76      }
77  }