net.oauth2.client.TokenService Maven / Gradle / Ivy

Go to download

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

The newest version!

/* 
 * Copyright (c) 2017 Georgi Pavlov ([email protected]).
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the MIT license which accompanies 
 * this distribution, and is available at 
 * https://github.com/tengia/oauth-2/blob/master/LICENSE
 */

package net.oauth2.client;

import java.io.IOException;

import net.oauth2.AccessToken;

/**
 * OAuth 2.0 Token Service delegate with functional capabilities to fetch and refresh tokens.
 *
 */
public interface TokenService {
	
	String DEFAULT_URL_PATH = "token";

	/**
	 * Sends a request for an Access Token to the backend Token Service. 
	 * 
	 * @return
	 * @throws OAuth2ProtocolException
	 * @throws IOException
	 */
	 T fetch() throws OAuth2ProtocolException, IOException;

	/**
	 * Sends a refresh token request to the Token Service using the supplied refreshTokenSeting.
	 *  
	 * @param refreshTokenString The refresh token supplied with the access token fetched initially 
	 * @return new, refreshed access token
	 * @throws OAuth2ProtocolException
	 * @throws IOException
	 * @throws RuntimeException if this delegate and/or the backend token service does not support refresh of tokens.    
	 */
	 T refresh(String refreshTokenString) throws OAuth2ProtocolException, IOException;
	
}