View Javadoc

    1   /*
    2    * Licensed to the University Corporation for Advanced Internet Development,
    3    * Inc. (UCAID) under one or more contributor license agreements.  See the
    4    * NOTICE file distributed with this work for additional information regarding
    5    * copyright ownership. The UCAID licenses this file to You under the Apache
    6    * License, Version 2.0 (the "License"); you may not use this file except in
    7    * compliance with the License.  You may obtain a copy of the License at
    8    *
    9    *    http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the License for the specific language governing permissions and
    15   * limitations under the License.
    16   */
    17
    18  package edu.internet2.middleware.shibboleth.idp.session;
    19
    20  import java.io.Serializable;
    21  import java.security.Principal;
    22
    23  import javax.security.auth.Subject;
    24
    25  import org.joda.time.DateTime;
    26
    27  /** Information about an authentication method employed by a user. */
    28  public interface AuthenticationMethodInformation extends Serializable {
    29
    30      /**
    31       * Gets the Subject created by this authentication method.
    32       *
    33       * @return subject created by this authentication method
    34       *
    35       * @deprecated use {@link Session#getSubject()}
    36       */
    37      public Subject getAuthenticationSubject();
    38
    39      /**
    40       * Gets the principal, for the {@link Subject} of the session, created by this authentication method.
    41       *
    42       * @return principal created by this authentication method
    43       */
    44      public Principal getAuthenticationPrincipal();
    45
    46      /**
    47       * Gets the unique identifier for the authentication method.
    48       *
    49       * @return unique identifier for the authentication method
    50       */
    51      public String getAuthenticationMethod();
    52
    53      /**
    54       * Gets the time the user authenticated with this member.
    55       *
    56       * @return time the user authenticated with this member
    57       */
    58      public DateTime getAuthenticationInstant();
    59
    60      /**
    61       * Gets the duration of this authentication method.
    62       *
    63       * @return duration of this authentication method
    64       */
    65      public long getAuthenticationDuration();
    66
    67      /**
    68       * Gets whether this authentication method has expired and is not longer valid for use in constructing new sessions.
    69       *
    70       * @return whether this authentication method has expired
    71       */
    72      public boolean isExpired();
    73  }