Interface Identity

All Known Subinterfaces:
All Known Implementing Classes:

public interface Identity

An identity exposes the information that specifies the identity of an authenticated entity.

An entity can be authenticated using credentials that might include an identifier such as a username, a hostname, an IP or MAC address, a personal token... This identifier is usually used during the authentication process to obtain an Authentication. However this authentication and especially any identifier involved is sometimes not enough to be able to fully identify the entity. Indeed, an entity can be authenticated in multiple ways using multiple identifiers whereas only one single identifier uniquely identifies it.

An identity must have one unique immutable identifier and provides specific information about the user. For a person it can be a first name, a last name, an email address and any kind of personal information. For a a system or a device it can be a serial number, an IP address, a screen resolution, an X.509 certificate...

The identity is one of the components that make up the SecurityContext along with Authentication and AccessController. An identity is usually resolved from an Authentication using an IdentityResolver.

Jeremy Kuhn
  • Method Summary

    Modifier and Type
    Returns the unique identifier that identifies the authenticated entity.
  • Method Details

    • getUid

      String getUid()

      Returns the unique identifier that identifies the authenticated entity.

      a unique identifier