Commit 72ae5a0b authored by Quxl's avatar Quxl

x

parent c26c71f0
...@@ -139,30 +139,30 @@ public interface OAuthApi { ...@@ -139,30 +139,30 @@ public interface OAuthApi {
Log logger = LogFactory.getLog(OAuthApi.class); Log logger = LogFactory.getLog(OAuthApi.class);
/** /**
* 获取OAuth授权系统配置信息, 此方法需由用户自己实现 * <p>获取OAuth授权系统配置信息, 此方法需由用户自己实现</p>
* @return OAuthConfig * @return OAuthConfig
*/ */
OAuthConfig getOAuthConfig(); OAuthConfig getOAuthConfig();
/** /**
* 获取HttpServletRequest * <p>获取HttpServletRequest</p>
* @return HttpServletRequest * @return HttpServletRequest
*/ */
HttpServletRequest getHttpServletRequest(); HttpServletRequest getHttpServletRequest();
/** /**
* 获取HttpServletResponse * <p>获取HttpServletResponse </p>
* @return HttpServletResponse * @return HttpServletResponse
*/ */
HttpServletResponse getHttpServletResponse(); HttpServletResponse getHttpServletResponse();
/** /**
* 用户存储在HttpSession中的OAuthToken的键, 通过此变量可在Session中存储或获取已存在的OAuthToken信息 * <p>用户存储在HttpSession中的OAuthToken的键, 通过此变量可在Session中存储或获取已存在的OAuthToken信息</p>
*/ */
final String OAUTH_TOKEN_SESSION = "OAUTH2_TOKEN_SESSION_KEY"; final String OAUTH_TOKEN_SESSION = "OAUTH2_TOKEN_SESSION_KEY";
/** /**
* 判断OAuthToken是否已经存在, 或判断用户是否登陆 * <p>判断OAuthToken是否已经存在, 或判断用户是否登陆</p>
* *
* @return true存在, false不存在 * @return true存在, false不存在
*/ */
...@@ -171,7 +171,7 @@ public interface OAuthApi { ...@@ -171,7 +171,7 @@ public interface OAuthApi {
} }
/** /**
* 获取存储在Session中的OAuthToken信息 * <p>获取存储在Session中的OAuthToken信息</p>
* @return 如果存在则返回, 否则返回null * @return 如果存在则返回, 否则返回null
*/ */
default OAuthToken getOAuthToken() { default OAuthToken getOAuthToken() {
...@@ -270,7 +270,7 @@ public interface OAuthApi { ...@@ -270,7 +270,7 @@ public interface OAuthApi {
} }
/** /**
* 保存OAuthToken信息 将token信息保存在HttpSession会话中, 登陆操作时需要调用此方法 * <p>保存OAuthToken信息 将token信息保存在HttpSession会话中, 登陆操作时需要调用此方法</p>
* @param token 要保存的OAuthToken对象 * @param token 要保存的OAuthToken对象
*/ */
default void saveOAuthToken(OAuthToken token) { default void saveOAuthToken(OAuthToken token) {
...@@ -280,7 +280,7 @@ public interface OAuthApi { ...@@ -280,7 +280,7 @@ public interface OAuthApi {
} }
/** /**
* 从HttpSession中将OAuthToken信息删除, 注销系统时需要调用此方法进行退出操作 * <p>从HttpSession中将OAuthToken信息删除, 注销系统时需要调用此方法进行退出操作</p>
*/ */
default void removeOAuthToken() { default void removeOAuthToken() {
try { try {
...@@ -340,7 +340,7 @@ public interface OAuthApi { ...@@ -340,7 +340,7 @@ public interface OAuthApi {
/** /**
* *
* 系统授权成功后,用户和通过此方法访问应用接口(因甲方未提供相关接口请求数据格式和鉴权设置等信息, 此处只按标准OAuth授权后的请求流程进行操作, 如有出入,用户可以根据实际情况, 重写或重载此方法) * <p>系统授权成功后,用户和通过此方法访问应用接口(因甲方未提供相关接口请求数据格式和鉴权设置等信息, 此处只按标准OAuth授权后的请求流程进行操作, 如有出入,用户可以根据实际情况, 重写或重载此方法)</p>
* @param url 访问URL * @param url 访问URL
* @param headers HTTP头信息 * @param headers HTTP头信息
* @param data HTTP请求参数 * @param data HTTP请求参数
......
package com.egolm.sso.oauth; package com.egolm.sso.oauth;
/** /**
* 自定义异常类 * <p>自定义异常类</p>
* @author Quxl * @author Quxl
* *
*/ */
......
...@@ -5,7 +5,7 @@ import java.io.Serializable; ...@@ -5,7 +5,7 @@ import java.io.Serializable;
import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSON;
/** /**
* OAuth系统配置, 用于存放访问OAuth授权系统的参数 * <p>OAuth系统配置, 用于存放访问OAuth授权系统的参数</p>
* @author Quxl * @author Quxl
* *
*/ */
......
package com.egolm.sso.oauth; package com.egolm.sso.oauth;
/**
*
* @author Quxl
*
*/
public class OAuthTokenException extends OAuthApiException { public class OAuthTokenException extends OAuthApiException {
private static final long serialVersionUID = 5506671150969428663L; private static final long serialVersionUID = 5506671150969428663L;
......
...@@ -6,8 +6,8 @@ import java.util.Map; ...@@ -6,8 +6,8 @@ import java.util.Map;
import java.util.TreeMap; import java.util.TreeMap;
/** /**
* HTTP URL 构造器 * <p>HTTP URL 构造器</p>
* 用于组装构造HTTP完整链接 * <p>用于组装构造HTTP完整链接</p>
* @author Quxl * @author Quxl
* *
*/ */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment