com.atlassian.bitbucket.hook

Interface HookRequest

public interface HookRequest

Represents a SCM hook request. Hooks call back into the application providing:

• the hook identifier (e.g. git-pre-receive)
• the environment variables set by the SCM
• any arguments provided to the hook
• any remaining input

Method Summary

Modifier and Type	Method and Description
List<String>	getArguments()
default Map<String,String>	getEnvironment()
String	getHookName()
CharSequence	getInput()

Method Detail

getArguments

@Nonnull
List<String> getArguments()

Returns:

the list of arguments provided by the SCM hook callback

getEnvironment

@Nonnull
default Map<String,String> getEnvironment()

Returns:

the environment variables set by the SCM when the hook was run

Since:

4.13

getHookName

@Nullable
String getHookName()

Returns:

the hook-identifier provided by the SCM hook callback

getInput

@Nonnull
CharSequence getInput()

Returns:

the remainder of the input provided by the SCM hook callback