com.helger.security.authentication.subject.user.IHasUserID Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-security Show documentation

Special Java 1.8+ Library with security related functionality

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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 com.helger.security.authentication.subject.user;

/**
 * Interface for objects having a user ID.
 *
 * @author Philip Helger
 */
public interface IHasUserID
{
  /**
   * @return The ID of the user. Presence requirement depends on use case.
   */
  String getUserID ();

  /**
   * @return true if the user ID equals
   *         {@link com.helger.security.authentication.subject.user.CUserID#USER_ID_GUEST}
   */
  default boolean isAnonymousUser ()
  {
    return CUserID.USER_ID_GUEST.equals (getUserID ());
  }
}