org.starchartlabs.calamari.core.auth

Class InstallationAccessToken

java.lang.Object

org.starchartlabs.calamari.core.auth.InstallationAccessToken

All Implemented Interfaces:

java.util.function.Supplier<java.lang.String>

public class InstallationAccessToken
extends java.lang.Object
implements java.util.function.Supplier<java.lang.String>

Represents an access token used to validate web requests to GitHub as a GitHub App installation

Handles logic for exchanging an application key for an installation-specific access token and caching them until invalid, as described in authenticating as a GitHub App

Uses Java Supplier pattern to allow re-generation of tokens as needed

Since:

0.1.0

Constructor Summary

Constructors

Constructor and Description
InstallationAccessToken(java.lang.String installationAccessTokenUrl, ApplicationKey applicationKey, java.lang.String userAgent)
InstallationAccessToken(java.lang.String installationAccessTokenUrl, ApplicationKey applicationKey, java.lang.String userAgent, java.lang.String mediaType)
InstallationAccessToken(java.lang.String installationAccessTokenUrl, ApplicationKey applicationKey, java.lang.String userAgent, java.lang.String mediaType, int cacheExpirationMinutes)

Method Summary

Modifier and Type	Method and Description
static InstallationAccessToken	forRepository(java.lang.String repositoryUrl, ApplicationKey applicationKey, java.lang.String userAgent) Creates an installation access token for the installation on a given repository.
static InstallationAccessToken	forRepository(java.lang.String repositoryUrl, ApplicationKey applicationKey, java.lang.String userAgent, java.lang.String mediaType) Creates an installation access token for the installation on a given repository.
java.lang.String	get()
static java.lang.String	getInstallationUrl(java.lang.String repositoryUrl, ApplicationKey applicationKey, java.lang.String userAgent) Looks up the location of the resource describing the installation for a given repository

Methods inherited from class java.lang.Object

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

Constructor Detail

InstallationAccessToken

public InstallationAccessToken(java.lang.String installationAccessTokenUrl,
                               ApplicationKey applicationKey,
                               java.lang.String userAgent)

Parameters:

installationAccessTokenUrl - URL which represents access token resources for a specific GitHub App installation

applicationKey - Key used to access GitHub web resources as a GitHub App outside an installation context

userAgent - The user agent to make web requests as, as required by GitHub

Since:

0.1.0

InstallationAccessToken

public InstallationAccessToken(java.lang.String installationAccessTokenUrl,
                               ApplicationKey applicationKey,
                               java.lang.String userAgent,
                               java.lang.String mediaType)

Parameters:

installationAccessTokenUrl - URL which represents access token resources for a specific GitHub App installation

applicationKey - Key used to access GitHub web resources as a GitHub App outside an installation context

userAgent - The user agent to make web requests as, as required by GitHub

mediaType - The media type to request from the server via Accept header

Since:

0.2.0

InstallationAccessToken

public InstallationAccessToken(java.lang.String installationAccessTokenUrl,
                               ApplicationKey applicationKey,
                               java.lang.String userAgent,
                               java.lang.String mediaType,
                               int cacheExpirationMinutes)

Parameters:

installationAccessTokenUrl - URL which represents access token resources for a specific GitHub App installation

applicationKey - Key used to access GitHub web resources as a GitHub App outside an installation context

userAgent - The user agent to make web requests as, as required by GitHub

mediaType - The media type to request from the server via Accept header

cacheExpirationMinutes - Number of minutes to cache generated bearer tokens for authentication with GitHub, maximum 60

Since:

0.4.0

Method Detail

get

public java.lang.String get()

Specified by:

get in interface java.util.function.Supplier<java.lang.String>

Returns:

Authorization header value to authenticate as a GitHub App installation

Throws:

KeyLoadingException - If the is an error making the GitHub web request to obtain the access token

Since:

0.1.0

forRepository

public static InstallationAccessToken forRepository(java.lang.String repositoryUrl,
                                                    ApplicationKey applicationKey,
                                                    java.lang.String userAgent)

Creates an installation access token for the installation on a given repository.

Uses the provided applicationKey to read required installation details from GitHub specific to the repository represented at the provided URL

Parameters:

repositoryUrl - The API URL which represents the target repository on GitHub

applicationKey - Application key which allows authentication as a GitHub App in web requests

userAgent - User agent to make repository requests with, as required by GitHub

Returns:

A reference to a renewable access token for authentication as a specific installation in web requests to GitHub

Throws:

RequestLimitExceededException - If the request exceeded the maximum allowed requests to GitHub in a given time period

Since:

0.1.0

forRepository

public static InstallationAccessToken forRepository(java.lang.String repositoryUrl,
                                                    ApplicationKey applicationKey,
                                                    java.lang.String userAgent,
                                                    java.lang.String mediaType)

Creates an installation access token for the installation on a given repository.

Uses the provided applicationKey to read required installation details from GitHub specific to the repository represented at the provided URL

Parameters:

repositoryUrl - The API URL which represents the target repository on GitHub

applicationKey - Application key which allows authentication as a GitHub App in web requests

userAgent - User agent to make repository requests with, as required by GitHub

mediaType - The media type to request from the server via Accept header

Returns:

A reference to a renewable access token for authentication as a specific installation in web requests to GitHub

Throws:

RequestLimitExceededException - If the request exceeded the maximum allowed requests to GitHub in a given time period

Since:

0.1.0

getInstallationUrl

public static java.lang.String getInstallationUrl(java.lang.String repositoryUrl,
                                                  ApplicationKey applicationKey,
                                                  java.lang.String userAgent)

Looks up the location of the resource describing the installation for a given repository

Uses the provided applicationKey to read required installation details from GitHub specific to the repository represented at the provided URL. It is recommended that clients use forRepository(String, ApplicationKey, String) when possible - this call is primarily meant for cases where the URL can be used with caching mechanisms to reduce the total number of calls to GitHub

Parameters:

repositoryUrl - The API URL which represents the target repository on GitHub

applicationKey - Application key which allows authentication as a GitHub App in web requests

userAgent - User agent to make repository requests with, as required by GitHub

Returns:

A reference to a resource describing the installation on the repository

Throws:

RequestLimitExceededException - If the request exceeded the maximum allowed requests to GitHub in a given time period

Since:

0.1.2