org.kohsuke.github

Class GitHubBuilder

java.lang.Object

org.kohsuke.github.GitHubBuilder

public class GitHubBuilder
extends Object

Since:

1.59

Constructor Summary

Constructors

Constructor and Description
GitHubBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
GitHub	build()
static GitHubBuilder	fromCredentials() First check if the credentials are configured using the ~/.github properties file.
static GitHubBuilder	fromEnvironment() Creates GitHubBuilder by picking up coordinates from environment variables.
static GitHubBuilder	fromEnvironment(String loginVariableName, String passwordVariableName, String oauthVariableName) Deprecated. Use fromEnvironment() to pick up standard set of environment variables, so that different clients of this library will all recognize one consistent set of coordinates.
static GitHubBuilder	fromEnvironment(String loginVariableName, String passwordVariableName, String oauthVariableName, String endpointVariableName) Deprecated. Use fromEnvironment() to pick up standard set of environment variables, so that different clients of this library will all recognize one consistent set of coordinates.
static GitHubBuilder	fromProperties(Properties props)
static GitHubBuilder	fromPropertyFile()
static GitHubBuilder	fromPropertyFile(String propertyFileName)
GitHubBuilder	withConnector(HttpConnector connector)
GitHubBuilder	withEndpoint(String endpoint)
GitHubBuilder	withOAuthToken(String oauthToken)
GitHubBuilder	withOAuthToken(String oauthToken, String user)
GitHubBuilder	withPassword(String user, String password)
GitHubBuilder	withProxy(Proxy p) Configures connector that uses HTTP library in JRE but use a specific proxy, instead of the system default one.
GitHubBuilder	withRateLimitHandler(RateLimitHandler handler)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitHubBuilder

public GitHubBuilder()

Method Detail

fromCredentials

public static GitHubBuilder fromCredentials()
                                     throws IOException

First check if the credentials are configured using the ~/.github properties file. If no user is specified it means there is no configuration present so check the environment instead. If there is still no user it means there are no credentials defined and throw an IOException.

Returns:

the configured Builder from credentials defined on the system or in the environment.

Throws:

IOException - If there are no credentials defined in the ~/.github properties file or the process environment.

fromEnvironment

public static GitHubBuilder fromEnvironment(String loginVariableName,
                            String passwordVariableName,
                            String oauthVariableName)
                                     throws IOException

Deprecated. Use fromEnvironment() to pick up standard set of environment variables, so that different clients of this library will all recognize one consistent set of coordinates.

Throws:

IOException

fromEnvironment

public static GitHubBuilder fromEnvironment(String loginVariableName,
                            String passwordVariableName,
                            String oauthVariableName,
                            String endpointVariableName)
                                     throws IOException

Deprecated. Use fromEnvironment() to pick up standard set of environment variables, so that different clients of this library will all recognize one consistent set of coordinates.

Throws:

IOException

fromEnvironment

public static GitHubBuilder fromEnvironment()
                                     throws IOException

Creates GitHubBuilder by picking up coordinates from environment variables.

The following environment variables are recognized:

• GITHUB_LOGIN: username like 'kohsuke'
• GITHUB_PASSWORD: raw password
• GITHUB_OAUTH: OAuth token to login
• GITHUB_ENDPOINT: URL of the API endpoint

See class javadoc for the relationship between these coordinates.

For backward compatibility, the following environment variables are recognized but discouraged: login, password, oauth

Throws:

IOException

fromPropertyFile

public static GitHubBuilder fromPropertyFile()
                                      throws IOException

Throws:

IOException

fromPropertyFile

public static GitHubBuilder fromPropertyFile(String propertyFileName)
                                      throws IOException

Throws:

IOException

fromProperties

public static GitHubBuilder fromProperties(Properties props)

withEndpoint

public GitHubBuilder withEndpoint(String endpoint)

withPassword

public GitHubBuilder withPassword(String user,
                         String password)

withOAuthToken

public GitHubBuilder withOAuthToken(String oauthToken)

withOAuthToken

public GitHubBuilder withOAuthToken(String oauthToken,
                           String user)

withConnector

public GitHubBuilder withConnector(HttpConnector connector)

withRateLimitHandler

public GitHubBuilder withRateLimitHandler(RateLimitHandler handler)

withProxy

public GitHubBuilder withProxy(Proxy p)

Configures connector that uses HTTP library in JRE but use a specific proxy, instead of the system default one.

build

public GitHub build()
             throws IOException

Throws:

IOException