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
021/**
022 * An {@code AuthenticationToken} that indicates if the user wishes their identity to be remembered across sessions.
023 * <p/>
024 * Note however that when a new session is created for the corresponding user, that user's identity would be
025 * remembered, but they are <em>NOT</em> considered authenticated.  Please see the
026 * {@link org.apache.shiro.subject.Subject#isRemembered()} JavaDoc for an in-depth explanation of the semantic
027 * differences of what it means to be remembered vs. authenticated.
028 *
029 * @see org.apache.shiro.subject.Subject#isRemembered()
030 * @since 0.9
031 */
032public interface RememberMeAuthenticationToken extends AuthenticationToken {
033
034    /**
035     * Returns {@code true} if the submitting user wishes their identity (principal(s)) to be remembered
036     * across sessions, {@code false} otherwise.
037     *
038     * @return {@code true} if the submitting user wishes their identity (principal(s)) to be remembered
039     *         across sessions, {@code false} otherwise.
040     */
041    boolean isRememberMe();
042
043}