@TransactionAware public class

GlobalPermissionGrantRequestedEvent

extends GlobalPermissionEvent
implements PermissionGrantRequestedEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ com.atlassian.bitbucket.event.ApplicationEvent
       ↳ com.atlassian.bitbucket.event.permission.PermissionEvent
         ↳ com.atlassian.bitbucket.event.permission.GlobalPermissionEvent
           ↳ com.atlassian.bitbucket.event.permission.GlobalPermissionGrantRequestedEvent

Class Overview

This event is raised before a user or group are granted a global permission. This event is synchronous, allowing listeners to perform operations in the same database transaction where the permission is granted.

This event is cancelable. A listener may prevent the permission from being granted by canceling this event. Throwing an exception will not prevent the permission from being granted; the exception will be logged and ignored.

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
GlobalPermissionGrantRequestedEvent(Object source, Permission permission, String affectedGroup, ApplicationUser affectedUser, CancelState cancelState)
Public Methods
void cancel(KeyedMessage message)
Cancels the operation, providing a message explaining why.
boolean isCanceled()
Retrieves a flag indicating whether the operation has been canceled.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.event.permission.PermissionEvent
From class com.atlassian.bitbucket.event.ApplicationEvent
From class java.util.EventObject
From class java.lang.Object
From interface com.atlassian.bitbucket.util.CancelState

Public Constructors

public GlobalPermissionGrantRequestedEvent (Object source, Permission permission, String affectedGroup, ApplicationUser affectedUser, CancelState cancelState)

Public Methods

public void cancel (KeyedMessage message)

Cancels the operation, providing a message explaining why.

The cancellation message is required, and should be as descriptive and clear as possible to allow end users to correct, if possible, the issue that triggered cancellation.

Parameters
message a descriptive message explaining why the operation has been canceled

public boolean isCanceled ()

Retrieves a flag indicating whether the operation has been canceled.

In situations where multiple observers have the option to cancel an operation, for example when multiple listeners receive the same CancelableEvent, this flag can be useful for determining that another observer has already canceled the operation.

Returns
  • true if the operation has been canceled; otherwise, false