Package org.sourcelab.github.client

Class Configuration

java.lang.Object

org.sourcelab.github.client.Configuration

public class Configuration
extends Object

User supplied Configuration of the API Client.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Configuration(String apiToken, String apiUrl, ClientFactory clientFactory, boolean ignoreInvalidSslCertificates)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getApiToken()	The configured Api Token.
String	getApiUrl()	The configured Api Url.
ClientFactory	getClientFactory()	The configured Client factory instance.
boolean	isIgnoreInvalidSslCertificates()	If the request should ignore invalid ssl certificates.
static ConfigurationBuilder	newBuilder()	Create a new Builder for creating Configuration instances.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Configuration

protected Configuration(String apiToken,
 String apiUrl,
 ClientFactory clientFactory,
 boolean ignoreInvalidSslCertificates)

Constructor. Use

Parameters:

apiToken - Set the configured Api Token.

apiUrl - Set the API Url.

clientFactory - Set the org.sourcelab.github.client factory.

ignoreInvalidSslCertificates - Optionally ignore invalid ssl certs.

Method Details

newBuilder

public static ConfigurationBuilder newBuilder()

Create a new Builder for creating Configuration instances.

Returns:

Builder for Configuration instances.

getApiToken

public String getApiToken()

The configured Api Token.

Returns:

The configured Api Token.

getApiUrl

public String getApiUrl()

The configured Api Url. Example: "https://api.github.com"

Returns:

The configured Api Url. Example: "https://api.github.com"

isIgnoreInvalidSslCertificates

public boolean isIgnoreInvalidSslCertificates()

If the request should ignore invalid ssl certificates. Not recommended.

Returns:

true if invalid ssl certificates should be ignored, false if they should be validated.

getClientFactory

public ClientFactory getClientFactory()

The configured Client factory instance.

Returns:

The configured org.sourcelab.github.client factory instance.

toString

public String toString()

Overrides:

toString in class Object