public interface

ScmHookDetails

com.atlassian.bitbucket.hook.ScmHookDetails

Class Overview

Describes an SCM hook invocation, providing access to the output and error streams of the remote client

Summary

Public Methods
@Nonnull PrintWriter err()
@Deprecated @Nonnull Map<String, String> getEnvironment()
This method is deprecated. in 5.10 for removal without replacement in 6.0. Starting in 6.0 add-ons will no longer be allowed to directly access repository data on disk. Instead, they will be required to use commands, command builders and other API services to interact with repositories. Since environment variables may reference paths on disk, they will no longer be exposed.
@Nonnull Optional<String> getHookName()
@Nonnull PrintWriter out()

Public Methods

@Nonnull public PrintWriter err ()

Returns
  • a PrintWriter that can be used to output error messages to the remote client.

@Deprecated @Nonnull public Map<String, String> getEnvironment ()

This method is deprecated.
in 5.10 for removal without replacement in 6.0. Starting in 6.0 add-ons will no longer be allowed to directly access repository data on disk. Instead, they will be required to use commands, command builders and other API services to interact with repositories. Since environment variables may reference paths on disk, they will no longer be exposed.

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

@Nonnull public Optional<String> getHookName ()

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

@Nonnull public PrintWriter out ()

Returns
  • a PrintWriter that can be used to output messages to the remote client.