com.authlete.common.types

Interface User

public interface User

An interface that represents a resource owner (in the context of OAuth 2.0) or an end user (in the context of OpenID Connect).

Since:

1.26

Author:

Takahiko Kawasaki

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String attributeName) Get the value of an attribute of the user.
Object	getClaim(String claimName, String languageTag) Get the value of a claim of the user.
String	getSubject() Get the subject (= unique identifier) of the user.

Method Detail

getSubject

String getSubject()

Get the subject (= unique identifier) of the user.

Returns:

The subject (= unique identifier) of the user.

getClaim

Object getClaim(String claimName,
                String languageTag)

Get the value of a claim of the user.

Parameters:

claimName - A claim name such as name and family_name. Standard claim names are listed in "5.1. Standard Claims" of OpenID Connect Core 1.0. Java constant values that represent the standard claims are listed in StandardClaims class.

languageTag - A language tag such as en and ja. Implementations should take this into account whenever possible. See "5.2. Claims Languages and Scripts" in OpenID Connect Core 1.0 for details.

Returns:

The claim value. null if the claim value of the claim is not available.

getAttribute

Object getAttribute(String attributeName)

Get the value of an attribute of the user.

Parameters:

attributeName - An attribute name.

Returns:

The attribute value. null if the attribute value of the attribute is not available.

Since:

2.33