public class

ProjectCreationRequestedEvent

extends ProjectEvent
implements CancelableEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ com.atlassian.stash.event.StashEvent
       ↳ com.atlassian.stash.event.ProjectEvent
         ↳ com.atlassian.stash.event.ProjectCreationRequestedEvent

Class Overview

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

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

Note: The project attached to the event will not have an ID, as it has not been created yet. Any listener which would like to create associations based on that ID must listen for the ProjectCreatedEvent instead, which will include it (but will not run in the same transaction).

This event is internally audited with a LOW priority

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
ProjectCreationRequestedEvent(Object source, Project project, CancelState cancelState)
Public Methods
void cancel(KeyedMessage message)
Cancels project creation, providing a message explaining why.
boolean isCanceled()
Retrieves a flag indicating whether project creation has already been canceled by another listener.
[Expand]
Inherited Methods
From class com.atlassian.stash.event.ProjectEvent
From class com.atlassian.stash.event.StashEvent
From class java.util.EventObject
From class java.lang.Object
From interface com.atlassian.stash.util.CancelState

Public Constructors

public ProjectCreationRequestedEvent (Object source, Project project, CancelState cancelState)

Public Methods

public void cancel (KeyedMessage message)

Cancels project creation, providing a message explaining why.

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

public boolean isCanceled ()

Retrieves a flag indicating whether project creation has already been canceled by another listener.

Returns
  • true if another listener has already canceled project creation; otherwise, false