提交 4be98110 编写于 作者: 智布道's avatar 智布道 👁

📝 javadoc

上级 65736604
......@@ -20,7 +20,6 @@ package com.fujieid.jap.core;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/12 16:15
* @since 1.0.0
*/
public abstract class AuthenticateConfig {
......
......@@ -22,7 +22,6 @@ import com.fujieid.jap.sso.config.JapSsoConfig;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 14:19
* @since 1.0.0
*/
public class JapConfig {
......
......@@ -22,7 +22,6 @@ import java.nio.charset.StandardCharsets;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 18:19
* @since 1.0.0
*/
public interface JapConst {
......
......@@ -23,7 +23,6 @@ import java.io.Serializable;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 14:48
* @since 1.0.0
*/
public class JapUser implements Serializable {
......
......@@ -24,7 +24,6 @@ import java.util.Map;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 14:21
* @since 1.0.0
*/
public interface JapUserService {
......
......@@ -26,7 +26,6 @@ import java.io.IOException;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021-01-25 21:16
* @since 1.0.0
*/
public class JapUtil {
......
......@@ -20,7 +20,6 @@ package com.fujieid.jap.core.exception;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 14:50
* @since 1.0.0
*/
public class JapException extends RuntimeException {
......
......@@ -18,7 +18,6 @@ package com.fujieid.jap.core.exception;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/14 12:07
* @since 1.0.0
*/
public class JapOauth2Exception extends JapException {
......
......@@ -18,7 +18,6 @@ package com.fujieid.jap.core.exception;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/12 12:50
* @since 1.0.0
*/
public class JapSocialException extends JapException {
......
......@@ -20,7 +20,6 @@ package com.fujieid.jap.core.exception;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 14:32
* @since 1.0.0
*/
public class JapStrategyException extends JapException {
......
......@@ -20,7 +20,6 @@ package com.fujieid.jap.core.exception;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 14:49
* @since 1.0.0
*/
public class JapUserException extends JapException {
......
......@@ -18,7 +18,6 @@ package com.fujieid.jap.core.exception;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 16:36
* @since 1.0.0
*/
public class OidcException extends JapException {
......
......@@ -26,7 +26,6 @@ import javax.servlet.http.HttpServletResponse;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 18:50
* @since 1.0.0
*/
public interface JapUserStore {
......
......@@ -32,7 +32,6 @@ import javax.servlet.http.HttpServletResponse;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021-01-21 10:25
* @since 1.0.0
*/
public class JapUserStoreContextHolder {
......
......@@ -26,7 +26,6 @@ import javax.servlet.http.HttpSession;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 19:03
* @since 1.0.0
*/
public class SessionJapUserStore implements JapUserStore {
......
......@@ -29,7 +29,6 @@ import javax.servlet.http.HttpServletResponse;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 19:03
* @since 1.0.0
*/
public class SsoJapUserStore extends SessionJapUserStore {
......
......@@ -34,7 +34,6 @@ import javax.servlet.http.HttpServletResponse;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/12 14:01
* @since 1.0.0
*/
public abstract class AbstractJapStrategy implements JapStrategy {
......
......@@ -26,7 +26,6 @@ import javax.servlet.http.HttpServletResponse;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 14:27
* @since 1.0.0
*/
public interface JapStrategy {
......
......@@ -23,7 +23,6 @@ import com.fujieid.jap.oauth2.pkce.PkceCodeChallengeMethod;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/14 11:23
* @since 1.0.0
*/
public class OAuthConfig extends AuthenticateConfig {
......
......@@ -20,7 +20,6 @@ package com.fujieid.jap.oauth2;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/14 15:34
* @since 1.0.0
*/
public interface Oauth2Const {
......
......@@ -18,7 +18,6 @@ package com.fujieid.jap.oauth2;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/14 16:14
* @since 1.0.0
*/
public enum Oauth2GrantType {
......
......@@ -18,7 +18,6 @@ package com.fujieid.jap.oauth2;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/14 16:14
* @since 1.0.0
*/
public enum Oauth2ResponseType {
......
......@@ -49,7 +49,6 @@ import java.util.Optional;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/14 11:30
* @since 1.0.0
*/
public class Oauth2Strategy extends AbstractJapStrategy {
......@@ -68,6 +67,7 @@ public class Oauth2Strategy extends AbstractJapStrategy {
* `Strategy` constructor.
*
* @param japUserService japUserService
* @param japUserStore japUserStore
* @param japConfig japConfig
*/
public Oauth2Strategy(JapUserService japUserService, JapUserStore japUserStore, JapConfig japConfig) {
......
......@@ -32,7 +32,6 @@ import java.util.Optional;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/14 15:38
* @since 1.0.0
*/
public class Oauth2Util {
......
......@@ -20,7 +20,6 @@ package com.fujieid.jap.oauth2.helper;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021-01-25 22:06
* @since 1.0.0
*/
public class AccessToken {
......
......@@ -38,7 +38,6 @@ import java.util.Map;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021-01-26 10:44
* @since 1.0.0
*/
public class AccessTokenHelper {
......
......@@ -22,7 +22,6 @@
* which can dock with any platform supporting OAuth 2.0 standard protocol
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @date 2021/1/14 11:05
* @version 1.0.0
* @see <a href="https://tools.ietf.org/html/rfc6749" target="_blank">https://tools.ietf.org/html/rfc6749</a>
* @since 1.0.0
......
......@@ -21,7 +21,6 @@ package com.fujieid.jap.oauth2.pkce;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/14 11:56
* @see <a href="https://docs.fujieid.com/college/protocol/oauth-2.0/oauth-2.0-pkce" target="_blank">https://docs.fujieid.com/college/protocol/oauth-2.0/oauth-2.0-pkce</a>
* @see <a href="https://tools.ietf.org/html/rfc7636" target="_blank">https://tools.ietf.org/html/rfc7636</a>
* @since 1.0.0
......
......@@ -20,7 +20,6 @@ package com.fujieid.jap.oauth2.pkce;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 16:49
* @see <a href="https://tools.ietf.org/html/rfc7636#section-6.1" target="_blank">6.1. OAuth Parameters Registry</a>
* @since 1.0.0
*/
......
......@@ -27,7 +27,6 @@ import java.util.concurrent.TimeUnit;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 16:52
* @see <a href="https://tools.ietf.org/html/rfc7636" target="_blank">Proof Key for Code Exchange by OAuth Public Clients</a>
* @since 1.0.0
*/
......
......@@ -20,7 +20,6 @@ import com.fujieid.jap.oauth2.OAuthConfig;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 16:23
* @since 1.0.0
*/
public class OidcConfig extends OAuthConfig {
......
......@@ -24,7 +24,6 @@ import java.io.Serializable;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2020/10/26 14:47
* @see <a href="https://openid.net/specs/openid-connect-discovery-1_0.html" target="_blank">OpenID Connect Discovery 1.0 incorporating errata set 1</a>
* @see <a href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata" target="_blank">3. OpenID Provider Metadata</a>
* @since 1.0.0
......
......@@ -20,7 +20,6 @@ package com.fujieid.jap.oidc;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 17:12
* @see <a href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata" target="_blank">3. OpenID Provider Metadata</a>
* @since 1.0.0
*/
......
......@@ -22,7 +22,6 @@ import com.fujieid.jap.core.JapConfig;
import com.fujieid.jap.core.JapUserService;
import com.fujieid.jap.core.exception.JapOauth2Exception;
import com.fujieid.jap.core.store.JapUserStore;
import com.fujieid.jap.core.store.SessionJapUserStore;
import com.fujieid.jap.oauth2.OAuthConfig;
import com.fujieid.jap.oauth2.Oauth2Strategy;
......@@ -36,7 +35,6 @@ import javax.servlet.http.HttpServletResponse;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 16:27
* @see <a href="https://openid.net/specs/openid-connect-core-1_0.html" target="_blank">OpenID Connect Core 1.0 incorporating errata set 1</a>
* @since 1.0.0
*/
......@@ -56,6 +54,7 @@ public class OidcStrategy extends Oauth2Strategy {
* `Strategy` constructor.
*
* @param japUserService japUserService
* @param japUserStore japUserStore
* @param japConfig japConfig
*/
public OidcStrategy(JapUserService japUserService, JapUserStore japUserStore, JapConfig japConfig) {
......@@ -81,8 +80,8 @@ public class OidcStrategy extends Oauth2Strategy {
OidcDiscoveryDto discoveryDto = OidcUtil.getOidcDiscovery(issuer);
oidcConfig.setAuthorizationUrl(discoveryDto.getAuthorizationEndpoint())
.setTokenUrl(discoveryDto.getTokenEndpoint())
.setUserinfoUrl(discoveryDto.getUserinfoEndpoint());
.setTokenUrl(discoveryDto.getTokenEndpoint())
.setUserinfoUrl(discoveryDto.getUserinfoEndpoint());
OAuthConfig oAuthConfig = BeanUtil.copyProperties(oidcConfig, OAuthConfig.class);
super.authenticate(oAuthConfig, request, response);
......
......@@ -27,7 +27,6 @@ import java.util.Map;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2020/12/3 14:13
* @since 1.0.0
*/
public class OidcUtil {
......
......@@ -19,7 +19,6 @@
* as well as to obtain basic profile information about the End-User in an interoperable and REST-like manner.
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @date 2021/1/18 16:19
* @version 1.0.0
* @see <a href="https://openid.net/specs/openid-connect-core-1_0.html" target="_blank">OpenID Connect Core 1.0 incorporating errata set 1</a>
* @since 1.0.0
......
......@@ -26,7 +26,6 @@ import java.io.Serializable;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/12 11:25
* @since 1.0.0
*/
public class JapAuthenticationDetails implements Serializable {
......
......@@ -18,7 +18,6 @@ package com.fujieid.jap.simple;
/**
* @author harrylee (harryleexyz(a)qq.com)
* @version 1.0.0
* @date 2021/1/24 18:57
* @since 1.0.0
*/
public class RememberMeDetails {
......
......@@ -26,7 +26,6 @@ import static com.fujieid.jap.core.JapConst.DEFAULT_DELIMITER;
/**
* @author harrylee (harryleexyz(a)qq.com)
* @version 1.0.0
* @date 2021/1/24 19:12
* @since 1.0.0
*/
public class RememberMeDetailsUtils {
......@@ -35,7 +34,7 @@ public class RememberMeDetailsUtils {
*
* @param simpleConfig config
* @param username username
* @return
* @return RememberMeDetails
*/
public static RememberMeDetails encode(SimpleConfig simpleConfig, String username) {
long expiryTime = System.currentTimeMillis() + simpleConfig.getRememberMeCookieExpire();
......@@ -55,7 +54,7 @@ public class RememberMeDetailsUtils {
*
* @param simpleConfig config
* @param cookieValue cookie value
* @return
* @return RememberMeDetails
*/
public static RememberMeDetails decode(SimpleConfig simpleConfig, String cookieValue) {
if (!simpleConfig.isEnableRememberMe()) {
......
......@@ -25,7 +25,6 @@ import static com.fujieid.jap.core.JapConst.DEFAULT_CREDENTIAL_ENCRYPT_SALT;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 18:02
* @since 1.0.0
*/
public class SimpleConfig extends AuthenticateConfig {
......
......@@ -36,7 +36,6 @@ import javax.servlet.http.HttpServletResponse;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/11 17:53
* @since 1.0.0
*/
public class SimpleStrategy extends AbstractJapStrategy {
......@@ -55,6 +54,7 @@ public class SimpleStrategy extends AbstractJapStrategy {
* `Strategy` constructor.
*
* @param japUserService japUserService
* @param japUserStore japUserStore
* @param japConfig japConfig
*/
public SimpleStrategy(JapUserService japUserService, JapUserStore japUserStore, JapConfig japConfig) {
......
......@@ -18,7 +18,6 @@ package com.fujieid.jap.simple;
/**
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/17 15:21
* @since 1.0.0
*/
public class UsernamePasswordCredential {
......
......@@ -30,7 +30,7 @@ import java.util.Set;
/**
* Processing JustAuth Request
* <p></p>
*
* <p>1. {@link JustAuthRequestContext#register(String, AuthRequest)}, manual registration and automatic registration</p>
* <p>2. {@link JustAuthRequestContext#loadRequest(String[], String[])}, automatic registration</p>
* <p>3. {@link JustAuthRequestContext#getRequest(String, SocialConfig, AuthConfig, AuthStateCache)}, obtaining the actual AuthRequest</p>
......@@ -38,7 +38,6 @@ import java.util.Set;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/12 12:43
* @since 1.0.0
*/
public class JustAuthRequestContext {
......
......@@ -22,7 +22,6 @@ import com.fujieid.jap.core.AuthenticateConfig;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/12 13:00
* @since 1.0.0
*/
public class SocialConfig extends AuthenticateConfig {
......
......@@ -47,7 +47,6 @@ import java.util.Map;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/12 12:08
* @since 1.0.0
*/
public class SocialStrategy extends AbstractJapStrategy {
......@@ -68,6 +67,7 @@ public class SocialStrategy extends AbstractJapStrategy {
* `Strategy` constructor.
*
* @param japUserService japUserService
* @param japUserStore japUserStore
* @param japConfig japConfig
*/
public SocialStrategy(JapUserService japUserService, JapUserStore japUserStore, JapConfig japConfig) {
......@@ -80,6 +80,8 @@ public class SocialStrategy extends AbstractJapStrategy {
* please refer to: https://justauth.wiki/features/customize-the-state-cache.html
*
* @param japUserService Required, implement user operations
* @param japUserStore Required
* @param japConfig Required, jap config
* @param authStateCache Optional, custom cache implementation class
*/
public SocialStrategy(JapUserService japUserService, JapUserStore japUserStore, JapConfig japConfig, AuthStateCache authStateCache) {
......
......@@ -18,7 +18,6 @@
* and support the automatic creation of login account
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @date 2021/1/12 12:01
* @version 1.0.0
* @since 1.0.0
*/
......
......@@ -29,7 +29,6 @@ import javax.servlet.http.HttpServletResponse;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021-01-20 16:01
* @since 1.0.0
*/
public class JapSsoHelper {
......@@ -114,7 +113,6 @@ public class JapSsoHelper {
* Kisso Single sign-on service abstract implementation class
*
* @author YongWu zheng
* @date 2021-01-23 13:50
* @since 1.0.0
*/
static class JapConfigurableAbstractKissoService extends ConfigurableAbstractKissoService {
......@@ -129,7 +127,6 @@ public class JapSsoHelper {
* kisso SSO helper
*
* @author YongWu zheng
* @date 2021-01-23 14:10
* @since 1.0.0
*/
static class KiSsoHelper extends SSOHelper {
......
......@@ -20,7 +20,6 @@ package com.fujieid.jap.sso.config;
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @version 1.0.0
* @date 2021/1/18 12:17
* @since 1.0.0
*/
public class JapSsoConfig {
......
......@@ -18,7 +18,6 @@
* support the same domain and cross domain single sign on
*
* @author yadong.zhang (yadong.zhang0415(a)gmail.com)
* @date 2021/1/18 12:17
* @version 1.0.0
* @since 1.0.0
*/
......
......@@ -122,7 +122,6 @@
</dependency>
</dependencies>
<build>
<finalName>${project.artifactId}-${project.version}</finalName>
<plugins>
......@@ -183,6 +182,7 @@
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>release</id>
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册