com.atlassian.bitbucket.event.attachment

Class AttachmentSaveRequestedEvent

java.lang.Object

java.util.EventObject

com.atlassian.bitbucket.event.ApplicationEvent

com.atlassian.bitbucket.event.attachment.AttachmentEvent

com.atlassian.bitbucket.event.attachment.AttachmentSaveRequestedEvent

All Implemented Interfaces:

CancelableEvent, CancelState, Serializable

@TransactionAware(value=IMMEDIATE)
public class AttachmentSaveRequestedEvent
extends AttachmentEvent
implements CancelableEvent

Raised just before an attachment is added. This event is synchronous, allowing listeners to perform operations in the same database transaction where the attachment will be deleted.

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

Since:

7.0

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
AttachmentSaveRequestedEvent(Object source, Repository repository, Attachment attachment, CancelState cancelState) Construct a new AttachmentEvent.

Method Summary

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

Methods inherited from class com.atlassian.bitbucket.event.attachment.AttachmentEvent

getAttachment, 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

AttachmentSaveRequestedEvent

public AttachmentSaveRequestedEvent(@Nonnull
                                    Object source,
                                    @Nonnull
                                    Repository repository,
                                    @Nonnull
                                    Attachment attachment,
                                    @Nonnull
                                    CancelState cancelState)

Construct a new AttachmentEvent.

Parameters:

source - the component raising the event

repository - the repository

attachment - the attachment

Method Detail

cancel

public void cancel(@Nonnull
                   KeyedMessage message)

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

Specified by:

isCanceled in interface CancelState

Returns:

true if another listener has already canceled attachment addition; otherwise false