net.oauth2.clients.github

Class GithubClient

java.lang.Object

net.oauth2.clients.github.GithubClient

public class GithubClient
extends Object

The sample shows how to obtain a valid token for using Google APIs.

Prerequisites.
You will need a valid OAuth 2.0 client registered in Github Developer Settings > OAuth Applications at https://github.com/settings/applications.
More specifically, you will need 'Client ID', 'Client Secret', 'Authorization callback URL' exactly as specified in the registered application.
Additionally, you will need also API scopes.

Using the sample.
To trigger a token request the sample needs a couple of parameters from your client and apis that you will use with the token (specified above).
You can supply them as environment variables and run the java program or you can supply them interactively in the command line. Mixing the two options is also possible, i.e. supply part of the parameters as environment variables and another part interactively.
The names of the environment variables that you can use to supply the parameters are:

• GITHUB_API_CLIENT_ID: The client ID you received from GitHub when you registered an OAuth Application in Developer Settings in your account.
• GITHUB_API_CLIENT_SECRET: The client Secret
• GITHUB_API_REDIRECT_URI: The Authorization callback URL
• GITHUB_API_SCOPES: A space delimited list of scopes.
• GITHUB_API_AUTHORIZATION_CODE: The authorization code for this client if you have already obtained it by some means

Note, that if you do not provide authorization code via environment variable, the sample will prompt you for any missing parameters required to form a valid request for the code and generate it for you. Use it to obtain and supply the code.

Reference
https://developer.github.com/apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps/

Constructor Summary

Constructors

Constructor and Description
GithubClient()

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

GithubClient

public GithubClient()

Method Detail

main

public static void main(String[] args)
                 throws OAuth2ProtocolException,
                        IOException

Throws:

OAuth2ProtocolException

IOException