org.aoju.bus.oauth.Complex Maven / Gradle / Ivy
/*
* The MIT License
*
* Copyright (c) 2017 aoju.org All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.aoju.bus.oauth;
import org.aoju.bus.core.lang.exception.InstrumentException;
import org.aoju.bus.oauth.magic.Callback;
/**
* OAuth平台的API管理类的统一接口，提供以下接口：
* 1) {@link Complex#authorize()}: 获取授权api. 必须实现
* 2) {@link Complex#accessToken()}: 获取授权api. 必须实现
* 3) {@link Complex#userInfo()}: 获取授权api. 必须实现
* 4) {@link Complex#revoke()}: 获取授权api. 非必须实现接口（部分平台不支持）
* 5) {@link Complex#refresh()} ()}: 获取授权api. 非必须实现接口（部分平台不支持）
*
* 注：
* ①、如需通过扩展实现第三方授权，请参考{@link Registry}自行创建对应的枚举类并实现{@link Complex}接口
* ②、如果不是使用的枚举类，那么在授权成功后获取用户信息时，需要单独处理source字段的赋值
* ③、如果扩展了对应枚举类时，在{@link Provider#login(Callback)}中可以通过{@code xx.toString()}获取对应的source
*
* @author Kimi Liu
* @version 5.1.0
* @since JDK 1.8+
*/
public interface Complex {
/**
* 授权的api
*
* @return url
*/
String authorize();
/**
* 获取accessToken的api
*
* @return url
*/
String accessToken();
/**
* 获取用户信息的api
*
* @return url
*/
String userInfo();
/**
* 取消授权的api
*
* @return url
*/
default String revoke() {
throw new InstrumentException(Builder.Status.UNSUPPORTED.getCode());
}
/**
* 刷新授权的api
*
* @return url
*/
default String refresh() {
throw new InstrumentException(Builder.Status.UNSUPPORTED.getCode());
}
}