com.nimbusds.oauth2.sdk.ProtectedResourceRequest Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation

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

There is a newer version: 11.19.1

/*
 * 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 com.nimbusds.oauth2.sdk.token.AccessToken;

import java.net.URI;


/**
 * Base abstract class for protected resource requests using an OAuth 2.0
 * access token.
 *
 * Related specifications:
 *
 * 

 *     OAuth 2.0 (RFC 6749)
 * 
 */
 public abstract class ProtectedResourceRequest extends AbstractRequest {


 	/**
	 * The access token (optional).
	 */
	private final AccessToken accessToken;
	
	
	/**
	 * Creates a new protected resource request.
	 * 
	 * @param uri         The URI of the protected resource. May be 
	 *                    {@code null} if the {@link #toHTTPRequest()}
	 *                    method is not going to be used.
	 * @param accessToken An access token for the request, {@code null} if
	 *                    none.
	 */
	protected ProtectedResourceRequest(final URI uri, final AccessToken accessToken) {
		
		super(uri);

		this.accessToken = accessToken;
	}


	/**
	 * Gets the access token for this protected resource request.
	 *
	 * @return The access token, {@code null} if none.
	 */
	public AccessToken getAccessToken() {

		return accessToken;
	}
 }