1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements.  See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership.  The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License.  You may obtain a copy of the License at
9  *
10  *     http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied.  See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 module hunt.shiro.authc.AuthenticationListener;
20 
21 import hunt.shiro.authc.AuthenticationToken;
22 import hunt.shiro.authc.AuthenticationInfo;
23 import hunt.shiro.Exceptions;
24 
25 import hunt.shiro.subject.PrincipalCollection;
26 
27 /**
28  * An {@code AuthenticationListener} listens for notifications while {@code Subject}s authenticate with the system.
29  *
30  */
31 interface AuthenticationListener {
32 
33     /**
34      * Callback triggered when an authentication attempt for a {@code Subject} has succeeded.
35      *
36      * @param token the authentication token submitted during the {@code Subject} (user)'s authentication attempt.
37      * @param info  the authentication-related account data acquired after authentication for the corresponding {@code Subject}.
38      */
39     void onSuccess(AuthenticationToken token, AuthenticationInfo info);
40 
41     /**
42      * Callback triggered when an authentication attempt for a {@code Subject} has failed.
43      *
44      * @param token the authentication token submitted during the {@code Subject} (user)'s authentication attempt.
45      * @param ae    the {@code AuthenticationException} that occurred as a result of the attempt.
46      */
47     void onFailure(AuthenticationToken token, AuthenticationException ae);
48 
49     /**
50      * Callback triggered when a {@code Subject} logs-out of the system.
51      * <p/>
52      * This method will only be triggered when a Subject explicitly logs-out of the session.  It will not
53      * be triggered if their Session times out.
54      *
55      * @param principals the identifying principals of the Subject logging out.
56      */
57     void onLogout(PrincipalCollection principals);
58 }