org.keycloak.protocol.oidc.utils.OIDCResponseType クラス

org.keycloak.protocol.oidc.utils.OIDCResponseType 連携図

公開メンバ関数
boolean	hasResponseType (String responseType)
boolean	isImplicitOrHybridFlow ()
boolean	isImplicitFlow ()
String	toString ()

静的公開メンバ関数
static OIDCResponseType	parse (String responseTypeParam)
static OIDCResponseType	parse (List< String > responseTypes)

静的公開変数類
static final String	CODE = OIDCLoginProtocol.CODE_PARAM
static final String	TOKEN = "token"
static final String	ID_TOKEN = "id_token"
static final String	NONE = "none"

非公開メンバ関数
	OIDCResponseType (List< String > responseTypes)

静的非公開メンバ関数
static void	validateAllowedTypes (List< String > responseTypes)

非公開変数類
final List< String >	responseTypes

静的非公開変数類
static final List< String >	ALLOWED_RESPONSE_TYPES = Arrays.asList(CODE, TOKEN, ID_TOKEN, NONE)

詳解

著者

Marek Posolda

構築子と解体子

OIDCResponseType()

org.keycloak.protocol.oidc.utils.OIDCResponseType.OIDCResponseType ( List< String >  responseTypes )

inlineprivate

                                                         {
        this.responseTypes = responseTypes;
    }

関数詳解

hasResponseType()

boolean org.keycloak.protocol.oidc.utils.OIDCResponseType.hasResponseType ( String  responseType )

inline

                                                        {
        return responseTypes.contains(responseType);
    }

isImplicitFlow()

boolean org.keycloak.protocol.oidc.utils.OIDCResponseType.isImplicitFlow ( )

inline

                                    {
        return (hasResponseType(TOKEN) || hasResponseType(ID_TOKEN)) && !hasResponseType(CODE);
    }

isImplicitOrHybridFlow()

boolean org.keycloak.protocol.oidc.utils.OIDCResponseType.isImplicitOrHybridFlow ( )

inline

                                            {
        return hasResponseType(TOKEN) || hasResponseType(ID_TOKEN);
    }

parse() [1/2]

static OIDCResponseType org.keycloak.protocol.oidc.utils.OIDCResponseType.parse ( String  responseTypeParam )

inlinestatic

                                                                   {
        if (responseTypeParam == null) {
            throw new IllegalArgumentException("response_type is null");
        }

        String[] responseTypes = responseTypeParam.trim().split(" ");
        List<String> allowedTypes = new ArrayList<>();
        for (String current : responseTypes) {
            if (ALLOWED_RESPONSE_TYPES.contains(current)) {
                allowedTypes.add(current);
            } else {
                throw new IllegalArgumentException("Unsupported response_type: " + responseTypeParam);
            }
        }

        validateAllowedTypes(allowedTypes);

        return new OIDCResponseType(allowedTypes);
    }

parse() [2/2]

static OIDCResponseType org.keycloak.protocol.oidc.utils.OIDCResponseType.parse ( List< String >  responseTypes )

inlinestatic

                                                                     {
        OIDCResponseType result = new OIDCResponseType(new ArrayList<String>());
        for (String respType : responseTypes) {
            OIDCResponseType responseType = parse(respType);
            result.responseTypes.addAll(responseType.responseTypes);
        }

        return result;
    }

toString()

String org.keycloak.protocol.oidc.utils.OIDCResponseType.toString ( )

inline

                             {
        StringBuilder builder = new StringBuilder();
        boolean first = true;
        for (String responseType : responseTypes) {
            if (!first) {
                builder.append(" ");
            } else {
                first = false;
            }
            builder.append(responseType);
        }
        return builder.toString();
    }

validateAllowedTypes()

static void org.keycloak.protocol.oidc.utils.OIDCResponseType.validateAllowedTypes ( List< String >  responseTypes )

inlinestaticprivate

                                                                         {
        if (responseTypes.size() == 0) {
            throw new IllegalStateException("No responseType provided");
        }
        if (responseTypes.contains(NONE) && responseTypes.size() > 1) {
            throw new IllegalArgumentException("'None' not allowed with some other response_type");
        }

        // response_type value "token" alone is not mentioned in OIDC specification, however it is supported by OAuth2. We allow it just to be compatible with pure OAuth2 clients like swagger.ui
//        if (responseTypes.contains(TOKEN) && responseTypes.size() == 1) {
//            throw new IllegalArgumentException("Not supported to use response_type=token alone");
//        }
    }

メンバ詳解

ALLOWED_RESPONSE_TYPES

final List<String> org.keycloak.protocol.oidc.utils.OIDCResponseType.ALLOWED_RESPONSE_TYPES = Arrays.asList(CODE, TOKEN, ID_TOKEN, NONE)

staticprivate

CODE

final String org.keycloak.protocol.oidc.utils.OIDCResponseType.CODE = OIDCLoginProtocol.CODE_PARAM

static

ID_TOKEN

final String org.keycloak.protocol.oidc.utils.OIDCResponseType.ID_TOKEN = "id_token"

static

NONE

final String org.keycloak.protocol.oidc.utils.OIDCResponseType.NONE = "none"

static

responseTypes

final List<String> org.keycloak.protocol.oidc.utils.OIDCResponseType.responseTypes

private

TOKEN

final String org.keycloak.protocol.oidc.utils.OIDCResponseType.TOKEN = "token"

static

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/protocol/oidc/utils/OIDCResponseType.java