public interface

HookRequest

com.atlassian.bitbucket.hook.HookRequest

Class Overview

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

Summary

Public Methods
@Nonnull List<String> getArguments()
@Nonnull Map<StringString> getEnvironment()
@Nullable String getHookName()
@Nonnull CharSequence getInput()

Public Methods

@Nonnull public List<String> getArguments ()

Returns
  • the list of arguments provided by the SCM hook callback

@Nonnull public Map<StringString> getEnvironment ()

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

@Nullable public String getHookName ()

Returns
  • the hook-identifier provided by the SCM hook callback

@Nonnull public CharSequence getInput ()

Returns
  • the remainder of the input provided by the SCM hook callback