com.nimbusds.oauth2.sdk.AbstractOptionallyIdentifiedRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing
client and server applications.
/*
* 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.oauth2.sdk;
import java.net.URI;
import com.nimbusds.oauth2.sdk.auth.ClientAuthentication;
import com.nimbusds.oauth2.sdk.id.ClientID;
/**
* Abstract request with optional client authentication or client
* identification.
*
* Client authentication methods:
*
*
* - {@link com.nimbusds.oauth2.sdk.auth.ClientSecretBasic client_secret_basic}
*
- {@link com.nimbusds.oauth2.sdk.auth.ClientSecretPost client_secret_post}
*
- {@link com.nimbusds.oauth2.sdk.auth.ClientSecretJWT client_secret_jwt}
*
- {@link com.nimbusds.oauth2.sdk.auth.PrivateKeyJWT private_key_jwt}
*
*
* Client identification methods:
*
*
* - Top level {@code client_id} parameter.
*
*/
public abstract class AbstractOptionallyIdentifiedRequest extends AbstractOptionallyAuthenticatedRequest {
/**
* The client identifier, {@code null} if not specified.
*/
private final ClientID clientID;
/**
* Creates a new abstract request with optional client authentication.
*
* @param uri The URI of the endpoint (HTTP or HTTPS) for which
* the request is intended, {@code null} if not
* specified (if, for example, the
* {@link #toHTTPRequest()} method will not be used).
* @param clientAuth The client authentication, {@code null} if none.
*/
public AbstractOptionallyIdentifiedRequest(final URI uri,
final ClientAuthentication clientAuth) {
super(uri, clientAuth);
clientID = null;
}
/**
* Creates a new abstract request with optional client identification.
*
* @param uri The URI of the endpoint (HTTP or HTTPS) for which
* the request is intended, {@code null} if not
* specified (if, for example, the
* {@link #toHTTPRequest()} method will not be used).
* @param clientID The client identifier, {@code null} if not
* specified.
*/
public AbstractOptionallyIdentifiedRequest(final URI uri,
final ClientID clientID) {
super(uri, null);
this.clientID = clientID;
}
/**
* Gets the client identifier (for a request from a public client or a
* request without explicit client authentication).
*
* @see #getClientAuthentication()
*
* @return The client identifier, {@code null} if not specified.
*/
public ClientID getClientID() {
return clientID;
}
}