com.atlassian.bitbucket.event.repository

Class RepositoryDeletionRequestedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.repository.RepositoryEvent

com.atlassian.bitbucket.event.repository.RepositoryDeletionRequestedEvent

All Implemented Interfaces:

CancelableEvent, CancelState, Serializable

public class RepositoryDeletionRequestedEvent
extends RepositoryEvent
implements CancelableEvent

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:

RepositoryService.delete(Repository), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
RepositoryDeletionRequestedEvent(Object source, Repository repository, CancelState cancelState, Iterable<Integer> forkIds)

Method Summary

Modifier and Type	Method and Description
void	cancel(KeyedMessage message) Cancels repository deletion, providing a message explaining why.
Iterable<Integer>	getForkIds()
boolean	isCanceled() Retrieves a flag indicating whether repository deletion has already been canceled by another listener.

Methods inherited from class com.atlassian.bitbucket.event.repository.RepositoryEvent

getRepository

Methods inherited from class com.atlassian.bitbucket.event.ApplicationEvent

getDate, getUser

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RepositoryDeletionRequestedEvent

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

Parameters:

source - the object on which the event initially occurred

repository - repository that was deleted

cancelState - the cancel state

forkIds - IDs of forks

Since:

5.6

Method Detail

cancel

public void cancel(@Nonnull
                   KeyedMessage message)

Cancels repository deletion, providing a message explaining why.

Specified by:

cancel in interface CancelState

Parameters:

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

isCanceled

public boolean isCanceled()

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

Specified by:

isCanceled in interface CancelState

Returns:

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

getForkIds

@Nonnull
public Iterable<Integer> getForkIds()

Returns:

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

Since:

5.6