diff --git a/para-core/src/main/java-templates/com/erudika/para/utils/Version.java b/para-core/src/main/java-templates/com/erudika/para/utils/Version.java index 6124e938..2a5b2a0e 100644 --- a/para-core/src/main/java-templates/com/erudika/para/utils/Version.java +++ b/para-core/src/main/java-templates/com/erudika/para/utils/Version.java @@ -30,6 +30,8 @@ public final class Version { private static final String GIT_BRANCH = "${scmBranch}"; private static final String REVISION = "${buildNumber}"; + private Version() { } + public static String getVersion() { return VERSION; } diff --git a/para-server/src/main/java/com/erudika/para/server/ParaServer.java b/para-server/src/main/java/com/erudika/para/server/ParaServer.java index 3c965be8..8bc9fed4 100644 --- a/para-server/src/main/java/com/erudika/para/server/ParaServer.java +++ b/para-server/src/main/java/com/erudika/para/server/ParaServer.java @@ -234,6 +234,7 @@ public int getOrder() { } /** + * Filter. * @return API servlet bean */ @Bean @@ -249,6 +250,7 @@ public ServletRegistrationBean apiV1RegistrationBean() { } /** + * Filter. * @return GZIP filter bean */ @Bean @@ -265,6 +267,7 @@ public FilterRegistrationBean gzipFilterRegistrationBean() { } /** + * Filter. * @return CORS filter bean */ @Bean @@ -287,6 +290,7 @@ public FilterRegistrationBean corsFilterRegistrationBean() { } /** + * Jetty config. * @return Jetty config bean */ @Bean diff --git a/para-server/src/main/java/com/erudika/para/server/aop/AOPModule.java b/para-server/src/main/java/com/erudika/para/server/aop/AOPModule.java index 8a47a799..fe27c000 100644 --- a/para-server/src/main/java/com/erudika/para/server/aop/AOPModule.java +++ b/para-server/src/main/java/com/erudika/para/server/aop/AOPModule.java @@ -28,6 +28,12 @@ */ public class AOPModule extends AbstractModule { + /** + * Default constructor. + */ + public AOPModule() { + } + protected void configure() { // enable automatic indexing and caching each time an object is created/updated IndexAndCacheAspect coreAspect = new IndexAndCacheAspect(); diff --git a/para-server/src/main/java/com/erudika/para/server/aop/IndexAndCacheAspect.java b/para-server/src/main/java/com/erudika/para/server/aop/IndexAndCacheAspect.java index 0cb6ddce..12ac1f79 100644 --- a/para-server/src/main/java/com/erudika/para/server/aop/IndexAndCacheAspect.java +++ b/para-server/src/main/java/com/erudika/para/server/aop/IndexAndCacheAspect.java @@ -17,17 +17,18 @@ */ package com.erudika.para.server.aop; -import com.erudika.para.core.listeners.IOListener; -import com.erudika.para.core.utils.Para; +import com.erudika.para.core.ParaObject; import com.erudika.para.core.annotations.Cached; import com.erudika.para.core.annotations.Indexed; import com.erudika.para.core.cache.Cache; -import com.erudika.para.core.ParaObject; +import com.erudika.para.core.listeners.IOListener; import com.erudika.para.core.metrics.Metrics; import com.erudika.para.core.persistence.DAO; import com.erudika.para.core.search.Search; +import com.erudika.para.core.utils.Para; import com.erudika.para.core.utils.Utils; import com.erudika.para.core.validation.ValidationUtils; +import jakarta.inject.Inject; import java.lang.reflect.Method; import java.lang.reflect.Modifier; import java.util.ArrayList; @@ -38,7 +39,6 @@ import java.util.Map; import java.util.Set; import java.util.stream.Collectors; -import jakarta.inject.Inject; import org.aopalliance.intercept.MethodInterceptor; import org.aopalliance.intercept.MethodInvocation; import org.slf4j.Logger; @@ -62,6 +62,13 @@ public class IndexAndCacheAspect implements MethodInterceptor { private Cache cache; /** + * Constructor. + */ + public IndexAndCacheAspect() { + } + + /** + * getter/setter. * @return {@link Search} */ public Search getSearch() { @@ -69,6 +76,7 @@ public Search getSearch() { } /** + * getter/setter. * @param search {@link Search} */ @Inject @@ -77,6 +85,7 @@ public void setSearch(Search search) { } /** + * getter/setter. * @return {@link Cache} */ public Cache getCache() { @@ -84,6 +93,7 @@ public Cache getCache() { } /** + * getter/setter. * @param cache {@link Cache} */ @Inject diff --git a/para-server/src/main/java/com/erudika/para/server/cache/CacheModule.java b/para-server/src/main/java/com/erudika/para/server/cache/CacheModule.java index 61410669..11bb7731 100644 --- a/para-server/src/main/java/com/erudika/para/server/cache/CacheModule.java +++ b/para-server/src/main/java/com/erudika/para/server/cache/CacheModule.java @@ -29,6 +29,12 @@ */ public class CacheModule extends AbstractModule { + /** + * Constructor. + */ + public CacheModule() { + } + protected void configure() { String selectedCache = Para.getConfig().cachePlugin(); if (StringUtils.isBlank(selectedCache) || "inmemory".equalsIgnoreCase(selectedCache)) { diff --git a/para-server/src/main/java/com/erudika/para/server/email/EmailModule.java b/para-server/src/main/java/com/erudika/para/server/email/EmailModule.java index 6b6702e1..bd3a1117 100644 --- a/para-server/src/main/java/com/erudika/para/server/email/EmailModule.java +++ b/para-server/src/main/java/com/erudika/para/server/email/EmailModule.java @@ -29,6 +29,12 @@ */ public class EmailModule extends AbstractModule { + /** + * Constructor. + */ + public EmailModule() { + } + protected void configure() { String selectedEmailer = Para.getConfig().emailerPlugin(); if (StringUtils.isBlank(selectedEmailer)) { diff --git a/para-server/src/main/java/com/erudika/para/server/email/NoopEmailer.java b/para-server/src/main/java/com/erudika/para/server/email/NoopEmailer.java index b429d533..65e2bf02 100644 --- a/para-server/src/main/java/com/erudika/para/server/email/NoopEmailer.java +++ b/para-server/src/main/java/com/erudika/para/server/email/NoopEmailer.java @@ -31,6 +31,12 @@ public class NoopEmailer implements Emailer { private static final Logger logger = LoggerFactory.getLogger(NoopEmailer.class); + /** + * Constructor. + */ + public NoopEmailer() { + } + @Override public boolean sendEmail(List emails, String subject, String body) { logger.info("EMAIL SENT: {}, {}, {}", emails, subject, body); diff --git a/para-server/src/main/java/com/erudika/para/server/queue/LocalQueue.java b/para-server/src/main/java/com/erudika/para/server/queue/LocalQueue.java index b317fd41..4ca9b10b 100644 --- a/para-server/src/main/java/com/erudika/para/server/queue/LocalQueue.java +++ b/para-server/src/main/java/com/erudika/para/server/queue/LocalQueue.java @@ -21,17 +21,17 @@ import com.erudika.para.core.queue.MockQueue; import com.erudika.para.core.queue.Queue; import com.erudika.para.core.utils.Para; +import jakarta.inject.Singleton; import java.util.ArrayList; import java.util.List; import java.util.concurrent.ConcurrentLinkedQueue; import java.util.concurrent.Future; -import jakarta.inject.Singleton; import org.apache.commons.lang3.StringUtils; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * + * Local queue impl. * @author Alex Bogdanovski [alex@erudika.com] */ @Singleton @@ -54,6 +54,7 @@ public LocalQueue() { } /** + * getter/setter. * @param name name */ public LocalQueue(String name) { diff --git a/para-server/src/main/java/com/erudika/para/server/rest/Api1.java b/para-server/src/main/java/com/erudika/para/server/rest/Api1.java index d4c684d9..9be0ee2e 100644 --- a/para-server/src/main/java/com/erudika/para/server/rest/Api1.java +++ b/para-server/src/main/java/com/erudika/para/server/rest/Api1.java @@ -381,6 +381,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param app {@link App} * @param type a type * @return response @@ -414,6 +415,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @return response */ public static Inflector linksHandler() { @@ -459,6 +461,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @return response */ public static Inflector meHandler() { @@ -497,6 +500,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @return response */ public static Inflector readIdHandler() { @@ -513,6 +517,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @return response */ public static Inflector configOptionsHandler() { @@ -535,6 +540,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -556,6 +562,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -583,6 +590,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -605,6 +613,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -626,6 +635,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -646,6 +656,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -687,6 +698,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -714,6 +726,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -824,6 +837,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @param type a type * @return response @@ -838,6 +852,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @param type a type * @return response @@ -857,6 +872,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @param type a type * @return response @@ -876,6 +892,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @param type a type * @return response @@ -891,6 +908,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @param type a type * @return response @@ -907,6 +925,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -920,6 +939,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -933,6 +953,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -959,6 +980,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -972,6 +994,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param app {@link App} * @param type a type * @return response @@ -996,6 +1019,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @return response */ public static Inflector reindexHandler() { @@ -1022,6 +1046,7 @@ public Response apply(ContainerRequestContext ctx) { } /** + * Api method. * @param a {@link App} * @return response */ @@ -1067,6 +1092,7 @@ public void write(OutputStream os) throws IOException, WebApplicationException { } /** + * Api method. * @param a {@link App} * @return response */ diff --git a/para-server/src/main/java/com/erudika/para/server/security/JWTAuthentication.java b/para-server/src/main/java/com/erudika/para/server/security/JWTAuthentication.java index 33fd288e..f86b63f4 100644 --- a/para-server/src/main/java/com/erudika/para/server/security/JWTAuthentication.java +++ b/para-server/src/main/java/com/erudika/para/server/security/JWTAuthentication.java @@ -40,6 +40,7 @@ public JWTAuthentication(AuthenticatedUserDetails principal) { } /** + * getter/setter. * @param jwt token * @return this */ @@ -49,6 +50,7 @@ public JWTAuthentication withJWT(SignedJWT jwt) { } /** + * getter/setter. * @param app {@link App} * @return this */ @@ -58,6 +60,7 @@ public JWTAuthentication withApp(App app) { } /** + * getter/setter. * @return the JWT token */ public SignedJWT getJwt() { @@ -65,6 +68,7 @@ public SignedJWT getJwt() { } /** + * getter/setter. * @return the {@link App} */ public App getApp() { diff --git a/para-server/src/main/java/com/erudika/para/server/security/JWTRestfulAuthFilter.java b/para-server/src/main/java/com/erudika/para/server/security/JWTRestfulAuthFilter.java index d5cf3873..c225de89 100644 --- a/para-server/src/main/java/com/erudika/para/server/security/JWTRestfulAuthFilter.java +++ b/para-server/src/main/java/com/erudika/para/server/security/JWTRestfulAuthFilter.java @@ -333,6 +333,7 @@ private void setFilterProcessesUrl(String filterProcessesUrl) { } /** + * getter/setter. * @return auth manager */ protected AuthenticationManager getAuthenticationManager() { @@ -340,6 +341,7 @@ protected AuthenticationManager getAuthenticationManager() { } /** + * getter/setter. * @param authenticationManager auth manager */ public void setAuthenticationManager(AuthenticationManager authenticationManager) { @@ -352,6 +354,7 @@ public void afterPropertiesSet() { } /** + * getter/setter. * @return auth filter */ public FacebookAuthFilter getFacebookAuth() { @@ -359,6 +362,7 @@ public FacebookAuthFilter getFacebookAuth() { } /** + * getter/setter. * @param facebookAuth auth filter */ @Inject @@ -367,6 +371,7 @@ public void setFacebookAuth(FacebookAuthFilter facebookAuth) { } /** + * getter/setter. * @return auth filter */ public GoogleAuthFilter getGoogleAuth() { @@ -374,6 +379,7 @@ public GoogleAuthFilter getGoogleAuth() { } /** + * getter/setter. * @param googleAuth auth filter */ @Inject @@ -382,6 +388,7 @@ public void setGoogleAuth(GoogleAuthFilter googleAuth) { } /** + * getter/setter. * @return auth filter */ public GitHubAuthFilter getGithubAuth() { @@ -389,6 +396,7 @@ public GitHubAuthFilter getGithubAuth() { } /** + * getter/setter. * @param githubAuth auth filter */ @Inject @@ -397,6 +405,7 @@ public void setGithubAuth(GitHubAuthFilter githubAuth) { } /** + * getter/setter. * @return auth filter */ public LinkedInAuthFilter getLinkedinAuth() { @@ -404,6 +413,7 @@ public LinkedInAuthFilter getLinkedinAuth() { } /** + * getter/setter. * @param linkedinAuth auth filter */ @Inject @@ -412,6 +422,7 @@ public void setLinkedinAuth(LinkedInAuthFilter linkedinAuth) { } /** + * getter/setter. * @return auth filter */ public TwitterAuthFilter getTwitterAuth() { @@ -419,6 +430,7 @@ public TwitterAuthFilter getTwitterAuth() { } /** + * getter/setter. * @param twitterAuth auth filter */ @Inject @@ -427,6 +439,7 @@ public void setTwitterAuth(TwitterAuthFilter twitterAuth) { } /** + * getter/setter. * @return auth filter */ public MicrosoftAuthFilter getMicrosoftAuth() { @@ -434,6 +447,7 @@ public MicrosoftAuthFilter getMicrosoftAuth() { } /** + * getter/setter. * @param microsoftAuth auth filter */ @Inject @@ -442,6 +456,7 @@ public void setMicrosoftAuth(MicrosoftAuthFilter microsoftAuth) { } /** + * getter/setter. * @return auth filter */ public SlackAuthFilter getSlackAuth() { @@ -449,6 +464,7 @@ public SlackAuthFilter getSlackAuth() { } /** + * getter/setter. * @param slackAuth auth filter */ @Inject @@ -457,6 +473,7 @@ public void setSlackAuth(SlackAuthFilter slackAuth) { } /** + * getter/setter. * @return auth filter */ public AmazonAuthFilter getAmazonAuth() { @@ -464,6 +481,7 @@ public AmazonAuthFilter getAmazonAuth() { } /** + * getter/setter. * @param amazonAuth auth filter */ @Inject @@ -472,6 +490,7 @@ public void setAmazonAuth(AmazonAuthFilter amazonAuth) { } /** + * getter/setter. * @return auth filter */ public GenericOAuth2Filter getGenericOAuth2Auth() { @@ -479,6 +498,7 @@ public GenericOAuth2Filter getGenericOAuth2Auth() { } /** + * getter/setter. * @param oauthAuth auth filter */ @Inject @@ -487,6 +507,7 @@ public void setGenericOAuth2Auth(GenericOAuth2Filter oauthAuth) { } /** + * getter/setter. * @return auth filter */ public LdapAuthFilter getLdapAuth() { @@ -494,6 +515,7 @@ public LdapAuthFilter getLdapAuth() { } /** + * getter/setter. * @param ldapAuth auth filter */ @Inject @@ -502,6 +524,7 @@ public void setLdapAuth(LdapAuthFilter ldapAuth) { } /** + * getter/setter. * @return auth filter */ public PasswordAuthFilter getPasswordAuth() { @@ -509,6 +532,7 @@ public PasswordAuthFilter getPasswordAuth() { } /** + * getter/setter. * @param passwordAuth auth filter */ @Inject @@ -517,6 +541,7 @@ public void setPasswordAuth(PasswordAuthFilter passwordAuth) { } /** + * getter/setter. * @return auth filter */ public PasswordlessAuthFilter getPasswordlessAuth() { @@ -524,6 +549,7 @@ public PasswordlessAuthFilter getPasswordlessAuth() { } /** + * getter/setter. * @param passwordlessAuth auth filter */ @Inject @@ -532,6 +558,7 @@ public void setPasswordlessAuth(PasswordlessAuthFilter passwordlessAuth) { } /** + * getter/setter. * @return auth filter */ public SAMLAuthFilter getSamlAuth() { @@ -539,6 +566,7 @@ public SAMLAuthFilter getSamlAuth() { } /** + * getter/setter. * @param samlAuth auth filter */ @Inject diff --git a/para-server/src/main/java/com/erudika/para/server/security/JwtConfigurer.java b/para-server/src/main/java/com/erudika/para/server/security/JwtConfigurer.java index d69c5927..85d97735 100644 --- a/para-server/src/main/java/com/erudika/para/server/security/JwtConfigurer.java +++ b/para-server/src/main/java/com/erudika/para/server/security/JwtConfigurer.java @@ -26,11 +26,17 @@ import org.springframework.security.web.authentication.www.BasicAuthenticationFilter; /** - * + * JwtConfigurer. * @author Alex Bogdanovski [alex@erudika.com] */ public class JwtConfigurer extends AbstractHttpConfigurer { + /** + * Constructor. + */ + public JwtConfigurer() { + } + @Override public void configure(HttpSecurity builder) throws Exception { AuthenticationManager authenticationManager = builder.getSharedObject(AuthenticationManager.class); diff --git a/para-server/src/main/java/com/erudika/para/server/security/SecurityModule.java b/para-server/src/main/java/com/erudika/para/server/security/SecurityModule.java index 61c82de7..decadf48 100644 --- a/para-server/src/main/java/com/erudika/para/server/security/SecurityModule.java +++ b/para-server/src/main/java/com/erudika/para/server/security/SecurityModule.java @@ -62,6 +62,7 @@ protected void configure() { } /** + * getter/setter. * @return handler */ @Provides @@ -76,6 +77,7 @@ public SimpleAuthenticationSuccessHandler getSuccessHandler() { } /** + * getter/setter. * @param successHandler handler */ public void setSuccessHandler(SimpleAuthenticationSuccessHandler successHandler) { @@ -83,6 +85,7 @@ public void setSuccessHandler(SimpleAuthenticationSuccessHandler successHandler) } /** + * getter/setter. * @return handler */ @Provides @@ -95,6 +98,7 @@ public SimpleAuthenticationFailureHandler getFailureHandler() { } /** + * getter/setter. * @param failureHandler handler */ public void setFailureHandler(SimpleAuthenticationFailureHandler failureHandler) { @@ -102,6 +106,7 @@ public void setFailureHandler(SimpleAuthenticationFailureHandler failureHandler) } /** + * getter/setter. * @return filter */ @Provides @@ -115,6 +120,7 @@ public PasswordAuthFilter getPasswordFilter() { } /** + * getter/setter. * @param passwordFilter filter */ public void setPasswordFilter(PasswordAuthFilter passwordFilter) { @@ -122,6 +128,7 @@ public void setPasswordFilter(PasswordAuthFilter passwordFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -135,6 +142,7 @@ public PasswordlessAuthFilter getPasswordlessFilter() { } /** + * getter/setter. * @param passwordlessFilter filter */ public void setPasswordlessFilter(PasswordlessAuthFilter passwordlessFilter) { @@ -142,6 +150,7 @@ public void setPasswordlessFilter(PasswordlessAuthFilter passwordlessFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -155,6 +164,7 @@ public FacebookAuthFilter getFacebookFilter() { } /** + * getter/setter. * @param facebookFilter filter */ public void setFacebookFilter(FacebookAuthFilter facebookFilter) { @@ -162,6 +172,7 @@ public void setFacebookFilter(FacebookAuthFilter facebookFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -175,6 +186,7 @@ public GoogleAuthFilter getGoogleFilter() { } /** + * getter/setter. * @param googleFilter filter */ public void setGoogleFilter(GoogleAuthFilter googleFilter) { @@ -182,6 +194,7 @@ public void setGoogleFilter(GoogleAuthFilter googleFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -195,6 +208,7 @@ public LinkedInAuthFilter getLinkedinFilter() { } /** + * getter/setter. * @param linkedinFilter filter */ public void setLinkedinFilter(LinkedInAuthFilter linkedinFilter) { @@ -202,6 +216,7 @@ public void setLinkedinFilter(LinkedInAuthFilter linkedinFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -215,6 +230,7 @@ public TwitterAuthFilter getTwitterFilter() { } /** + * getter/setter. * @param twitterFilter filter */ public void setTwitterFilter(TwitterAuthFilter twitterFilter) { @@ -222,6 +238,7 @@ public void setTwitterFilter(TwitterAuthFilter twitterFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -235,6 +252,7 @@ public GitHubAuthFilter getGithubFilter() { } /** + * getter/setter. * @param githubFilter filter */ public void setGithubFilter(GitHubAuthFilter githubFilter) { @@ -242,6 +260,7 @@ public void setGithubFilter(GitHubAuthFilter githubFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -255,6 +274,7 @@ public MicrosoftAuthFilter getMicrosoftFilter() { } /** + * getter/setter. * @param microsoftFilter filter */ public void setMicrosoftFilter(MicrosoftAuthFilter microsoftFilter) { @@ -262,6 +282,7 @@ public void setMicrosoftFilter(MicrosoftAuthFilter microsoftFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -275,6 +296,7 @@ public SlackAuthFilter getSlackFilter() { } /** + * getter/setter. * @param slackFilter filter */ public void setSlackFilter(SlackAuthFilter slackFilter) { @@ -282,6 +304,7 @@ public void setSlackFilter(SlackAuthFilter slackFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -295,6 +318,7 @@ public AmazonAuthFilter getAmazonFilter() { } /** + * getter/setter. * @param amazonFilter filter */ public void setAmazonFilter(AmazonAuthFilter amazonFilter) { @@ -302,6 +326,7 @@ public void setAmazonFilter(AmazonAuthFilter amazonFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -315,6 +340,7 @@ public GenericOAuth2Filter getGenericOAuth2Filter() { } /** + * getter/setter. * @param oauth2Filter filter */ public void setGenericOAuth2Filter(GenericOAuth2Filter oauth2Filter) { @@ -322,6 +348,7 @@ public void setGenericOAuth2Filter(GenericOAuth2Filter oauth2Filter) { } /** + * getter/setter. * @return filter */ @Provides @@ -335,6 +362,7 @@ public LdapAuthFilter getLdapAuthFilter() { } /** + * getter/setter. * @param ldapFilter filter */ public void setLdapAuthFilter(LdapAuthFilter ldapFilter) { @@ -342,6 +370,7 @@ public void setLdapAuthFilter(LdapAuthFilter ldapFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -355,6 +384,7 @@ public SAMLAuthFilter getSamlAuthFilter() { } /** + * getter/setter. * @param samlFilter filter */ public void setSamlAuthFilter(SAMLAuthFilter samlFilter) { @@ -362,6 +392,7 @@ public void setSamlAuthFilter(SAMLAuthFilter samlFilter) { } /** + * getter/setter. * @return filter */ @Provides @@ -373,6 +404,7 @@ public SAMLMetadataFilter getSamlMetadataFilter() { } /** + * getter/setter. * @param samleMetaFilter filter */ public void setSamlMetadataFilter(SAMLMetadataFilter samleMetaFilter) { diff --git a/para-server/src/main/java/com/erudika/para/server/security/SecurityUtils.java b/para-server/src/main/java/com/erudika/para/server/security/SecurityUtils.java index af56f83e..b6dd62bd 100644 --- a/para-server/src/main/java/com/erudika/para/server/security/SecurityUtils.java +++ b/para-server/src/main/java/com/erudika/para/server/security/SecurityUtils.java @@ -38,6 +38,9 @@ import com.nimbusds.jose.util.Base64URL; import com.nimbusds.jwt.JWTClaimsSet; import com.nimbusds.jwt.SignedJWT; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpSession; +import jakarta.ws.rs.core.HttpHeaders; import java.io.IOException; import java.io.InputStream; import java.text.ParseException; @@ -52,9 +55,6 @@ import java.util.List; import java.util.Map; import java.util.Set; -import jakarta.servlet.http.HttpServletRequest; -import jakarta.servlet.http.HttpSession; -import jakarta.ws.rs.core.HttpHeaders; import org.apache.commons.lang3.StringUtils; import org.apache.commons.lang3.math.NumberUtils; import org.slf4j.Logger; @@ -111,6 +111,7 @@ public static App getAuthenticatedApp() { } /** + * getter. * @return returns the current app associated with the authenticated user */ public static App getAppFromJWTAuthentication() { @@ -125,6 +126,7 @@ public static App getAppFromJWTAuthentication() { } /** + * getter. * @return returns the current app associated with the authenticated user */ public static App getAppFromLdapAuthentication() { @@ -182,6 +184,7 @@ public static boolean checkImplicitAppPermissions(App app, ParaObject object) { } /** + * checker. * @param type some type * @return true if type of object is not "app" */ @@ -442,6 +445,7 @@ public static boolean isValidSignature(HttpServletRequest incoming, String secre } /** + * getter. * @param request HTTP request * @return the URL with the correct protocol, read from X-Forwarded-Proto and CloudFront-Forwarded-Proto headers. */ @@ -471,6 +475,7 @@ public static String getRedirectUrl(HttpServletRequest request) { } /** + * getter. * @param request HTTP request * @return the appid if it's present in either the 'state' or 'appid' query parameters */ @@ -504,6 +509,7 @@ public static String getAppidFromAuthRequest(HttpServletRequest request) { } /** + * getter. * @param app the Para app object * @return a set of host URLs if found in app settings */ @@ -525,6 +531,7 @@ public static Set getHostUrlAliasesForReturn(App app) { } /** + * getter. * @param hostUrlAliases host URL aliases * @param request request * @return a host URL or null diff --git a/para-server/src/main/java/com/erudika/para/server/security/filters/TwitterAuthFilter.java b/para-server/src/main/java/com/erudika/para/server/security/filters/TwitterAuthFilter.java index dec40b9f..656ac634 100644 --- a/para-server/src/main/java/com/erudika/para/server/security/filters/TwitterAuthFilter.java +++ b/para-server/src/main/java/com/erudika/para/server/security/filters/TwitterAuthFilter.java @@ -28,14 +28,14 @@ import com.erudika.para.server.security.SecurityUtils; import com.erudika.para.server.security.UserAuthentication; import com.fasterxml.jackson.databind.ObjectReader; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import jakarta.ws.rs.core.HttpHeaders; import java.io.IOException; import java.io.UnsupportedEncodingException; import java.util.HashMap; import java.util.Map; import java.util.concurrent.TimeUnit; -import jakarta.servlet.http.HttpServletRequest; -import jakarta.servlet.http.HttpServletResponse; -import jakarta.ws.rs.core.HttpHeaders; import org.apache.commons.lang3.StringUtils; import org.apache.hc.client5.http.classic.methods.HttpGet; import org.apache.hc.client5.http.classic.methods.HttpPost; @@ -53,7 +53,7 @@ import org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter; /** - * + * Twitter auth filter. * @author Alex Bogdanovski [alex@erudika.com] */ public class TwitterAuthFilter extends AbstractAuthenticationProcessingFilter { diff --git a/para-server/src/main/java/com/erudika/para/server/utils/GZipResponseUtil.java b/para-server/src/main/java/com/erudika/para/server/utils/GZipResponseUtil.java index d6283609..273a24c0 100644 --- a/para-server/src/main/java/com/erudika/para/server/utils/GZipResponseUtil.java +++ b/para-server/src/main/java/com/erudika/para/server/utils/GZipResponseUtil.java @@ -106,7 +106,7 @@ public static boolean shouldBodyBeZero(HttpServletRequest request, int responseS * @param response the response which will have a header added to it. I.e this method changes its parameter * @throws ServletException Either the response is committed or we were called using the * include method from a - * {@link jakarta.servlet.RequestDispatcher#include(javax.servlet.ServletRequest, jakarta.servlet.ServletResponse)} + * {@link jakarta.servlet.RequestDispatcher#include(jakarta.servlet.ServletRequest, jakarta.servlet.ServletResponse)} * method and the set header is ignored. */ public static void addGzipHeader(final HttpServletResponse response) throws ServletException { diff --git a/para-server/src/main/java/com/erudika/para/server/utils/filters/CachingHttpHeadersFilter.java b/para-server/src/main/java/com/erudika/para/server/utils/filters/CachingHttpHeadersFilter.java index cba27e90..90845aa4 100644 --- a/para-server/src/main/java/com/erudika/para/server/utils/filters/CachingHttpHeadersFilter.java +++ b/para-server/src/main/java/com/erudika/para/server/utils/filters/CachingHttpHeadersFilter.java @@ -17,15 +17,15 @@ */ package com.erudika.para.server.utils.filters; -import jakarta.servlet.http.HttpServletResponse; -import java.io.IOException; -import java.util.concurrent.TimeUnit; import jakarta.servlet.Filter; import jakarta.servlet.FilterChain; import jakarta.servlet.FilterConfig; import jakarta.servlet.ServletException; import jakarta.servlet.ServletRequest; import jakarta.servlet.ServletResponse; +import jakarta.servlet.http.HttpServletResponse; +import java.io.IOException; +import java.util.concurrent.TimeUnit; /** * This filter is used in production, to put HTTP cache headers with a long (1 month) expiration time. @@ -43,6 +43,12 @@ public class CachingHttpHeadersFilter implements Filter { // We consider the last modified date is the start up time of the server private static final long LAST_MODIFIED = System.currentTimeMillis(); + /** + * Constructor. + */ + public CachingHttpHeadersFilter() { + } + @Override public void init(FilterConfig filterConfig) throws ServletException { // Nothing to initialize diff --git a/para-server/src/main/java/com/erudika/para/server/utils/filters/ErrorFilter.java b/para-server/src/main/java/com/erudika/para/server/utils/filters/ErrorFilter.java index 4ae4d656..c384e1f5 100644 --- a/para-server/src/main/java/com/erudika/para/server/utils/filters/ErrorFilter.java +++ b/para-server/src/main/java/com/erudika/para/server/utils/filters/ErrorFilter.java @@ -18,7 +18,6 @@ package com.erudika.para.server.utils.filters; -import java.io.IOException; import jakarta.servlet.Filter; import jakarta.servlet.FilterChain; import jakarta.servlet.FilterConfig; @@ -28,6 +27,7 @@ import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import jakarta.servlet.http.HttpServletResponseWrapper; +import java.io.IOException; import org.slf4j.LoggerFactory; import org.springframework.core.Ordered; import org.springframework.core.annotation.Order; @@ -46,6 +46,12 @@ public class ErrorFilter implements Filter { private static final String ERROR_MESSAGE = "javax.servlet.error.message"; private static final String ERROR_STATUS_CODE = "javax.servlet.error.status_code"; + /** + * Constructor. + */ + public ErrorFilter() { + } + @Override public void init(FilterConfig fc) throws ServletException { } diff --git a/para-server/src/main/java/com/erudika/para/server/utils/filters/FieldFilter.java b/para-server/src/main/java/com/erudika/para/server/utils/filters/FieldFilter.java index 0423e5a6..7f008d20 100644 --- a/para-server/src/main/java/com/erudika/para/server/utils/filters/FieldFilter.java +++ b/para-server/src/main/java/com/erudika/para/server/utils/filters/FieldFilter.java @@ -19,6 +19,12 @@ import com.erudika.para.core.ParaObject; import com.fasterxml.jackson.annotation.JsonIgnore; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.ws.rs.container.ContainerRequestContext; +import jakarta.ws.rs.container.ContainerResponseContext; +import jakarta.ws.rs.container.ContainerResponseFilter; +import jakarta.ws.rs.core.Context; +import jakarta.ws.rs.ext.Provider; import java.beans.PropertyDescriptor; import java.io.IOException; import java.lang.reflect.Method; @@ -27,12 +33,6 @@ import java.util.HashMap; import java.util.List; import java.util.Map; -import jakarta.servlet.http.HttpServletRequest; -import jakarta.ws.rs.container.ContainerRequestContext; -import jakarta.ws.rs.container.ContainerResponseContext; -import jakarta.ws.rs.container.ContainerResponseFilter; -import jakarta.ws.rs.core.Context; -import jakarta.ws.rs.ext.Provider; import org.apache.commons.beanutils.PropertyUtils; import org.apache.commons.lang3.StringUtils; import org.slf4j.LoggerFactory; @@ -48,6 +48,12 @@ public class FieldFilter implements ContainerResponseFilter { @Context private HttpServletRequest request; + /** + * Constructor. + */ + public FieldFilter() { + } + @Override @SuppressWarnings("unchecked") public void filter(ContainerRequestContext requestContext, diff --git a/pom.xml b/pom.xml index c9d5beb3..b8c5e52e 100644 --- a/pom.xml +++ b/pom.xml @@ -190,7 +190,7 @@ org.apache.maven.plugins maven-compiler-plugin - 3.12.1 + 3.13.0 17 -Xlint:-options @@ -257,7 +257,7 @@ org.apache.maven.plugins maven-source-plugin - 3.3.0 + 3.3.1 attach-sources @@ -271,7 +271,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.5.0 + 3.6.3 attach-javadocs @@ -284,6 +284,7 @@ public true true + false true @@ -293,7 +294,7 @@ org.apache.maven.plugins maven-gpg-plugin - 3.2.0 + 3.2.2 sign-artifacts