Module org.kohsuke.github.api
Package org.kohsuke.github.connector

Interface GitHubConnectorRequest

All Known Implementing Classes:
GitHubRequest
public interface GitHubConnectorRequest
A request passed to GitHubConnector.send(GitHubConnectorRequest) to get a GitHubConnectorResponse. Implementers of GitHubConnector.send(GitHubConnectorRequest) process the information from a GitHubConnectorRequest to open an HTTP connection and retrieve a response. They then return a class that extends GitHubConnectorResponse corresponding their response data. Clients should not implement their own GitHubConnectorRequest. The GitHubConnectorRequest provided by the caller of GitHubConnector.send(GitHubConnectorRequest) should be passed to the constructor of GitHubConnectorResponse.
Author:
Liam Newman

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,List<String>>
    allHeaders()
    All request headers for this request.
    InputStream
    body()
    Gets the request body as an InputStream.
    String
    contentType()
    Get the content type for the body of this request.
    boolean
    hasBody()
    Gets whether the request has information in body() that needs to be sent.
    String
    header(String name)
    Gets the value contained in a header field.
    String
    method()
    The request method for this request.
    URL
    url()
    Gets the url for this request.

  • Method Details

    • allHeaders

      @Nonnull Map<String,List<String>> allHeaders()
      All request headers for this request.
      Returns:
      a map of all headers.

    • body

      @CheckForNull InputStream body()
      Gets the request body as an InputStream.
      Returns:
      the request body as an InputStream.

    • contentType

      @CheckForNull String contentType()
      Get the content type for the body of this request.
      Returns:
      the content type string for the body of this request.

    • hasBody

      boolean hasBody()
      Gets whether the request has information in body() that needs to be sent.
      Returns:
      true, if the body is not null. Otherwise, false.

    • header

      @CheckForNull String header(String name)
      Gets the value contained in a header field.
      Parameters:
      name - the name of the field.
      Returns:
      the value contained in that field, or null if not present.

    • method

      @Nonnull String method()
      The request method for this request. For example, GET or PATCH.
      Returns:
      the request method.

    • url

      @Nonnull URL url()
      Gets the url for this request.
      Returns:
      the url for this request.