Package sonia.scm.repository.api

Class HookContext

java.lang.Object

sonia.scm.repository.api.HookContext

public final class HookContext
extends Object

The context for all repository hooks. With the HookContext class it is able to send messages back to the client, retrieve Changesets which are added during this push/commit and gives information about changed branches and tags.

Since:

1.33

Method Summary

Modifier and Type	Method	Description
HookBranchProvider	getBranchProvider()	Returns a HookBranchProvider which is able to return information about changed branches during the current hook.
HookChangesetBuilder	getChangesetProvider()	Returns a HookChangesetBuilder which is able to return all Changeset's during this push/commit.
HookMergeDetectionProvider	getMergeDetectionProvider()	Returns a HookMergeDetectionProvider which is able to check whether two branches have been merged with the incoming changesets.
HookMessageProvider	getMessageProvider()	Returns a HookMessageProvider which is able to send message back to the scm client.
HookModificationsProvider	getModificationsProvider()	Returns a HookChangesetBuilder which is able to return all Changeset's during this push/commit.
HookTagProvider	getTagProvider()	Returns a HookTagProvider which is able to return informations about changed tags during the current hook.
boolean	isFeatureSupported(HookFeature feature)	Returns true if the underlying provider support the requested feature.

Methods inherited from class java.lang.Object

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

Method Details

getBranchProvider

public HookBranchProvider getBranchProvider()

Returns a HookBranchProvider which is able to return information about changed branches during the current hook.

Returns:

HookBranchProvider

Throws:

HookFeatureIsNotSupportedException - if the feature is not supported by the underlying provider

Since:

1.45

getTagProvider

public HookTagProvider getTagProvider()

Returns a HookTagProvider which is able to return informations about changed tags during the current hook.

Returns:

HookTagProvider

Throws:

HookFeatureIsNotSupportedException - if the feature is not supported by the underlying provider

Since:

1.50

getChangesetProvider

public HookChangesetBuilder getChangesetProvider()

Returns a HookChangesetBuilder which is able to return all Changeset's during this push/commit.

Returns:

HookChangesetBuilder

Throws:

HookFeatureIsNotSupportedException - if the feature is not supported by the underlying provider

getModificationsProvider

public HookModificationsProvider getModificationsProvider()

Returns a HookChangesetBuilder which is able to return all Changeset's during this push/commit.

Returns:

HookChangesetBuilder

Throws:

HookFeatureIsNotSupportedException - if the feature is not supported by the underlying provider

getMessageProvider

public HookMessageProvider getMessageProvider()

Returns a HookMessageProvider which is able to send message back to the scm client. Note: The HookMessageProvider is only available if the underlying HookContextProvider supports the handling of messages and the hook is executed synchronous.

Returns:

HookMessageProvider which is able to send message back to the scm client

Throws:

HookFeatureIsNotSupportedException - if the feature is not supported by the underlying provider

getMergeDetectionProvider

public HookMergeDetectionProvider getMergeDetectionProvider()

Returns a HookMergeDetectionProvider which is able to check whether two branches have been merged with the incoming changesets.

Returns:

HookMergeDetectionProvider which is able to detect merges.

Throws:

HookFeatureIsNotSupportedException - if the feature is not supported by the underlying provider

isFeatureSupported

public boolean isFeatureSupported(HookFeature feature)

Returns true if the underlying provider support the requested feature.

Parameters:

feature - feature to check if it is supported

Returns:

true if the feature is supported