Module org.kohsuke.github.api

Package org.kohsuke.github.authorization

Class AnonymousAuthorizationProvider

java.lang.Object

org.kohsuke.github.authorization.AnonymousAuthorizationProvider

All Implemented Interfaces:

AuthorizationProvider

public class AnonymousAuthorizationProvider
extends Object
implements AuthorizationProvider

A AuthorizationProvider that returns an empty authorization.

This will result in the "Authorization" header not being added to a request.

Field Summary

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

ANONYMOUS

Constructor Summary

Constructors

Constructor	Description
AnonymousAuthorizationProvider()	Create default AnonymousAuthorizationProvider instance

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

AnonymousAuthorizationProvider

public AnonymousAuthorizationProvider()

Create default AnonymousAuthorizationProvider instance

Method Details

getEncodedAuthorization

public String getEncodedAuthorization()
                               throws IOException

Description copied from interface: AuthorizationProvider

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