Module org.kohsuke.github.api

Package org.kohsuke.github.extras.authorization

Class JWTTokenProvider

java.lang.Object

org.kohsuke.github.extras.authorization.JWTTokenProvider

All Implemented Interfaces:

AuthorizationProvider

public class JWTTokenProvider
extends Object
implements AuthorizationProvider

A authorization provider that gives valid JWT tokens. These tokens are then used to create a time-based token to authenticate as an application. This token provider does not provide any kind of caching, and will always request a new token to the API.

Field Summary

Fields inherited from interface org.kohsuke.github.authorization.AuthorizationProvider

ANONYMOUS

Constructor Summary

Constructors

Constructor	Description
JWTTokenProvider(String applicationId, File keyFile)	Create a JWTTokenProvider
JWTTokenProvider(String applicationId, String keyString)	Create a JWTTokenProvider
JWTTokenProvider(String applicationId, Path keyPath)	Create a JWTTokenProvider
JWTTokenProvider(String applicationId, PrivateKey privateKey)	Create a JWTTokenProvider

Method Summary

Modifier and Type	Method	Description
String	getEncodedAuthorization()	Returns the credentials to be used with a given request.

Methods inherited from class java.lang.Object

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

Constructor Details

JWTTokenProvider

public JWTTokenProvider(String applicationId,
 File keyFile)
                 throws GeneralSecurityException,
IOException

Create a JWTTokenProvider

Parameters:

applicationId - the application id

keyFile - the key file

Throws:

GeneralSecurityException - when an error occurs

IOException - when an error occurs

JWTTokenProvider

public JWTTokenProvider(String applicationId,
 Path keyPath)
                 throws GeneralSecurityException,
IOException

Create a JWTTokenProvider

Parameters:

applicationId - the application id

keyPath - the key path

Throws:

GeneralSecurityException - when an error occurs

IOException - when an error occurs

JWTTokenProvider

public JWTTokenProvider(String applicationId,
 String keyString)
                 throws GeneralSecurityException

Create a JWTTokenProvider

Parameters:

applicationId - the application id

keyString - the key string

Throws:

GeneralSecurityException - when an error occurs

JWTTokenProvider

public JWTTokenProvider(String applicationId,
 PrivateKey privateKey)

Create a JWTTokenProvider

Parameters:

applicationId - the application id

privateKey - the private key

Method Details

getEncodedAuthorization

public String getEncodedAuthorization()
                               throws IOException

Returns the credentials to be used with a given request. As an example, a authorization provider for a bearer token will return something like:

 
 @Override
 public String getEncodedAuthorization() {
     return "Bearer myBearerToken";
 }
 
 

Specified by:

getEncodedAuthorization in interface AuthorizationProvider

Returns:

encoded authorization string, can be null

Throws:

IOException - on any error that prevents the provider from returning a valid authorization