001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.shiro.authc;
020
021import org.apache.shiro.subject.PrincipalCollection;
022
023/**
024 * An SPI interface allowing cleanup logic to be executed during logout of a previously authenticated Subject/user.
025 *
026 * <p>As it is an SPI interface, it is really intended for SPI implementors such as those implementing Realms.
027 *
028 * <p>All of Shiro's concrete Realm implementations implement this interface as a convenience for those wishing
029 * to subclass them.
030 *
031 * @since 0.9
032 */
033public interface LogoutAware {
034
035    /**
036     * Callback triggered when a <code>Subject</code> logs out of the system.
037     *
038     * @param principals the identifying principals of the Subject logging out.
039     */
040    public void onLogout(PrincipalCollection principals);
041}