com.authlete.jaxrs.spi

Interface UserInfoRequestHandlerSpi

All Known Implementing Classes:

UserInfoRequestHandlerSpiAdapter

public interface UserInfoRequestHandlerSpi

Service Provider Interface to work with UserInfoRequestHandler.

An implementation of this interface must be given to the constructor of UserInfoRequestHandler class.

Since:

1.2

Author:

Takahiko Kawasaki

Method Summary

Modifier and Type	Method and Description
Object	getUserClaim(String claimName, String languageTag) Get the value of a claim of the user.
void	prepareUserClaims(String subject, String[] claimNames) Prepare claim values of the user who is identified by the subject (= unique identifier).

Method Detail

prepareUserClaims

void prepareUserClaims(String subject,
                       String[] claimNames)

Prepare claim values of the user who is identified by the subject (= unique identifier).

This method is called before calls of getUserClaim(String, String) method.

Parameters:

subject - The subject (= unique identifier) of the user.

claimNames - Names of the requested claims. Each claim name may contain a language tag. See "5.2. Claims Languages and Scripts" in OpenID Connect Core 1.0 for details.

getUserClaim

Object getUserClaim(String claimName,
                    String languageTag)

Get the value of a claim of the user.

This method may be called multiple times.

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. The value of claimName does NOT contain a language tag.

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.