org.eclipse.jetty.security.UserIdentity Maven / Gradle / Ivy
//
// ========================================================================
// Copyright (c) 1995 Mort Bay Consulting Pty Ltd and others.
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License v. 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
// ========================================================================
//
package org.eclipse.jetty.security;
import java.security.Principal;
import javax.security.auth.Subject;
import org.eclipse.jetty.security.internal.DefaultUserIdentity;
/**
* User object that encapsulates user identity and operations such as run-as-role actions,
* checking isUserInRole and getUserPrincipal.
*
* Implementations of UserIdentity should be immutable so that they may be
* cached by Authenticators and LoginServices.
*/
public interface UserIdentity
{
/**
* @return The user subject
*/
Subject getSubject();
/**
* @return The user principal
*/
Principal getUserPrincipal();
/**
* Check if the user is in a role.
* This call is used to satisfy authorization calls from
* container code which will be using translated role names.
*
* @param role A role name.
* @return True if the user can act in that role.
*/
boolean isUserInRole(String role);
static UserIdentity from(Subject subject, Principal userPrincipal, String... roles)
{
return new DefaultUserIdentity(subject, userPrincipal, roles);
}
}