| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| LogoutAware |
|
| 1.0;1 |
| 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 | package org.apache.shiro.authc; | |
| 20 | ||
| 21 | import org.apache.shiro.subject.PrincipalCollection; | |
| 22 | ||
| 23 | /** | |
| 24 | * An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user. | |
| 25 | * | |
| 26 | * <p>As it is an SPI interface, it is really intended for SPI implementors such as those implementing Realms. | |
| 27 | * | |
| 28 | * <p>All of Shiro's concrete Realm implementations implement this interface as a convenience for those wishing | |
| 29 | * to subclass them. | |
| 30 | * | |
| 31 | * @since 0.9 | |
| 32 | */ | |
| 33 | public interface LogoutAware { | |
| 34 | ||
| 35 | /** | |
| 36 | * Callback triggered when a <code>Subject</code> logs out of the system. | |
| 37 | * | |
| 38 | * @param principals the identifying principals of the Subject logging out. | |
| 39 | */ | |
| 40 | public void onLogout(PrincipalCollection principals); | |
| 41 | } |