com.github.antoniomacri.reactivegwt.proxy.auth.HasOAuthIDToken Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reactive-gwt-proxy Show documentation

The newest version!

/**
 * Copyright 2015 Blue Esoteric Web Development, LLC
 * 
 *
 * 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 
 *
 * 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.github.antoniomacri.reactivegwt.proxy.auth;

import com.github.antoniomacri.reactivegwt.proxy.exception.TokenNotAvailableException;

/**
 * Indicates that, when prepared, an OAuth 2.0 ID Token is available for use
 *
 * @author Preethum
 * @since 0.6
 */
public interface HasOAuthIDToken {
	/**
	 *
	 * @return the OAuth 2.0 ID Token
	 * @throws TokenNotAvailableException
	 *             if the authenticator has not completed preparing this token
	 *             data
	 */
	String getOAuthIDToken() throws TokenNotAvailableException;
}