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.proxy.frontend.authentication;
19  
20  import io.netty.channel.ChannelHandlerContext;
21  import org.apache.shardingsphere.authentication.result.AuthenticationResult;
22  import org.apache.shardingsphere.db.protocol.payload.PacketPayload;
23  
24  /**
25   * Authentication engine.
26   */
27  public interface AuthenticationEngine {
28      
29      /**
30       * Handshake.
31       *
32       * @param context channel handler context
33       * @return connection ID
34       */
35      int handshake(ChannelHandlerContext context);
36      
37      /**
38       * Authenticate.
39       *
40       * @param context channel handler context
41       * @param payload packet payload
42       * @return authentication result
43       */
44      AuthenticationResult authenticate(ChannelHandlerContext context, PacketPayload payload);
45  }