com.atlassian.bitbucket.hook

Interface HookRequestHandle

All Superinterfaces:

AutoCloseable, Closeable

public interface HookRequestHandle
extends AutoCloseable, Closeable

A handle on the hook request which provides the required information to make a successful callback to Stash via their hook callback socket

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENV_HOOK_ADDRESS The environment variable to be set in order to provide the getHostAddress() socket bind address} to external processes.
static String	ENV_HOOK_CALLBACK The environment variable to be set in order to provide the callback scripts location to external processes.
static String	ENV_HOOK_COORDINATOR The environment variable to be set in order to provide the coordinator scripts location to external processes.
static String	ENV_HOOK_PORT The environment variable to be set in order to provide the port number to external processes.
static String	ENV_HOOK_REQUEST_ID The environment variable to be set in order to provide the getRequestId() hook request id} to external processes.

Method Summary

Modifier and Type	Method and Description
void	close() Indicate that the SCM provider has finished with the hook request.
File	getCallbackScript()
File	getCoordinatorScript()
String	getHostAddress()
int	getPort()
String	getRequestId()
boolean	isAccepted()
boolean	isCalled()

Field Detail

ENV_HOOK_CALLBACK

static final String ENV_HOOK_CALLBACK

The environment variable to be set in order to provide the callback scripts location to external processes.

See Also:

Constant Field Values

ENV_HOOK_COORDINATOR

static final String ENV_HOOK_COORDINATOR

The environment variable to be set in order to provide the coordinator scripts location to external processes.

See Also:

Constant Field Values

ENV_HOOK_ADDRESS

static final String ENV_HOOK_ADDRESS

The environment variable to be set in order to provide the getHostAddress() socket bind address} to external processes.

See Also:

Constant Field Values

ENV_HOOK_PORT

static final String ENV_HOOK_PORT

The environment variable to be set in order to provide the port number to external processes.

See Also:

Constant Field Values

ENV_HOOK_REQUEST_ID

static final String ENV_HOOK_REQUEST_ID

The environment variable to be set in order to provide the getRequestId() hook request id} to external processes.

See Also:

Constant Field Values

Method Detail

close

void close()

Indicate that the SCM provider has finished with the hook request. This allows the host application to cleanup any references it is maintaining

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getCallbackScript

@Nonnull
File getCallbackScript()

Returns:

the absolute location of the callback script Stash provides which handles communication with callback socket. SCM implementers do not have to use this but it is provided for convenience.

getCoordinatorScript

@Nonnull
File getCoordinatorScript()

Returns:

the absolute location of the coordinator script Stash provides which handles iterating through a list of scripts in a directory. SCM implementers do not have to use this but it is provided for convenience.

getHostAddress

@Nonnull
String getHostAddress()

Returns:

the host address to the hook callback socket is bound to. This is most likely localhost.

getPort

int getPort()

Returns:

the port the hook callback socket is bound to. This is a randomly allocated port number

getRequestId

@Nonnull
String getRequestId()

Returns:

the request id to identify the callback. This is securely generated

isAccepted

boolean isAccepted()

Returns:

whether the hook request was accepted

isCalled

boolean isCalled()

Returns:

whether any hooks have called back into the server