Interface RequestAuthorizationFilter
-
- All Superinterfaces:
Comparable<RequestAuthorizationFilter>
@SupportedAll public interface RequestAuthorizationFilter extends Comparable<RequestAuthorizationFilter>
Extension filter that will be called before request authorization and after request authorization.Implementations of this interface can use the Guice setter based injection.
- Since:
- 13.0.0
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default void
afterFailedAuthorization(ResourceSetDescription resource, PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope)
Invoked after a failed request authorization attempt.default void
afterFailedAuthorization(PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope)
Invoked after a failed request authorization attempt.default void
afterSuccessfulAuthorization(ResourceSetDescription resource, PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope, Set<String> grantedScope)
Invoked after a successful request authorization attempt.default void
afterSuccessfulAuthorization(PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope, Set<String> grantedScope)
Invoked after a successful request authorization attempt.default void
beforeAuthorization(ResourceSetDescription resource, PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope)
Invoked before authorization of the request is attempted.default void
beforeAuthorization(PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope)
Invoked before authorization of the request is attempted.-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Method Detail
-
beforeAuthorization
default void beforeAuthorization(ResourceSetDescription resource, PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope) throws org.forgerock.oauth2.restlet.UmaException
Invoked before authorization of the request is attempted.- Parameters:
resource
- The UMA resource that the ticket is requesting access to.permissionTicket
- The permission ticket associated with the authorization request.requestingParty
- The requesting party.resourceOwner
- The resource owner.requestedScope
- The scope that is being requested.- Throws:
org.forgerock.oauth2.restlet.UmaException
- If authorization of the request should not be attempted.
-
beforeAuthorization
default void beforeAuthorization(PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope) throws org.forgerock.oauth2.restlet.UmaException
Invoked before authorization of the request is attempted.- Parameters:
permissionTicket
- The permission ticket associated with the authorization request.requestingParty
- The requesting party.resourceOwner
- The resource owner.requestedScope
- The scope that is being requested.- Throws:
org.forgerock.oauth2.restlet.UmaException
- If authorization of the request should not be attempted.
-
afterSuccessfulAuthorization
default void afterSuccessfulAuthorization(ResourceSetDescription resource, PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope, Set<String> grantedScope)
Invoked after a successful request authorization attempt.- Parameters:
resource
- The UMA resource that the ticket has access to.permissionTicket
- The permission ticket associated with the authorization request.requestingParty
- The requesting party.resourceOwner
- The resource owner.requestedScope
- The scope that was requested.grantedScope
- The scope that was granted.
-
afterSuccessfulAuthorization
default void afterSuccessfulAuthorization(PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope, Set<String> grantedScope)
Invoked after a successful request authorization attempt.- Parameters:
permissionTicket
- The permission ticket associated with the authorization request.requestingParty
- The requesting party.resourceOwner
- The resource owner.requestedScope
- The scope that was requested.grantedScope
- The scope that was granted.
-
afterFailedAuthorization
default void afterFailedAuthorization(ResourceSetDescription resource, PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope)
Invoked after a failed request authorization attempt.- Parameters:
resource
- The UMA resource that the ticket is denied access to.permissionTicket
- The permission ticket associated with the authorization request.requestingParty
- The requesting party.resourceOwner
- The resource owner.requestedScope
- The scope that was requested.
-
afterFailedAuthorization
default void afterFailedAuthorization(PermissionTicket permissionTicket, Subject requestingParty, Subject resourceOwner, Set<String> requestedScope)
Invoked after a failed request authorization attempt.- Parameters:
permissionTicket
- The permission ticket associated with the authorization request.requestingParty
- The requesting party.resourceOwner
- The resource owner.requestedScope
- The scope that was requested.
-
-