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.proxy.frontend.spi;
19
20 import io.netty.channel.Channel;
21 import org.apache.shardingsphere.db.protocol.codec.DatabasePacketCodecEngine;
22 import org.apache.shardingsphere.infra.database.core.spi.DatabaseTypedSPI;
23 import org.apache.shardingsphere.proxy.backend.session.ConnectionSession;
24 import org.apache.shardingsphere.proxy.frontend.authentication.AuthenticationEngine;
25 import org.apache.shardingsphere.proxy.frontend.command.CommandExecuteEngine;
26
27 /**
28 * Database protocol frontend engine.
29 */
30 public interface DatabaseProtocolFrontendEngine extends DatabaseTypedSPI {
31
32 /**
33 * Initialize channel.
34 *
35 * @param channel channel
36 */
37 default void initChannel(final Channel channel) {
38 }
39
40 /**
41 * Get database packet codec engine.
42 *
43 * @return database packet codec engine
44 */
45 DatabasePacketCodecEngine getCodecEngine();
46
47 /**
48 * Get authentication engine.
49 *
50 * @return authentication engine
51 */
52 AuthenticationEngine getAuthenticationEngine();
53
54 /**
55 * Get command execute engine.
56 *
57 * @return command execute engine
58 */
59 CommandExecuteEngine getCommandExecuteEngine();
60
61 /**
62 * Release resource.
63 *
64 * @param connectionSession connection session
65 */
66 void release(ConnectionSession connectionSession);
67
68 /**
69 * Handle exception.
70 *
71 * @param connectionSession connection session
72 * @param exception exception
73 */
74 void handleException(ConnectionSession connectionSession, Exception exception);
75 }