public class

RepositoryDeletionRequestedEvent

extends RepositoryEvent
implements CancelableEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ com.atlassian.bitbucket.event.ApplicationEvent
       ↳ com.atlassian.bitbucket.event.repository.RepositoryEvent
         ↳ com.atlassian.bitbucket.event.repository.RepositoryDeletionRequestedEvent

Class Overview

Raised just before a repository is deleted. This event is synchronous, allowing listeners to perform clean up in the same database transaction where the repository will be deleted.

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

See Also

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
RepositoryDeletionRequestedEvent(Object source, Repository repository, CancelState cancelState)
This constructor is deprecated. in 5.6 for removal in 6.0
RepositoryDeletionRequestedEvent(Object source, Repository repository, CancelState cancelState, Iterable<Integer> forkIds)
Public Methods
void cancel(KeyedMessage message)
Cancels repository deletion, providing a message explaining why.
@Nonnull Iterable<Integer> getForkIds()
boolean isCanceled()
Retrieves a flag indicating whether repository deletion has already been canceled by another listener.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.event.repository.RepositoryEvent
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 RepositoryDeletionRequestedEvent (Object source, Repository repository, CancelState cancelState)

This constructor is deprecated.
in 5.6 for removal in 6.0

public RepositoryDeletionRequestedEvent (Object source, Repository repository, CancelState cancelState, Iterable<Integer> forkIds)

Public Methods

public void cancel (KeyedMessage message)

Cancels repository deletion, providing a message explaining why.

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

@Nonnull public Iterable<Integer> getForkIds ()

Returns
  • the IDs of all repositories that are forks of the repository being deleted

public boolean isCanceled ()

Retrieves a flag indicating whether repository deletion has already been canceled by another listener.

Returns
  • true if another listener has already canceled repository deletion; otherwise, false