com.atlassian.bitbucket.hook.repository

Class PostRepositoryHookContext

java.lang.Object

com.atlassian.bitbucket.hook.repository.RepositoryHookContext

com.atlassian.bitbucket.hook.repository.PostRepositoryHookContext

public abstract class PostRepositoryHookContext
extends RepositoryHookContext

RepositoryHookContext specialization that is provided to PostRepositoryHook hooks

Since:

5.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PostRepositoryHookContext(com.atlassian.bitbucket.setting.Settings settings, boolean synchronous)

Method Summary

Modifier and Type	Method and Description
boolean	isSynchronous()
abstract boolean	registerCommitCallback(RepositoryHookCommitCallback callback, RepositoryHookCommitFilter filter, RepositoryHookCommitFilter... moreFilters) Registers a callback to receive more information about commits added or removed.

Methods inherited from class com.atlassian.bitbucket.hook.repository.RepositoryHookContext

getSettings

Methods inherited from class java.lang.Object

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

Constructor Detail

PostRepositoryHookContext

protected PostRepositoryHookContext(@Nonnull
                                    com.atlassian.bitbucket.setting.Settings settings,
                                    boolean synchronous)

Method Detail

isSynchronous

public boolean isSynchronous()

Returns:

true if the hook is invoked synchronously, for instance as part of a push to the repository. Only hooks annotated with SynchronousPreferred will be invoked synchronously.

See Also:

SynchronousPreferred

registerCommitCallback

public abstract boolean registerCommitCallback(@Nonnull
                                               RepositoryHookCommitCallback callback,
                                               @Nonnull
                                               RepositoryHookCommitFilter filter,
                                               @Nullable
                                               RepositoryHookCommitFilter... moreFilters)

Registers a callback to receive more information about commits added or removed. See the documentation on RepositoryHookCommitCallback for details about when the callback methods are called.

Parameters:

callback - the callback

filter - the type of commit details the callback is interested in

moreFilters - other types of commit details the callback is interested in

Returns:

true if the callback was successfully registered, otherwise false. If false is returned here, the callback will not be called