org.apache.nifi.proxy

Class ProxyConfiguration

java.lang.Object

org.apache.nifi.proxy.ProxyConfiguration

public class ProxyConfiguration
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static ProxyConfiguration	DIRECT_CONFIGURATION
private String	proxyServerHost
private Integer	proxyServerPort
private Proxy.Type	proxyType
private String	proxyUserName
private String	proxyUserPassword

Constructor Summary

Constructors

Constructor and Description
ProxyConfiguration()

Method Summary

Modifier and Type	Method and Description
Proxy	createProxy() Create a Proxy instance based on proxy type, proxy server host and port.
static PropertyDescriptor	createProxyConfigPropertyDescriptor(boolean hasComponentProxyConfigs, ProxySpec... _specs)
static ProxyConfiguration	getConfiguration(PropertyContext context) A convenient method to get ProxyConfiguration instance from a PropertyContext.
static ProxyConfiguration	getConfiguration(PropertyContext context, Supplier<ProxyConfiguration> perComponentSetting) This method can be used by Components those originally have per component proxy configurations to implement ProxyConfiguration Controller Service with backward compatibility.
String	getProxyServerHost()
Integer	getProxyServerPort()
Proxy.Type	getProxyType()
String	getProxyUserName()
String	getProxyUserPassword()
private static Set<ProxySpec>	getUniqueProxySpecs(ProxySpec... _specs) Remove redundancy.
boolean	hasCredential()
void	setProxyServerHost(String proxyServerHost)
void	setProxyServerPort(Integer proxyServerPort)
void	setProxyType(Proxy.Type proxyType)
void	setProxyUserName(String proxyUserName)
void	setProxyUserPassword(String proxyUserPassword)
static void	validateProxySpec(ValidationContext context, Collection<ValidationResult> results, ProxySpec... _specs) This method can be used from customValidate method of components using this Controller Service to validate the service is configured with the supported proxy types.

Methods inherited from class java.lang.Object

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

Field Detail

DIRECT_CONFIGURATION

public static final ProxyConfiguration DIRECT_CONFIGURATION

proxyType

private Proxy.Type proxyType

proxyServerHost

private String proxyServerHost

proxyServerPort

private Integer proxyServerPort

proxyUserName

private String proxyUserName

proxyUserPassword

private String proxyUserPassword

Constructor Detail

ProxyConfiguration

public ProxyConfiguration()

Method Detail

createProxyConfigPropertyDescriptor

public static PropertyDescriptor createProxyConfigPropertyDescriptor(boolean hasComponentProxyConfigs,
                                                                     ProxySpec... _specs)

getUniqueProxySpecs

private static Set<ProxySpec> getUniqueProxySpecs(ProxySpec... _specs)

Remove redundancy. If X_AUTH is supported, then X should be supported, too.

Parameters:

_specs - original specs

Returns:

sorted unique specs

validateProxySpec

public static void validateProxySpec(ValidationContext context,
                                     Collection<ValidationResult> results,
                                     ProxySpec... _specs)

This method can be used from customValidate method of components using this Controller Service to validate the service is configured with the supported proxy types.

Parameters:

context - the validation context

results - if validation fails, an invalid validation result will be added to this collection

_specs - specify supported proxy specs

getConfiguration

public static ProxyConfiguration getConfiguration(PropertyContext context)

A convenient method to get ProxyConfiguration instance from a PropertyContext.

Parameters:

context - the process context

Returns:

The proxy configurations at Controller Service if set, or DIRECT_CONFIGURATION

getConfiguration

public static ProxyConfiguration getConfiguration(PropertyContext context,
                                                  Supplier<ProxyConfiguration> perComponentSetting)

This method can be used by Components those originally have per component proxy configurations to implement ProxyConfiguration Controller Service with backward compatibility.

Parameters:

context - the process context

perComponentSetting - the function to supply ProxyConfiguration based on per component settings, only called when Proxy Configuration Service is not set

Returns:

The proxy configurations at Controller Service if set, or per component settings otherwise

getProxyType

public Proxy.Type getProxyType()

setProxyType

public void setProxyType(Proxy.Type proxyType)

getProxyServerHost

public String getProxyServerHost()

setProxyServerHost

public void setProxyServerHost(String proxyServerHost)

getProxyServerPort

public Integer getProxyServerPort()

setProxyServerPort

public void setProxyServerPort(Integer proxyServerPort)

hasCredential

public boolean hasCredential()

getProxyUserName

public String getProxyUserName()

setProxyUserName

public void setProxyUserName(String proxyUserName)

getProxyUserPassword

public String getProxyUserPassword()

setProxyUserPassword

public void setProxyUserPassword(String proxyUserPassword)

createProxy

public Proxy createProxy()

Create a Proxy instance based on proxy type, proxy server host and port.