From 427a187382df352c62b7d031179f50838a5700c6 Mon Sep 17 00:00:00 2001
From: Paul-Christian Volkmer <paul-christian.volkmer@mni.thm.de>
Date: Thu, 25 Oct 2012 21:41:09 +0200
Subject: [PATCH] Coding Standards
---
.../thm/arsnova/CASLogoutSuccessHandler.java | 31 ++++++++++---------
.../de/thm/arsnova/CasUserDetailsService.java | 15 ++++++---
.../LoginAuthenticationFailureHandler.java | 13 ++++----
.../LoginAuthenticationSucessHandler.java | 8 +++--
.../thm/arsnova/OpenidUserDetailsService.java | 17 +++++++---
.../thm/arsnova/annotation/package-info.java | 2 ++
.../thm/arsnova/aop/AuthorizationAdviser.java | 20 ++++++------
.../java/de/thm/arsnova/aop/package-info.java | 2 ++
.../thm/arsnova/controller/package-info.java | 1 +
.../java/de/thm/arsnova/dao/package-info.java | 1 +
.../de/thm/arsnova/entities/package-info.java | 1 +
.../thm/arsnova/exceptions/package-info.java | 1 +
.../java/de/thm/arsnova/package-info.java | 2 ++
.../de/thm/arsnova/services/package-info.java | 1 +
.../arsnova/socket/message/package-info.java | 1 +
.../de/thm/arsnova/socket/package-info.java | 1 +
16 files changed, 74 insertions(+), 43 deletions(-)
create mode 100644 src/main/java/de/thm/arsnova/annotation/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/aop/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/controller/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/dao/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/entities/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/exceptions/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/services/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/socket/message/package-info.java
create mode 100644 src/main/java/de/thm/arsnova/socket/package-info.java
diff --git a/src/main/java/de/thm/arsnova/CASLogoutSuccessHandler.java b/src/main/java/de/thm/arsnova/CASLogoutSuccessHandler.java
index 94f194957..013ddc1d8 100644
--- a/src/main/java/de/thm/arsnova/CASLogoutSuccessHandler.java
+++ b/src/main/java/de/thm/arsnova/CASLogoutSuccessHandler.java
@@ -15,8 +15,7 @@ import org.springframework.security.web.authentication.logout.LogoutSuccessHandl
public class CASLogoutSuccessHandler implements LogoutSuccessHandler {
- public static final Logger logger = LoggerFactory
- .getLogger(CASLogoutSuccessHandler.class);
+ public static final Logger LOGGER = LoggerFactory.getLogger(CASLogoutSuccessHandler.class);
private String casUrl;
private String defaultTarget;
@@ -24,26 +23,28 @@ public class CASLogoutSuccessHandler implements LogoutSuccessHandler {
private RedirectStrategy redirectStrategy = new DefaultRedirectStrategy();
@Override
- public void onLogoutSuccess(HttpServletRequest request,
- HttpServletResponse response, Authentication authentication)
- throws IOException, ServletException {
-
+ public final void onLogoutSuccess(
+ final HttpServletRequest request,
+ final HttpServletResponse response,
+ final Authentication authentication
+ ) throws IOException, ServletException {
String referer = request.getHeader("referer");
if (response.isCommitted()) {
- logger.info("Response has already been committed. Unable to redirect to target");
+ LOGGER.info("Response has already been committed. Unable to redirect to target");
return;
}
- redirectStrategy.sendRedirect(request, response,
- (casUrl + "/logout?url=")
- + (referer != null ? referer : defaultTarget));
-
+ redirectStrategy.sendRedirect(
+ request,
+ response,
+ (casUrl + "/logout?url=") + (referer != null ? referer : defaultTarget)
+ );
}
- public void setCasUrl(String casUrl) {
- this.casUrl = casUrl;
+ public final void setCasUrl(final String newCasUrl) {
+ casUrl = newCasUrl;
}
- public void setDefaultTarget(String defaultTarget) {
- this.defaultTarget = defaultTarget;
+ public final void setDefaultTarget(final String newDefaultTarget) {
+ defaultTarget = newDefaultTarget;
}
}
diff --git a/src/main/java/de/thm/arsnova/CasUserDetailsService.java b/src/main/java/de/thm/arsnova/CasUserDetailsService.java
index 0321ad42f..7ad909d2b 100644
--- a/src/main/java/de/thm/arsnova/CasUserDetailsService.java
+++ b/src/main/java/de/thm/arsnova/CasUserDetailsService.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2012 THM webMedia
- *
+ *
* This file is part of ARSnova.
*
* ARSnova is free software: you can redistribute it and/or modify
@@ -34,11 +34,18 @@ public class CasUserDetailsService extends
AbstractCasAssertionUserDetailsService {
@Override
- protected UserDetails loadUserDetails(Assertion assertion) {
+ protected final UserDetails loadUserDetails(final Assertion assertion) {
final List<GrantedAuthority> grantedAuthorities = new ArrayList<GrantedAuthority>();
grantedAuthorities.add(new GrantedAuthorityImpl("ROLE_USER"));
- return new User(assertion.getPrincipal().getName(), "", true, true,
- true, true, grantedAuthorities);
+ return new User(
+ assertion.getPrincipal().getName(),
+ "",
+ true,
+ true,
+ true,
+ true,
+ grantedAuthorities
+ );
}
}
diff --git a/src/main/java/de/thm/arsnova/LoginAuthenticationFailureHandler.java b/src/main/java/de/thm/arsnova/LoginAuthenticationFailureHandler.java
index 2aa584cd3..72770e629 100644
--- a/src/main/java/de/thm/arsnova/LoginAuthenticationFailureHandler.java
+++ b/src/main/java/de/thm/arsnova/LoginAuthenticationFailureHandler.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2012 THM webMedia
- *
+ *
* This file is part of ARSnova.
*
* ARSnova is free software: you can redistribute it and/or modify
@@ -37,10 +37,11 @@ public class LoginAuthenticationFailureHandler extends
private String defaultFailureUrl;
@Override
- public void onAuthenticationFailure(HttpServletRequest request,
- HttpServletResponse response, AuthenticationException exception)
- throws IOException, ServletException {
-
+ public final void onAuthenticationFailure(
+ final HttpServletRequest request,
+ final HttpServletResponse response,
+ final AuthenticationException exception
+ ) throws IOException, ServletException {
HttpSession session = request.getSession();
if (session != null && session.getAttribute("ars-referer") != null) {
defaultFailureUrl = (String) session.getAttribute("ars-referer");
@@ -49,7 +50,7 @@ public class LoginAuthenticationFailureHandler extends
redirectStrategy.sendRedirect(request, response, defaultFailureUrl);
}
- public void setDefaultFailureUrl(String defaultFailureUrl) {
+ public final void setDefaultFailureUrl(final String defaultFailureUrl) {
this.defaultFailureUrl = defaultFailureUrl;
}
diff --git a/src/main/java/de/thm/arsnova/LoginAuthenticationSucessHandler.java b/src/main/java/de/thm/arsnova/LoginAuthenticationSucessHandler.java
index cc920e401..11ea77fb6 100644
--- a/src/main/java/de/thm/arsnova/LoginAuthenticationSucessHandler.java
+++ b/src/main/java/de/thm/arsnova/LoginAuthenticationSucessHandler.java
@@ -30,8 +30,10 @@ public class LoginAuthenticationSucessHandler extends
private String targetUrl;
@Override
- protected String determineTargetUrl(HttpServletRequest request,
- HttpServletResponse response) {
+ protected final String determineTargetUrl(
+ final HttpServletRequest request,
+ final HttpServletResponse response
+ ) {
HttpSession session = request.getSession();
if (session == null || session.getAttribute("ars-referer") == null) {
return targetUrl;
@@ -40,7 +42,7 @@ public class LoginAuthenticationSucessHandler extends
return referer + targetUrl;
}
- public void setTargetUrl(String targetUrl) {
+ public final void setTargetUrl(final String targetUrl) {
this.targetUrl = targetUrl;
}
}
diff --git a/src/main/java/de/thm/arsnova/OpenidUserDetailsService.java b/src/main/java/de/thm/arsnova/OpenidUserDetailsService.java
index 4cebf78dd..aca25f32e 100644
--- a/src/main/java/de/thm/arsnova/OpenidUserDetailsService.java
+++ b/src/main/java/de/thm/arsnova/OpenidUserDetailsService.java
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2012 THM webMedia
- *
+ *
* This file is part of ARSnova.
*
* ARSnova is free software: you can redistribute it and/or modify
@@ -31,11 +31,18 @@ import org.springframework.stereotype.Service;
@Service
public class OpenidUserDetailsService implements UserDetailsService {
- public UserDetails loadUserByUsername(String openIdIdentifier) {
+ public final UserDetails loadUserByUsername(final String openIdIdentifier) {
final List<GrantedAuthority> grantedAuthorities = new ArrayList<GrantedAuthority>();
grantedAuthorities.add(new GrantedAuthorityImpl("ROLE_USER"));
- return new User(openIdIdentifier, "", true, true, true, true,
- grantedAuthorities);
+ return new User(
+ openIdIdentifier,
+ "",
+ true,
+ true,
+ true,
+ true,
+ grantedAuthorities
+ );
}
-}
\ No newline at end of file
+}
diff --git a/src/main/java/de/thm/arsnova/annotation/package-info.java b/src/main/java/de/thm/arsnova/annotation/package-info.java
new file mode 100644
index 000000000..f833d0350
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/annotation/package-info.java
@@ -0,0 +1,2 @@
+package de.thm.arsnova.annotation;
+
diff --git a/src/main/java/de/thm/arsnova/aop/AuthorizationAdviser.java b/src/main/java/de/thm/arsnova/aop/AuthorizationAdviser.java
index 6dcd3a253..bc41e8690 100644
--- a/src/main/java/de/thm/arsnova/aop/AuthorizationAdviser.java
+++ b/src/main/java/de/thm/arsnova/aop/AuthorizationAdviser.java
@@ -13,36 +13,36 @@ public class AuthorizationAdviser {
private static IUserService userService;
- public void setUserService(IUserService uService) {
+ public final void setUserService(final IUserService uService) {
userService = uService;
}
/**
* This method checks if the user has a valid authorization from security
* context
- *
+ *
* @param authenticated
* @param object
*/
@Before("execution(public * de.thm.arsnova.services.*.*(..)) && @annotation(authenticated) && this(object)")
- public void checkAuthorization(Authenticated authenticated, Object object) {
+ public final void checkAuthorization(final Authenticated authenticated, final Object object) {
User u = userService.getCurrentUser();
- if (u == null)
+ if (u == null) {
throw new UnauthorizedException();
- // TODO: For unauthorized users e.g. after logout there is still a user
- // object with username 'anonymous'
- if (u.getUsername().equals("anonymous"))
+ }
+ if (u.getUsername().equals("anonymous")) {
throw new UnauthorizedException();
+ }
}
/**
* This method checks if the user is enlisted in current ARSnova session
- *
+ *
* @param authenticated
* @param object
*/
@Before("execution(public * de.thm.arsnova.services.*.*(..)) && @annotation(authenticated) && this(object)")
- public void checkSessionMembership(Authenticated authenticated, Object object) {
- // TODO: Implement check based on session membership lists
+ public final void checkSessionMembership(final Authenticated authenticated, final Object object) {
+ /// TODO: Implement check based on session membership lists
}
}
diff --git a/src/main/java/de/thm/arsnova/aop/package-info.java b/src/main/java/de/thm/arsnova/aop/package-info.java
new file mode 100644
index 000000000..698958d60
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/aop/package-info.java
@@ -0,0 +1,2 @@
+package de.thm.arsnova.aop;
+
diff --git a/src/main/java/de/thm/arsnova/controller/package-info.java b/src/main/java/de/thm/arsnova/controller/package-info.java
new file mode 100644
index 000000000..ab9a862ae
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/controller/package-info.java
@@ -0,0 +1 @@
+package de.thm.arsnova.controller;
diff --git a/src/main/java/de/thm/arsnova/dao/package-info.java b/src/main/java/de/thm/arsnova/dao/package-info.java
new file mode 100644
index 000000000..2dcb75c6d
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/dao/package-info.java
@@ -0,0 +1 @@
+package de.thm.arsnova.dao;
\ No newline at end of file
diff --git a/src/main/java/de/thm/arsnova/entities/package-info.java b/src/main/java/de/thm/arsnova/entities/package-info.java
new file mode 100644
index 000000000..f9851140e
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/entities/package-info.java
@@ -0,0 +1 @@
+package de.thm.arsnova.entities;
\ No newline at end of file
diff --git a/src/main/java/de/thm/arsnova/exceptions/package-info.java b/src/main/java/de/thm/arsnova/exceptions/package-info.java
new file mode 100644
index 000000000..609e11692
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/exceptions/package-info.java
@@ -0,0 +1 @@
+package de.thm.arsnova.exceptions;
\ No newline at end of file
diff --git a/src/main/java/de/thm/arsnova/package-info.java b/src/main/java/de/thm/arsnova/package-info.java
new file mode 100644
index 000000000..30e6d4288
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/package-info.java
@@ -0,0 +1,2 @@
+package de.thm.arsnova;
+
diff --git a/src/main/java/de/thm/arsnova/services/package-info.java b/src/main/java/de/thm/arsnova/services/package-info.java
new file mode 100644
index 000000000..12742b6cb
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/services/package-info.java
@@ -0,0 +1 @@
+package de.thm.arsnova.services;
\ No newline at end of file
diff --git a/src/main/java/de/thm/arsnova/socket/message/package-info.java b/src/main/java/de/thm/arsnova/socket/message/package-info.java
new file mode 100644
index 000000000..b4bdfaaea
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/socket/message/package-info.java
@@ -0,0 +1 @@
+package de.thm.arsnova.socket.message;
\ No newline at end of file
diff --git a/src/main/java/de/thm/arsnova/socket/package-info.java b/src/main/java/de/thm/arsnova/socket/package-info.java
new file mode 100644
index 000000000..4c7eda994
--- /dev/null
+++ b/src/main/java/de/thm/arsnova/socket/package-info.java
@@ -0,0 +1 @@
+package de.thm.arsnova.socket;
\ No newline at end of file
--
GitLab