View Javadoc

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  /**
22   * An {@code AuthenticationToken} that indicates if the user wishes their identity to be remembered across sessions.
23   * <p/>
24   * Note however that when a new session is created for the corresponding user, that user's identity would be
25   * remembered, but they are <em>NOT</em> considered authenticated.  Please see the
26   * {@link org.apache.shiro.subject.Subject#isRemembered()} JavaDoc for an in-depth explanation of the semantic
27   * differences of what it means to be remembered vs. authenticated.
28   *
29   * @see org.apache.shiro.subject.Subject#isRemembered()
30   * @since 0.9
31   */
32  public interface RememberMeAuthenticationToken extends AuthenticationToken {
33  
34      /**
35       * Returns {@code true} if the submitting user wishes their identity (principal(s)) to be remembered
36       * across sessions, {@code false} otherwise.
37       *
38       * @return {@code true} if the submitting user wishes their identity (principal(s)) to be remembered
39       *         across sessions, {@code false} otherwise.
40       */
41      boolean isRememberMe();
42  
43  }