core/src/main/java/org/apache/ki/mgt/RememberMeManager.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.ki.mgt;

import org.apache.ki.authc.AuthenticationException;
import org.apache.ki.authc.AuthenticationInfo;
import org.apache.ki.authc.AuthenticationToken;
import org.apache.ki.subject.PrincipalCollection;


/**
 * A RememberMeManager is responsible for remembering a Subject's identity across that Subject's sessions with
 * the application.
 *
 * @author Les Hazlewood
 * @since 0.9
 */
public interface RememberMeManager {

    //TODO - complete JavaDoc

    PrincipalCollection getRememberedPrincipals();

    void onSuccessfulLogin(AuthenticationToken token, AuthenticationInfo info);

    void onFailedLogin(AuthenticationToken token, AuthenticationException ae);

    void onLogout(PrincipalCollection subjectPrincipals);
}