Class Configuration

java.lang.Object
org.sourcelab.github.client.Configuration

public class Configuration extends Object
User supplied Configuration of the API Client.
  • Constructor Details

    • Configuration

      protected Configuration(String apiToken, String apiUrl, int requestTimeoutInSeconds, int connectionTimeToLiveInSeconds, File trustStoreFile, String trustStorePassword, String proxyHost, String proxyScheme, String proxyPassword, boolean ignoreInvalidSslCertificates, File keyStoreFile, String keyStorePassword, int proxyPort, String proxyUsername, ClientFactory clientFactory)
      Constructor. Use
      Parameters:
      apiToken - Set the configured Api Token.
      apiUrl - Set the API Url.
      requestTimeoutInSeconds - Timeout in seconds.
      connectionTimeToLiveInSeconds - Connection TTL.
      trustStoreFile - truststore.
      trustStorePassword - truststore password.
      proxyHost - Proxy Host
      proxyScheme - Proxy Scheme
      proxyPassword - Proxy password.
      ignoreInvalidSslCertificates - Optionally ignore invalid ssl certs.
      keyStoreFile - Keystore file.
      keyStorePassword - Keystore password.
      proxyPort - Proxy port.
      proxyUsername - Proxy username.
      clientFactory - Set the org.sourcelab.github.client factory.
  • 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.
    • getRequestTimeoutInSeconds

      public int getRequestTimeoutInSeconds()
    • getConnectionTimeToLiveInSeconds

      public int getConnectionTimeToLiveInSeconds()
    • getTrustStoreFile

      public File getTrustStoreFile()
    • getTrustStorePassword

      public String getTrustStorePassword()
    • getKeyStoreFile

      public File getKeyStoreFile()
    • getKeyStorePassword

      public String getKeyStorePassword()
    • getProxyHost

      public String getProxyHost()
    • getProxyPort

      public int getProxyPort()
    • getProxyScheme

      public String getProxyScheme()
    • getProxyUsername

      public String getProxyUsername()
    • getProxyPassword

      public String getProxyPassword()
    • toString

      public String toString()
      Overrides:
      toString in class Object