org.gitlab4j.api

Class ProxyClientConfig

java.lang.Object

org.gitlab4j.api.ProxyClientConfig

public class ProxyClientConfig
extends java.lang.Object

This class provides convenience methods to create ClientConfig properties so GitLabApi can use a proxy server.

Constructor Summary

Constructors

Constructor and Description
ProxyClientConfig()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	createNtlmProxyClientConfig(java.lang.String proxyUri, java.lang.String username, java.lang.String password, java.lang.String workstation, java.lang.String domain) Create a Map instance set up to use an NTLM proxy server that can be passed to the GitLabAPi constructors and login methods to configure the GitLabApi instance to use an NTLM proxy server.
static java.util.Map<java.lang.String,java.lang.Object>	createProxyClientConfig(java.lang.String proxyUri) Create a Map instance with properties set up to use a proxy server that can be passed to the GitLabAPi constructors and login methods to configure the GitLabApi instance to use a proxy server.
static java.util.Map<java.lang.String,java.lang.Object>	createProxyClientConfig(java.lang.String proxyUri, java.lang.String username, java.lang.String password) Create a Map instance set up to use a proxy server that can be passed to the GitLabAPi constructors and login methods to configure the GitLabApi instance to use a proxy server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyClientConfig

public ProxyClientConfig()

Method Detail

createProxyClientConfig

public static java.util.Map<java.lang.String,java.lang.Object> createProxyClientConfig(java.lang.String proxyUri)

Create a Map instance with properties set up to use a proxy server that can be passed to the GitLabAPi constructors and login methods to configure the GitLabApi instance to use a proxy server.

Parameters:

proxyUri - the URI of the proxy server

Returns:

a Map set up to allow GitLabApi to use a proxy server

createProxyClientConfig

public static java.util.Map<java.lang.String,java.lang.Object> createProxyClientConfig(java.lang.String proxyUri,
                                                                                       java.lang.String username,
                                                                                       java.lang.String password)

Create a Map instance set up to use a proxy server that can be passed to the GitLabAPi constructors and login methods to configure the GitLabApi instance to use a proxy server.

Parameters:

proxyUri - the URI of the proxy server

username - the username for basic auth with the proxy server

password - the password for basic auth with the proxy server

Returns:

a Map set up to allow GitLabApi to use a proxy server

createNtlmProxyClientConfig

public static java.util.Map<java.lang.String,java.lang.Object> createNtlmProxyClientConfig(java.lang.String proxyUri,
                                                                                           java.lang.String username,
                                                                                           java.lang.String password,
                                                                                           java.lang.String workstation,
                                                                                           java.lang.String domain)

Create a Map instance set up to use an NTLM proxy server that can be passed to the GitLabAPi constructors and login methods to configure the GitLabApi instance to use an NTLM proxy server.

Parameters:

proxyUri - the URI of the proxy server

username - the user name. This should not include the domain to authenticate with. For example: "user" is correct whereas "DOMAIN\user" is not.

password - the password

workstation - the workstation the authentication request is originating from. Essentially, the computer name for this machine.

domain - the domain to authenticate within

Returns:

a Map set up to allow GitLabApi to use an NTLM proxy server