From 8d096554f86987093b02900dede407ee6824fc98 Mon Sep 17 00:00:00 2001 From: Josh Cummings Date: Mon, 10 Oct 2022 12:26:33 -0600 Subject: [PATCH] Add AuthorizationEvent Closes gh-11972 --- .../event/AuthorizationDeniedEvent.java | 25 +++--- .../event/AuthorizationEvent.java | 76 +++++++++++++++++++ .../event/AuthorizationGrantedEvent.java | 27 +++---- 3 files changed, 98 insertions(+), 30 deletions(-) create mode 100644 core/src/main/java/org/springframework/security/authorization/event/AuthorizationEvent.java diff --git a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationDeniedEvent.java b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationDeniedEvent.java index 0b514fd32f..df964c6196 100644 --- a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationDeniedEvent.java +++ b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationDeniedEvent.java @@ -29,24 +29,21 @@ import org.springframework.security.core.Authentication; * @author Josh Cummings * @since 5.7 */ -public class AuthorizationDeniedEvent extends ApplicationEvent { - - private final Supplier authentication; - - private final AuthorizationDecision decision; +public class AuthorizationDeniedEvent extends AuthorizationEvent { public AuthorizationDeniedEvent(Supplier authentication, T object, AuthorizationDecision decision) { - super(object); - this.authentication = authentication; - this.decision = decision; + super(authentication, object, decision); } - public Supplier getAuthentication() { - return this.authentication; - } - - public AuthorizationDecision getAuthorizationDecision() { - return this.decision; + /** + * Get the object to which access was requested + * @return the object to which access was requested + * @since 5.8 + */ + @Override + @SuppressWarnings("unchecked") + public T getObject() { + return (T) getSource(); } } diff --git a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationEvent.java b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationEvent.java new file mode 100644 index 0000000000..c299bfcc1f --- /dev/null +++ b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationEvent.java @@ -0,0 +1,76 @@ +/* + * Copyright 2002-2022 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.springframework.security.authorization.event; + +import java.util.function.Supplier; + +import org.springframework.context.ApplicationEvent; +import org.springframework.security.authorization.AuthorizationDecision; +import org.springframework.security.core.Authentication; +import org.springframework.util.Assert; + +/** + * A parent class for {@link AuthorizationGrantedEvent} and + * {@link AuthorizationDeniedEvent}. + * + * @author Josh Cummings + * @since 5.8 + */ +public class AuthorizationEvent extends ApplicationEvent { + + private final Supplier authentication; + + private final AuthorizationDecision decision; + + /** + * Construct an {@link AuthorizationEvent} + * @param authentication the principal requiring access + * @param object the object to which access was requested + * @param decision whether authorization was granted or denied + */ + public AuthorizationEvent(Supplier authentication, Object object, AuthorizationDecision decision) { + super(object); + Assert.notNull(authentication, "authentication supplier cannot be null"); + this.authentication = authentication; + this.decision = decision; + } + + /** + * Get the principal requiring access + * @return the principal requiring access + */ + public Supplier getAuthentication() { + return this.authentication; + } + + /** + * Get the object to which access was requested + * @return the object to which access was requested + */ + public Object getObject() { + return getSource(); + } + + /** + * Get the response to the princpal's request + * @return + */ + public AuthorizationDecision getAuthorizationDecision() { + return this.decision; + } + +} diff --git a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationGrantedEvent.java b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationGrantedEvent.java index 4e210214e1..f44bbb391e 100644 --- a/core/src/main/java/org/springframework/security/authorization/event/AuthorizationGrantedEvent.java +++ b/core/src/main/java/org/springframework/security/authorization/event/AuthorizationGrantedEvent.java @@ -21,7 +21,6 @@ import java.util.function.Supplier; import org.springframework.context.ApplicationEvent; import org.springframework.security.authorization.AuthorizationDecision; import org.springframework.security.core.Authentication; -import org.springframework.util.Assert; /** * An {@link ApplicationEvent} which indicates successful authorization. @@ -30,26 +29,22 @@ import org.springframework.util.Assert; * @author Josh Cummings * @since 5.7 */ -public class AuthorizationGrantedEvent extends ApplicationEvent { - - private final Supplier authentication; - - private final AuthorizationDecision decision; +public class AuthorizationGrantedEvent extends AuthorizationEvent { public AuthorizationGrantedEvent(Supplier authentication, T object, AuthorizationDecision decision) { - super(object); - Assert.notNull(authentication, "authentication supplier cannot be null"); - this.authentication = authentication; - this.decision = decision; + super(authentication, object, decision); } - public Supplier getAuthentication() { - return this.authentication; - } - - public AuthorizationDecision getAuthorizationDecision() { - return this.decision; + /** + * Get the object to which access was requested + * @return the object to which access was requested + * @since 5.8 + */ + @Override + @SuppressWarnings("unchecked") + public T getObject() { + return (T) getSource(); } }