001package com.nimbusds.openid.connect.provider.spi.claims;
002
003
004import java.util.Set;
005
006import net.jcip.annotations.ThreadSafe;
007
008
009/**
010 * Interface for querying OpenID Connect claims support. Implementations must
011 * be thread-safe.
012 */
013@ThreadSafe
014public interface ClaimsSupport {
015
016
017        /**
018         * Returns the names of the supported OpenID Connect claims. The claim
019         * names may include a wildcard character '*' to indicate support for a
020         * pattern of claims, e.g. "id4me.*" for claims with a common prefix.
021         *
022         * <p>Example:
023         *
024         * <pre>
025         * name
026         * email
027         * email_verified
028         * </pre>
029         *
030         * @return The supported claim names. Should not include the reserved
031         *         {@code sub} (subject) claim name.
032         */
033        Set<String> supportedClaims();
034}