001/* 002 * oauth2-oidc-sdk 003 * 004 * Copyright 2012-2021, Connect2id Ltd and contributors. 005 * 006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use 007 * this file except in compliance with the License. You may obtain a copy of the 008 * License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, software distributed 013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the 015 * specific language governing permissions and limitations under the License. 016 */ 017 018package com.nimbusds.openid.connect.sdk.op; 019 020 021import java.net.URI; 022 023import com.nimbusds.oauth2.sdk.as.ReadOnlyAuthorizationServerEndpointMetadata; 024 025 026/** 027 * Read-only OpenID Provider (OP) endpoint metadata. 028 * 029 * <p>Related specifications: 030 * 031 * <ul> 032 * <li>OAuth 2.0 Authorization Server Metadata (RFC 8414) 033 * <li>OAuth 2.0 Mutual TLS Client Authentication and Certificate Bound 034 * Access Tokens (RFC 8705) 035 * <li>OAuth 2.0 Device Flow for Browserless and Input Constrained Devices 036 * (draft-ietf-oauth-device-flow-14) 037 * <li>OpenID Connect Discovery 1.0, section 3. 038 * <li>OpenID Connect Session Management 1.0, section 2.1 (draft 28). 039 * <li>OpenID Connect Front-Channel Logout 1.0, section 3 (draft 02). 040 * <li>OpenID Connect Back-Channel Logout 1.0, section 2.1 (draft 04). 041 * <li>OpenID Connect Federation 1.0 (draft 10). 042 * </ul> 043 */ 044public interface ReadOnlyOIDCProviderEndpointMetadata extends ReadOnlyAuthorizationServerEndpointMetadata { 045 046 047 /** 048 * Gets the UserInfo endpoint URI. Corresponds the 049 * {@code userinfo_endpoint} metadata field. 050 * 051 * @return The UserInfo endpoint URI, {@code null} if not specified. 052 */ 053 URI getUserInfoEndpointURI(); 054 055 056 /** 057 * Gets the cross-origin check session iframe URI. Corresponds to the 058 * {@code check_session_iframe} metadata field. 059 * 060 * @return The check session iframe URI, {@code null} if not specified. 061 */ 062 URI getCheckSessionIframeURI(); 063 064 065 /** 066 * Gets the logout endpoint URI. Corresponds to the 067 * {@code end_session_endpoint} metadata field. 068 * 069 * @return The logoout endpoint URI, {@code null} if not specified. 070 */ 071 URI getEndSessionEndpointURI(); 072 073 074 /** 075 * Gets the federation registration endpoint URI. Corresponds to the 076 * {@code federation_registration_endpoint} metadata field. 077 * 078 * @return The federation registration endpoint URI, {@code null} if 079 * not specified. 080 */ 081 URI getFederationRegistrationEndpointURI(); 082}