Package com.atlassian.bitbucket.event.repository

Class RepositoryModificationRequestedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.repository.RepositoryEvent

com.atlassian.bitbucket.event.repository.AbstractRepositoryModificationEvent

com.atlassian.bitbucket.event.repository.RepositoryModificationRequestedEvent

All Implemented Interfaces:

CancelableEvent, CancelState, Serializable

public class RepositoryModificationRequestedEvent
extends AbstractRepositoryModificationEvent
implements CancelableEvent

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

When this event is raised, the repository's persisted state has not been updated, so RepositoryEvent.getRepository() matches the old values.

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

See Also:

• RepositoryService.update(RepositoryUpdateRequest)
• Serialized Form

Field Summary

Fields inherited from class com.atlassian.bitbucket.event.repository.AbstractRepositoryModificationEvent

newValue, oldValue

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
RepositoryModificationRequestedEvent(Object source, Repository oldValue, Repository newValue, CancelState cancelState)

Method Summary

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

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

getNewValue, getOldValue, isMoved, isNameChanged, isOriginChanged, isSlugChanged, isStateChanged

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 Details

RepositoryModificationRequestedEvent

public RepositoryModificationRequestedEvent(@Nonnull
 Object source,
 @Nonnull
 Repository oldValue,
 @Nonnull
 Repository newValue,
 @Nonnull
 CancelState cancelState)

Method Details

cancel

public void cancel(@Nonnull
 KeyedMessage message)

Cancels repository modification, 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 modification has already been canceled by another listener.

Specified by:

isCanceled in interface CancelState

Returns:

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