com.atlassian.bitbucket.hook.repository

Class PreRepositoryHookContext

java.lang.Object

com.atlassian.bitbucket.hook.repository.RepositoryHookContext

com.atlassian.bitbucket.hook.repository.PreRepositoryHookContext

public abstract class PreRepositoryHookContext
extends RepositoryHookContext

RepositoryHookContext specialization that is provided to PreRepositoryHook hooks

Since:

5.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PreRepositoryHookContext(com.atlassian.bitbucket.setting.Settings settings)

Method Summary

Modifier and Type	Method and Description
abstract boolean	registerCommitCallback(PreRepositoryHookCommitCallback 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

PreRepositoryHookContext

protected PreRepositoryHookContext(@Nonnull
                                   com.atlassian.bitbucket.setting.Settings settings)

Method Detail

registerCommitCallback

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

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

Note: hooks may only register callbacks during PreRepositoryHook.preUpdate(PreRepositoryHookContext, RepositoryHookRequest). If a callback is registered at any other time, false is returned and the callback is ignored.

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