All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.nimbusds.openid.connect.sdk.rp.OIDCClientInformation Maven / Gradle / Ivy

Go to download

OAuth 2.0 SDK with OpenID Connection extensions for developing client and server applications.

There is a newer version: 11.19.1
Show newest version
/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2016, Connect2id Ltd and contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the
 * License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package com.nimbusds.openid.connect.sdk.rp;


import java.net.URI;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.Set;

import net.jcip.annotations.Immutable;

import net.minidev.json.JSONObject;

import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.auth.Secret;
import com.nimbusds.oauth2.sdk.client.ClientCredentialsParser;
import com.nimbusds.oauth2.sdk.client.ClientInformation;
import com.nimbusds.oauth2.sdk.id.ClientID;
import com.nimbusds.oauth2.sdk.token.BearerAccessToken;


/**
 * OpenID Connect client information. Encapsulates the registration and 
 * metadata details of an OpenID Connect client:
 * 
 * 
    *
  • The client identifier. *
  • The client OpenID Connect metadata. *
  • The optional client secret for a confidential client. *
  • The optional registration URI and access token if dynamic client * registration is permitted. *
* *

Related specifications: * *

    *
  • OpenID Connect Dynamic Client Registration 1.0. *
  • OAuth 2.0 Dynamic Client Registration Protocol (RFC 7591), section * 3.2.1. *
  • OAuth 2.0 Dynamic Client Registration Management Protocol (RFC * 7592), section 3. *
*/ @Immutable public final class OIDCClientInformation extends ClientInformation { /** * The registered parameter names. */ private static final Set REGISTERED_PARAMETER_NAMES; /** * Initialises the registered parameter name set. */ static { Set p = new HashSet<>(ClientInformation.getRegisteredParameterNames()); p.addAll(OIDCClientMetadata.getRegisteredParameterNames()); REGISTERED_PARAMETER_NAMES = Collections.unmodifiableSet(p); } /** * Creates a new OpenID Connect client information instance. * * @param id The client identifier. Must not be {@code null}. * @param issueDate The issue date of the client identifier, * {@code null} if not specified. * @param metadata The OpenID Connect client metadata. Must not be * {@code null}. * @param secret The optional client secret, {@code null} if not * specified. */ public OIDCClientInformation(final ClientID id, final Date issueDate, final OIDCClientMetadata metadata, final Secret secret) { this(id, issueDate, metadata, secret, null, null); } /** * Creates a new OpenID Connect client information instance permitting * dynamic client registration management. * * @param id The client identifier. Must not be * {@code null}. * @param issueDate The issue date of the client identifier, * {@code null} if not specified. * @param metadata The OpenID Connect client metadata. Must not * be {@code null}. * @param secret The optional client secret, {@code null} if * not specified. * @param registrationURI The client registration URI, {@code null} if * not specified. * @param accessToken The client registration access token, * {@code null} if not specified. */ public OIDCClientInformation(final ClientID id, final Date issueDate, final OIDCClientMetadata metadata, final Secret secret, final URI registrationURI, final BearerAccessToken accessToken) { super(id, issueDate, metadata, secret, registrationURI, accessToken); } /** * Gets the registered client metadata parameter names. * * @return The registered parameter names, as an unmodifiable set. */ public static Set getRegisteredParameterNames() { return REGISTERED_PARAMETER_NAMES; } /** * Gets the OpenID Connect client metadata. * * @return The OpenID Connect client metadata. */ public OIDCClientMetadata getOIDCMetadata() { return (OIDCClientMetadata) getMetadata(); } /** * Parses an OpenID Connect client information instance from the * specified JSON object. * * @param jsonObject The JSON object to parse. Must not be * {@code null}. * * @return The client information. * * @throws ParseException If the JSON object couldn't be parsed to an * OpenID Connect client information instance. */ public static OIDCClientInformation parse(final JSONObject jsonObject) throws ParseException { return new OIDCClientInformation( ClientCredentialsParser.parseID(jsonObject), ClientCredentialsParser.parseIDIssueDate(jsonObject), OIDCClientMetadata.parse(jsonObject), ClientCredentialsParser.parseSecret(jsonObject), ClientCredentialsParser.parseRegistrationURI(jsonObject), ClientCredentialsParser.parseRegistrationAccessToken(jsonObject)); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy