Class DefaultOpenIdProviderMetadata

java.lang.Object
io.micronaut.security.oauth2.client.DefaultOpenIdProviderMetadata
All Implemented Interfaces:
io.micronaut.core.naming.Named, OpenIdProviderMetadata

public class DefaultOpenIdProviderMetadata extends Object implements OpenIdProviderMetadata
Since:
1.2.0
Author:
Sergio del Amo
See Also:
  • Constructor Details

    • DefaultOpenIdProviderMetadata

      public DefaultOpenIdProviderMetadata(@NonNull @NonNull String providerName)
      Parameters:
      providerName - Provider Name
  • Method Details

    • getName

      @NonNull public @NonNull String getName()
      Specified by:
      getName in interface io.micronaut.core.naming.Named
    • setName

      public void setName(@NonNull @NonNull String name)
      Parameters:
      name - The configured provider name
    • getRequireRequestUriRegistration

      @Nullable public @Nullable Boolean getRequireRequestUriRegistration()
      Description copied from interface: OpenIdProviderMetadata
      require_request_uri_registration OPTIONAL.
      Specified by:
      getRequireRequestUriRegistration in interface OpenIdProviderMetadata
      Returns:
      Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.
    • getDefaultRequireRequestUriRegistration

      @Nullable public @Nullable Boolean getDefaultRequireRequestUriRegistration()
      Returns:
      If require_request_uri_registration omitted, the default value is false.
    • setRequireRequestUriRegistration

      public void setRequireRequestUriRegistration(@Nullable @Nullable Boolean requireRequestUriRegistration)
      Parameters:
      requireRequestUriRegistration - Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.
    • getAuthorizationEndpoint

      @NonNull public @NonNull String getAuthorizationEndpoint()
      Description copied from interface: OpenIdProviderMetadata
      authorization_endpoint. REQUIRED.
      Specified by:
      getAuthorizationEndpoint in interface OpenIdProviderMetadata
      Returns:
      URL of the Open ID Provider's OAuth 2.0 Authorization Endpoint
    • setAuthorizationEndpoint

      public void setAuthorizationEndpoint(@NonNull @NonNull String authorizationEndpoint)
      Parameters:
      authorizationEndpoint - URL of the Open ID Provider's OAuth 2.0 Authorization Endpoint.
    • setUserinfoEncryptionEncValuesSupported

      public void setUserinfoEncryptionEncValuesSupported(@Nullable @Nullable List<String> userinfoEncryptionEncValuesSupported)
      Parameters:
      userinfoEncryptionEncValuesSupported - List of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT.
    • getIdTokenSigningAlgValuesSupported

      @NonNull public @NonNull List<String> getIdTokenSigningAlgValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      id_token_signing_alg_values_supported REQUIRED.
      Specified by:
      getIdTokenSigningAlgValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
    • getIdTokenEncryptionEncValuesSupported

      @Nullable public @Nullable List<String> getIdTokenEncryptionEncValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      id_token_encryption_enc_values_supported OPTIONAL.
      Specified by:
      getIdTokenEncryptionEncValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
    • setIdTokenEncryptionEncValuesSupported

      public void setIdTokenEncryptionEncValuesSupported(@Nullable @Nullable List<String> idTokenEncryptionEncValuesSupported)
      Parameters:
      idTokenEncryptionEncValuesSupported - List of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT.
    • getUserinfoEncryptionAlgValuesSupported

      public List<String> getUserinfoEncryptionAlgValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      userinfo_encryption_alg_values_supported. OPTIONAL.
      Specified by:
      getUserinfoEncryptionAlgValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
    • setUserinfoEncryptionAlgValuesSupported

      public void setUserinfoEncryptionAlgValuesSupported(@Nullable @Nullable List<String> userinfoEncryptionAlgValuesSupported)
      Parameters:
      userinfoEncryptionAlgValuesSupported - List of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT.
    • getUserinfoEncryptionEncValuesSupported

      @Nullable public @Nullable List<String> getUserinfoEncryptionEncValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      userinfo_encryption_enc_values_supported OPTIONAL.
      Specified by:
      getUserinfoEncryptionEncValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
    • setIdTokenSigningAlgValuesSupported

      public void setIdTokenSigningAlgValuesSupported(@NonNull @NonNull List<String> idTokenSigningAlgValuesSupported)
      Parameters:
      idTokenSigningAlgValuesSupported - List of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT.
    • getIssuer

      @NonNull public @NonNull String getIssuer()
      Description copied from interface: OpenIdProviderMetadata
      issuer. REQUIRED.
      Specified by:
      getIssuer in interface OpenIdProviderMetadata
      Returns:
      URL using the https scheme with no query or fragment component that the Open ID Provider asserts as its Issuer Identifier.
    • setIssuer

      public void setIssuer(@NonNull @NonNull String issuer)
      Parameters:
      issuer - URL using the https scheme with no query or fragment component that the Open ID Provider asserts as its Issuer Identifier.
    • getJwksUri

      @NonNull public @NonNull String getJwksUri()
      Description copied from interface: OpenIdProviderMetadata
      jwks_uri. REQUIRED
      Specified by:
      getJwksUri in interface OpenIdProviderMetadata
      Returns:
      URL of the Open ID Provider's JSON Web Key Set
    • setJwksUri

      public void setJwksUri(@NonNull @NonNull String jwksUri)
      Parameters:
      jwksUri - URL of the Open ID Provider's JSON Web Key Set.
    • getResponseTypesSupported

      @Nullable public @Nullable List<String> getResponseTypesSupported()
      As specified in Open ID Discovery Spec, if omitted, the default for Dynamic OpenID Providers is ["query", "fragment"].
      Specified by:
      getResponseTypesSupported in interface OpenIdProviderMetadata
      Returns:
      Supported response types.
    • getDefaultResponseTypesSupported

      @NonNull public @NonNull List<String> getDefaultResponseTypesSupported()
      Returns:
      if Response Types Supported is ommited, default for Dynamic OpenID Providers is ["query", "fragment"].
    • setResponseTypesSupported

      public void setResponseTypesSupported(@Nullable @Nullable List<String> responseTypesSupported)
      Parameters:
      responseTypesSupported - List of the OAuth 2.0 response_type values that this Open ID Provider supports.
    • getScopesSupported

      @Nullable public @Nullable List<String> getScopesSupported()
      Description copied from interface: OpenIdProviderMetadata
      scopes_supported. RECOMMENDED.
      Specified by:
      getScopesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the OAuth 2.0 [RFC6749] scope values that this server supports.
    • setScopesSupported

      public void setScopesSupported(@Nullable @Nullable List<String> scopesSupported)
      Parameters:
      scopesSupported - List of the OAuth 2.0 [RFC6749] scope values that this server supports.
    • getSubjectTypesSupported

      @NonNull public @NonNull List<String> getSubjectTypesSupported()
      Description copied from interface: OpenIdProviderMetadata
      subject_types_supported. REQUIRED
      Specified by:
      getSubjectTypesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the Subject Identifier types that this OP supports.
    • setSubjectTypesSupported

      public void setSubjectTypesSupported(@NonNull @NonNull List<String> subjectTypesSupported)
      Parameters:
      subjectTypesSupported - List of the Subject Identifier types that this OP supports.
    • getTokenEndpoint

      @NonNull public @NonNull String getTokenEndpoint()
      Description copied from interface: OpenIdProviderMetadata
      token_endpoint. This is REQUIRED unless only the Implicit Flow is used.
      Specified by:
      getTokenEndpoint in interface OpenIdProviderMetadata
      Returns:
      URL of the Open ID Provider's OAuth 2.0 Token Endpoint
    • setTokenEndpoint

      public void setTokenEndpoint(@Nullable @Nullable String tokenEndpoint)
      Parameters:
      tokenEndpoint - URL of the Open ID Provider's OAuth 2.0 Token Endpoint.
    • getTokenEndpointAuthMethodsSupported

      @Nullable public @Nullable List<String> getTokenEndpointAuthMethodsSupported()
      Description copied from interface: OpenIdProviderMetadata
      token_endpoint_auth_methods_supported OPTIONAL.
      Specified by:
      getTokenEndpointAuthMethodsSupported in interface OpenIdProviderMetadata
      Returns:
      List of Client Authentication methods supported by this Token Endpoint.
    • getTokenEndpointAuthSigningAlgValuesSupported

      @Nullable public @Nullable List<String> getTokenEndpointAuthSigningAlgValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      token_endpoint_auth_signing_alg_values_supported OPTIONAL.
      Specified by:
      getTokenEndpointAuthSigningAlgValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the JWS signing algorithms (alg values) supported by the Token Endpoint.
    • setTokenEndpointAuthSigningAlgValuesSupported

      public void setTokenEndpointAuthSigningAlgValuesSupported(@Nullable @Nullable List<String> tokenEndpointAuthSigningAlgValuesSupported)
      Parameters:
      tokenEndpointAuthSigningAlgValuesSupported - List of the JWS signing algorithms (alg values) supported by the Token Endpoint.
    • getDisplayValuesSupported

      @Nullable public @Nullable List<String> getDisplayValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      display_values_supported OPTIONAL.
      Specified by:
      getDisplayValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the display parameter values that the OpenID Provider supports.
    • setDisplayValuesSupported

      public void setDisplayValuesSupported(@Nullable @Nullable List<String> displayValuesSupported)
      Parameters:
      displayValuesSupported - List of the display parameter values that the OpenID Provider supports.
    • getClaimTypesSupported

      @Nullable public @Nullable List<String> getClaimTypesSupported()
      Description copied from interface: OpenIdProviderMetadata
      claim_types_supported OPTIONAL.
      Specified by:
      getClaimTypesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the Claim Types that the OpenID Provider supports.
    • setClaimTypesSupported

      public void setClaimTypesSupported(@Nullable @Nullable List<String> claimTypesSupported)
      Parameters:
      claimTypesSupported - List of the Claim Types that the OpenID Provider supports.
    • setTokenEndpointAuthMethodsSupported

      public void setTokenEndpointAuthMethodsSupported(@Nullable @Nullable List<String> tokenEndpointAuthMethodsSupported)
      Parameters:
      tokenEndpointAuthMethodsSupported - List of Client Authentication methods supported by this Token Endpoint.
    • getUserinfoEndpoint

      @Nullable public @Nullable String getUserinfoEndpoint()
      Description copied from interface: OpenIdProviderMetadata
      userinfo_endpoint. RECOMMENDED. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.
      Specified by:
      getUserinfoEndpoint in interface OpenIdProviderMetadata
      Returns:
      URL of the Open ID Provider's UserInfo Endpoint
    • setUserinfoEndpoint

      public void setUserinfoEndpoint(@Nullable @Nullable String userinfoEndpoint)
      Parameters:
      userinfoEndpoint - URL of the Open ID Provider's UserInfo Endpoint.
    • getResponseModesSupported

      @Nullable public @Nullable List<String> getResponseModesSupported()
      Description copied from interface: OpenIdProviderMetadata
      response_modes_supported. OPTIONAL
      Specified by:
      getResponseModesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the OAuth 2.0 response_mode values that this Open ID Provider supports.
    • setResponseModesSupported

      public void setResponseModesSupported(@Nullable @Nullable List<String> responseModesSupported)
      Parameters:
      responseModesSupported - List of the OAuth 2.0 response_mode values that this Open ID Provider supports.
    • getGrantTypesSupported

      @Nullable public @Nullable List<String> getGrantTypesSupported()
      Description copied from interface: OpenIdProviderMetadata
      grant_types_supported. OPTIONAL
      Specified by:
      getGrantTypesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the OAuth 2.0 Grant Type values that this Open ID Provider supports.
    • getDefaultGrantTypesSupported

      @NonNull public @NonNull List<String> getDefaultGrantTypesSupported()
      As specified in Open ID Discovery Spec, if omitted, the default value is ["authorization_code", "implicit"].
      Returns:
      Default Grant Types if grantTypesSupported is ommited.
    • getAcrValuesSupported

      @Nullable public @Nullable List<String> getAcrValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      acr_values_supported. OPTIONAL.
      Specified by:
      getAcrValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the Authentication Context Class References that this OP supports.
    • setAcrValuesSupported

      public void setAcrValuesSupported(@Nullable @Nullable List<String> acrValuesSupported)
      Parameters:
      acrValuesSupported - List of the Authentication Context Class References that this OP supports.
    • setGrantTypesSupported

      public void setGrantTypesSupported(@Nullable @Nullable List<String> grantTypesSupported)
      Parameters:
      grantTypesSupported - List of the OAuth 2.0 Grant Type values that this Open ID Provider supports.
    • getRegistrationEndpoint

      @Nullable public @Nullable String getRegistrationEndpoint()
      Description copied from interface: OpenIdProviderMetadata
      registration_endpoint. RECOMMENDED
      Specified by:
      getRegistrationEndpoint in interface OpenIdProviderMetadata
      Returns:
      URL of the Open ID Provider's Dynamic Client Registration Endpoint
    • setRegistrationEndpoint

      public void setRegistrationEndpoint(@Nullable @Nullable String registrationEndpoint)
      Parameters:
      registrationEndpoint - URL of the Open ID Provider's Dynamic Client Registration Endpoint.
    • getClaimsSupported

      @Nullable public @Nullable List<String> getClaimsSupported()
      Description copied from interface: OpenIdProviderMetadata
      claims_supported RECOMMENDED.
      Specified by:
      getClaimsSupported in interface OpenIdProviderMetadata
      Returns:
      List of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.
    • getServiceDocumentation

      @Nullable public @Nullable String getServiceDocumentation()
      Description copied from interface: OpenIdProviderMetadata
      service_documentation OPTIONAL.
      Specified by:
      getServiceDocumentation in interface OpenIdProviderMetadata
      Returns:
      URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider.
    • setServiceDocumentation

      public void setServiceDocumentation(@Nullable @Nullable String serviceDocumentation)
      Parameters:
      serviceDocumentation - URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider.
    • getClaimsLocalesSupported

      @Nullable public @Nullable List<String> getClaimsLocalesSupported()
      Description copied from interface: OpenIdProviderMetadata
      claims_locales_supported OPTIONAL.
      Specified by:
      getClaimsLocalesSupported in interface OpenIdProviderMetadata
      Returns:
      Languages and scripts supported for values in Claims
    • setClaimsLocalesSupported

      public void setClaimsLocalesSupported(@Nullable @Nullable List<String> claimsLocalesSupported)
      Parameters:
      claimsLocalesSupported - Languages and scripts supported for values in Claims.
    • getUriLocalesSupported

      @Nullable public @Nullable List<String> getUriLocalesSupported()
      Description copied from interface: OpenIdProviderMetadata
      ui_locales_supported OPTIONAL.
      Specified by:
      getUriLocalesSupported in interface OpenIdProviderMetadata
      Returns:
      Languages and scripts supported for the user interface
    • setUriLocalesSupported

      public void setUriLocalesSupported(@Nullable @Nullable List<String> uriLocalesSupported)
      Parameters:
      uriLocalesSupported - Languages and scripts supported for the user interface.
    • getClaimsParameterSupported

      @Nullable public @Nullable Boolean getClaimsParameterSupported()
      Description copied from interface: OpenIdProviderMetadata
      claims_parameter_supported OPTIONAL.
      Specified by:
      getClaimsParameterSupported in interface OpenIdProviderMetadata
      Returns:
      Boolean value specifying whether the OP supports use of the claims parameter.
    • setClaimsParameterSupported

      public void setClaimsParameterSupported(@Nullable @Nullable Boolean claimsParameterSupported)
      Parameters:
      claimsParameterSupported - Boolean value specifying whether the OP supports use of the claims parameter.
    • setClaimsSupported

      public void setClaimsSupported(@Nullable @Nullable List<String> claimsSupported)
      Parameters:
      claimsSupported - List of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.
    • getCodeChallengeMethodsSupported

      @Nullable public @Nullable List<String> getCodeChallengeMethodsSupported()
      Description copied from interface: OpenIdProviderMetadata
      code_challenge_methods_supported.
      Specified by:
      getCodeChallengeMethodsSupported in interface OpenIdProviderMetadata
      Returns:
      List of the supported transformation methods by the authorisation code verifier for Proof Key for Code Exchange (PKCE).
    • setCodeChallengeMethodsSupported

      public void setCodeChallengeMethodsSupported(@Nullable @Nullable List<String> codeChallengeMethodsSupported)
      Parameters:
      codeChallengeMethodsSupported - List of the supported transformation methods by the authorisation code verifier for Proof Key for Code Exchange (PKCE).
    • getIntrospectionEndpoint

      @Nullable public @Nullable String getIntrospectionEndpoint()
      Specified by:
      getIntrospectionEndpoint in interface OpenIdProviderMetadata
      Returns:
      The fully qualified URL of the server's introspection endpoint defined by OAuth Token Introspection [RFC7662]
      See Also:
    • setIntrospectionEndpoint

      public void setIntrospectionEndpoint(@Nullable @Nullable String introspectionEndpoint)
      Parameters:
      introspectionEndpoint - The fully qualified URL of the server's introspection endpoint defined by OAuth Token Introspection [RFC7662].
    • getIntrospectionEndpointAuthMethodsSupported

      @Nullable public @Nullable List<String> getIntrospectionEndpointAuthMethodsSupported()
      Specified by:
      getIntrospectionEndpointAuthMethodsSupported in interface OpenIdProviderMetadata
      Returns:
      List of Client Authentication methods supported by Introspection Endpoint
    • setIntrospectionEndpointAuthMethodsSupported

      public void setIntrospectionEndpointAuthMethodsSupported(@Nullable @Nullable List<String> introspectionEndpointAuthMethodsSupported)
      Parameters:
      introspectionEndpointAuthMethodsSupported - List of Client Authentication methods supported by Introspection Endpoint.
    • getRevocationEndpoint

      @Nullable public @Nullable String getRevocationEndpoint()
      Specified by:
      getRevocationEndpoint in interface OpenIdProviderMetadata
      Returns:
      The fully qualified URL of the server's revocation endpoint defined by Oauth Token Revocation.
      See Also:
    • setRevocationEndpoint

      public void setRevocationEndpoint(@Nullable @Nullable String revocationEndpoint)
      Parameters:
      revocationEndpoint - The fully qualified URL of the server's revocation endpoint defined by Oauth Token Revocation.
    • getRevocationEndpointAuthMethodsSupported

      @Nullable public @Nullable List<String> getRevocationEndpointAuthMethodsSupported()
      Specified by:
      getRevocationEndpointAuthMethodsSupported in interface OpenIdProviderMetadata
      Returns:
      List of Client Authentication methods supported by Revocation Endpoint
    • setRevocationEndpointAuthMethodsSupported

      public void setRevocationEndpointAuthMethodsSupported(@Nullable @Nullable List<String> revocationEndpointAuthMethodsSupported)
      Parameters:
      revocationEndpointAuthMethodsSupported - List of Client Authentication methods supported by Revocation Endpoint.
    • setCheckSessionIframe

      public void setCheckSessionIframe(@Nullable @Nullable String checkSessionIframe)
      Parameters:
      checkSessionIframe - URL of an OP iframe that supports cross-origin communications for session state information with the RP Client, using the HTML5 postMessage API.
    • getCheckSessionIframe

      @Nullable public @Nullable String getCheckSessionIframe()
      Description copied from interface: OpenIdProviderMetadata
      check_session_iframe. REQUIRED
      Specified by:
      getCheckSessionIframe in interface OpenIdProviderMetadata
      Returns:
      URL of an OP iframe that supports cross-origin communications for session state information with the RP Client, using the HTML5 postMessage API.
    • getEndSessionEndpoint

      @Nullable public @Nullable String getEndSessionEndpoint()
      Description copied from interface: OpenIdProviderMetadata
      end_session_endpoint. REQUIRED
      Specified by:
      getEndSessionEndpoint in interface OpenIdProviderMetadata
      Returns:
      URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.
    • setEndSessionEndpoint

      public void setEndSessionEndpoint(@Nullable @Nullable String endSessionEndpoint)
      Parameters:
      endSessionEndpoint - URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.
    • getRequestParameterSupported

      @Nullable public @Nullable Boolean getRequestParameterSupported()
      Description copied from interface: OpenIdProviderMetadata
      request_parameter_supported OPTIONAL.
      Specified by:
      getRequestParameterSupported in interface OpenIdProviderMetadata
      Returns:
      Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
    • getDefaultRequestParameterSupported

      @NonNull public @NonNull Boolean getDefaultRequestParameterSupported()
      Returns:
      As per spec, If requestParameterSupported omitted, the default value is false.
    • getRequestUriParameterSupported

      @Nullable public @Nullable Boolean getRequestUriParameterSupported()
      Description copied from interface: OpenIdProviderMetadata
      request_uri_parameter_supported OPTIONAL.
      Specified by:
      getRequestUriParameterSupported in interface OpenIdProviderMetadata
      Returns:
      Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
    • getDefaultRequestUriParameterSupported

      @NonNull public @NonNull Boolean getDefaultRequestUriParameterSupported()
      Returns:
      As per spec, If requestUriParameterSupported omitted, the default value is false.
    • setRequestUriParameterSupported

      public void setRequestUriParameterSupported(@Nullable @Nullable Boolean requestUriParameterSupported)
      Parameters:
      requestUriParameterSupported - Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.
    • getOpPolicyUri

      @Nullable public @Nullable String getOpPolicyUri()
      Description copied from interface: OpenIdProviderMetadata
      op_policy_uri OPTIONAL.
      Specified by:
      getOpPolicyUri in interface OpenIdProviderMetadata
      Returns:
      URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP.
    • setOpPolicyUri

      public void setOpPolicyUri(@Nullable @Nullable String opPolicyUri)
      Parameters:
      opPolicyUri - URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP.
    • getOpTosUri

      @Nullable public @Nullable String getOpTosUri()
      Description copied from interface: OpenIdProviderMetadata
      op_tos_uri. OPTIONAL.
      Specified by:
      getOpTosUri in interface OpenIdProviderMetadata
      Returns:
      URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.
    • setOpTosUri

      public void setOpTosUri(@Nullable @Nullable String opTosUri)
      Parameters:
      opTosUri - URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.
    • setRequestParameterSupported

      public void setRequestParameterSupported(@Nullable @Nullable Boolean requestParameterSupported)
      Parameters:
      requestParameterSupported - Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
    • getRequestObjectSigningAlgValuesSupported

      @Nullable public @Nullable List<String> getRequestObjectSigningAlgValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      request_object_signing_alg_values_supported. OPTIONAL
      Specified by:
      getRequestObjectSigningAlgValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the JWS signing algorithms (alg values) supported by the OP for Request Objects.
    • getRequestObjectEncryptionAlgValuesSupported

      @Nullable public @Nullable List<String> getRequestObjectEncryptionAlgValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      request_object_encryption_alg_values_supported OPTIONAL.
      Specified by:
      getRequestObjectEncryptionAlgValuesSupported in interface OpenIdProviderMetadata
      Returns:
      list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects.
    • setRequestObjectEncryptionAlgValuesSupported

      public void setRequestObjectEncryptionAlgValuesSupported(@Nullable @Nullable List<String> requestObjectEncryptionAlgValuesSupported)
      Parameters:
      requestObjectEncryptionAlgValuesSupported - List of the JWE encryption algorithms (alg values) supported by the OP for Request Objects.
    • getRequestObjectEncryptionEncValuesSupported

      @Nullable public @Nullable List<String> getRequestObjectEncryptionEncValuesSupported()
      Description copied from interface: OpenIdProviderMetadata
      request_object_encryption_enc_values_supported OPTIONAL.
      Specified by:
      getRequestObjectEncryptionEncValuesSupported in interface OpenIdProviderMetadata
      Returns:
      List of the JWE encryption algorithms (enc values) supported by the OP for Request Objects.
    • setRequestObjectEncryptionEncValuesSupported

      public void setRequestObjectEncryptionEncValuesSupported(@Nullable @Nullable List<String> requestObjectEncryptionEncValuesSupported)
      Parameters:
      requestObjectEncryptionEncValuesSupported - List of the JWE encryption algorithms (enc values) supported by the OP for Request Objects.
    • setRequestObjectSigningAlgValuesSupported

      public void setRequestObjectSigningAlgValuesSupported(@Nullable @Nullable List<String> requestObjectSigningAlgValuesSupported)
      Parameters:
      requestObjectSigningAlgValuesSupported - List of the JWS signing algorithms (alg values) supported by the OP for Request Objects.
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • builder

      @NonNull public static @NonNull DefaultOpenIdProviderMetadata.Builder builder(String providerName)
      Parameters:
      providerName - Provider Name
      Returns:
      Creates a Builder with a given provider name.