Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-05-31 09:12:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make all exception classes immutable

Browse Source 
Update all exception classes so that they are fully immutable and cannot
be changed once they have been thrown.

Issue gh-8945
This commit is contained in:
Phillip Webb 2020-07-27 10:01:32 -07:00 committed by Rob Winch
parent a0b9442265
commit 81fe9fc640
5 changed files with 20 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
etc/checkstyle/checkstyle-suppressions.xml
View File

@ -3,13 +3,6 @@
"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
"https://checkstyle.org/dtds/suppressions_1_2.dtd"> "https://checkstyle.org/dtds/suppressions_1_2.dtd">
<suppressions> <suppressions>
<suppress files=".*" checks="JavadocMethod" />
<suppress files=".*" checks="JavadocStyle" />
<suppress files=".*" checks="JavadocTagContinuationIndentation" />
<suppress files=".*" checks="JavadocType" />
<suppress files=".*" checks="JavadocVariable" />
<suppress files=".*" checks="MultipleVariableDeclarations" />
<suppress files=".*" checks="MutableException" />
<suppress files=".*" checks="NeedBraces" /> <suppress files=".*" checks="NeedBraces" />
<suppress files=".*" checks="NestedIfDepth" /> <suppress files=".*" checks="NestedIfDepth" />
<suppress files=".*" checks="NewlineAtEndOfFile" /> <suppress files=".*" checks="NewlineAtEndOfFile" />
@ -32,6 +25,11 @@
<suppress files=".*" checks="SpringTernary" /> <suppress files=".*" checks="SpringTernary" />
<suppress files=".*" checks="WhitespaceAfter" /> <suppress files=".*" checks="WhitespaceAfter" />
<suppress files=".*" checks="WhitespaceAround" /> <suppress files=".*" checks="WhitespaceAround" />
<suppress files=".*" checks="JavadocMethod" />
<suppress files=".*" checks="JavadocStyle" />
<suppress files=".*" checks="JavadocTagContinuationIndentation" />
<suppress files=".*" checks="JavadocType" />
<suppress files=".*" checks="JavadocVariable" />
<!-- Ignore third-party code --> <!-- Ignore third-party code -->
<suppress files="BCrypt\.java|BCryptTests\.java" checks=".*"/> <suppress files="BCrypt\.java|BCryptTests\.java" checks=".*"/>

13
oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2AuthenticationException.java
View File

@ -40,7 +40,7 @@ import org.springframework.util.Assert;
*/ */
public class OAuth2AuthenticationException extends AuthenticationException { public class OAuth2AuthenticationException extends AuthenticationException {
private OAuth2Error error; private final OAuth2Error error;
/** /**
* Constructs an {@code OAuth2AuthenticationException} using the provided parameters. * Constructs an {@code OAuth2AuthenticationException} using the provided parameters.
@ -65,8 +65,7 @@ public class OAuth2AuthenticationException extends AuthenticationException {
* @param message the detail message * @param message the detail message
*/ */
public OAuth2AuthenticationException(OAuth2Error error, String message) { public OAuth2AuthenticationException(OAuth2Error error, String message) {
super(message); this(error, message, null);
this.setError(error);
} }
/** /**
@ -77,7 +76,8 @@ public class OAuth2AuthenticationException extends AuthenticationException {
*/ */
public OAuth2AuthenticationException(OAuth2Error error, String message, Throwable cause) { public OAuth2AuthenticationException(OAuth2Error error, String message, Throwable cause) {
super(message, cause); super(message, cause);
this.setError(error); Assert.notNull(error, "error cannot be null");
this.error = error;
} }
/** /**
@ -88,9 +88,4 @@ public class OAuth2AuthenticationException extends AuthenticationException {
return this.error; return this.error;
} }
private void setError(OAuth2Error error) {
Assert.notNull(error, "error cannot be null");
this.error = error;
}
} }

2
oauth2/oauth2-core/src/main/java/org/springframework/security/oauth2/core/OAuth2AuthorizationException.java
View File

@ -25,7 +25,7 @@ import org.springframework.util.Assert;
*/ */
public class OAuth2AuthorizationException extends RuntimeException { public class OAuth2AuthorizationException extends RuntimeException {
private OAuth2Error error; private final OAuth2Error error;
/** /**
* Constructs an {@code OAuth2AuthorizationException} using the provided parameters. * Constructs an {@code OAuth2AuthorizationException} using the provided parameters.

23
saml2/saml2-service-provider/src/main/java/org/springframework/security/saml2/provider/service/authentication/Saml2AuthenticationException.java
View File

@ -40,7 +40,7 @@ import org.springframework.util.Assert;
*/ */
public class Saml2AuthenticationException extends AuthenticationException { public class Saml2AuthenticationException extends AuthenticationException {
private Saml2Error error; private final Saml2Error error;
/** /**
* Constructs a {@code Saml2AuthenticationException} using the provided parameters. * Constructs a {@code Saml2AuthenticationException} using the provided parameters.
@ -65,8 +65,7 @@ public class Saml2AuthenticationException extends AuthenticationException {
* @param message the detail message * @param message the detail message
*/ */
public Saml2AuthenticationException(Saml2Error error, String message) { public Saml2AuthenticationException(Saml2Error error, String message) {
super(message); this(error, message, null);
this.setError(error);
} }
/** /**
@ -77,7 +76,8 @@ public class Saml2AuthenticationException extends AuthenticationException {
*/ */
public Saml2AuthenticationException(Saml2Error error, String message, Throwable cause) { public Saml2AuthenticationException(Saml2Error error, String message, Throwable cause) {
super(message, cause); super(message, cause);
this.setError(error); Assert.notNull(error, "error cannot be null");
this.error = error;
} }
/** /**
@ -120,8 +120,7 @@ public class Saml2AuthenticationException extends AuthenticationException {
@Deprecated @Deprecated
public Saml2AuthenticationException( public Saml2AuthenticationException(
org.springframework.security.saml2.provider.service.authentication.Saml2Error error, String message) { org.springframework.security.saml2.provider.service.authentication.Saml2Error error, String message) {
super(message); this(error, message, null);
this.setError(error);
} }
/** /**
@ -140,7 +139,8 @@ public class Saml2AuthenticationException extends AuthenticationException {
org.springframework.security.saml2.provider.service.authentication.Saml2Error error, String message, org.springframework.security.saml2.provider.service.authentication.Saml2Error error, String message,
Throwable cause) { Throwable cause) {
super(message, cause); super(message, cause);
this.setError(error); Assert.notNull(error, "error cannot be null");
this.error = new Saml2Error(error.getErrorCode(), error.getDescription());
} }
/** /**
@ -162,15 +162,6 @@ public class Saml2AuthenticationException extends AuthenticationException {
this.error.getErrorCode(), this.error.getDescription()); this.error.getErrorCode(), this.error.getDescription());
} }
private void setError(Saml2Error error) {
Assert.notNull(error, "error cannot be null");
this.error = error;
}
private void setError(org.springframework.security.saml2.provider.service.authentication.Saml2Error error) {
setError(new Saml2Error(error.getErrorCode(), error.getDescription()));
}
@Override @Override
public String toString() { public String toString() {
final StringBuffer sb = new StringBuffer("Saml2AuthenticationException{"); final StringBuffer sb = new StringBuffer("Saml2AuthenticationException{");

6
web/src/test/java/org/springframework/security/web/util/ThrowableAnalyzerTests.java
View File

@ -250,12 +250,12 @@ public class ThrowableAnalyzerTests {
} }
/** /**
* Exception for testing purposes. The cause is not retrievable by {@link #getCause()} * Exception for testing purposes. The cause is not retrievable by
* . * {@link #getCause()}.
*/ */
public static final class NonStandardException extends Exception { public static final class NonStandardException extends Exception {
private Throwable cause; private final Throwable cause;
public NonStandardException(String message, Throwable cause) { public NonStandardException(String message, Throwable cause) {
super(message); super(message);