ConnectionOptions (Apache Jackrabbit 2.20.16 API)

java.lang.Object
- org.apache.jackrabbit.spi2dav.ConnectionOptions

```
public final class ConnectionOptions
extends Object
```
Advanced connection options to use for connections to a remote repository.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConnectionOptions.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConnectionOptions.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`static ConnectionOptions`	`DEFAULT` The default connection options with regular TLS settings, without proxy and not leveraging system properties
`static int`	`MAX_CONNECTIONS_DEFAULT` Default value for the maximum number of connections per host such as configured with `PoolingHttpClientConnectionManager.setDefaultMaxPerRoute(int)`.
`static String`	`PARAM_ALLOW_SELF_SIGNED_CERTIFICATES` Boolean flag whether to allow self-signed certificates of remote repositories.
`static String`	`PARAM_CONNECTION_TIMEOUT_MS` The connection timeout in milliseconds as Integer.
`static String`	`PARAM_DISABLE_HOSTNAME_VERIFICATION` Boolean flag whether to disable the host name verification against the common name of the server's certificate.
`static String`	`PARAM_MAX_CONNECTIONS` Optional configuration parameter: Its value defines the maximumConnectionsPerHost value on the HttpClient configuration and must be an int greater than zero.
`static String`	`PARAM_PROXY_HOST` The host of a proxy server.
`static String`	`PARAM_PROXY_PASSWORD` The password to authenticate at the proxy.
`static String`	`PARAM_PROXY_PORT` Integer value for the proxy's port.
`static String`	`PARAM_PROXY_PROTOCOL` The protocol for which to use the proxy.
`static String`	`PARAM_PROXY_USERNAME` The user name to authenticate at the proxy.
`static String`	`PARAM_REQUEST_TIMEOUT_MS` The request timeout in milliseconds as Integer.
`static String`	`PARAM_SOCKET_TIMEOUT_MS` The request timeout in milliseconds as Integer.
`static String`	`PARAM_USE_SYSTEM_PROPERTIES` Boolean flag whether to use the default Java system properties for setting proxy, TLS and further options as defined by `HttpClientBuilder`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConnectionOptions.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`static ConnectionOptions`	`fromServiceFactoryParameters(Map<?,?> parameters)`
`int`	`getConnectionTimeoutMs()`
`int`	`getMaxConnections()`
`String`	`getProxyHost()`
`String`	`getProxyPassword()`
`int`	`getProxyPort()`
`String`	`getProxyProtocol()`
`String`	`getProxyUsername()`
`int`	`getRequestTimeoutMs()`
`int`	`getSocketTimeoutMs()`
`int`	`hashCode()`
`boolean`	`isAllowSelfSignedCertificates()`
`boolean`	`isDisableHostnameVerification()`
`boolean`	`isUseSystemPropertes()`
`Map<String,String>`	`toServiceFactoryParameters()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - PARAM_USE_SYSTEM_PROPERTIES
```
public static final String PARAM_USE_SYSTEM_PROPERTIES
```
    Boolean flag whether to use the default Java system properties for setting proxy, TLS and further options as defined by HttpClientBuilder. Default = false.
    
    See Also:
    
    Constant Field Values
  - PARAM_ALLOW_SELF_SIGNED_CERTIFICATES
```
public static final String PARAM_ALLOW_SELF_SIGNED_CERTIFICATES
```
    Boolean flag whether to allow self-signed certificates of remote repositories. Default = false.
    
    See Also:
    
    Constant Field Values
  - PARAM_DISABLE_HOSTNAME_VERIFICATION
```
public static final String PARAM_DISABLE_HOSTNAME_VERIFICATION
```
    Boolean flag whether to disable the host name verification against the common name of the server's certificate. Default = false.
    
    See Also:
    
    Constant Field Values
  - PARAM_PROXY_HOST
```
public static final String PARAM_PROXY_HOST
```
    The host of a proxy server.
    
    See Also:
    
    Constant Field Values
  - PARAM_PROXY_PORT
```
public static final String PARAM_PROXY_PORT
```
    Integer value for the proxy's port. Only effective if PARAM_PROXY_HOST is used as well. If -1 or not set the default for the scheme will be used.
    
    See Also:
    
    Constant Field Values
  - PARAM_PROXY_PROTOCOL
```
public static final String PARAM_PROXY_PROTOCOL
```
    The protocol for which to use the proxy. Only effective if PARAM_PROXY_HOST is used as well.
    
    See Also:
    
    Constant Field Values
  - PARAM_PROXY_USERNAME
```
public static final String PARAM_PROXY_USERNAME
```
    The user name to authenticate at the proxy. Only effective if PARAM_PROXY_HOST is used as well.
    
    See Also:
    
    Constant Field Values
  - PARAM_PROXY_PASSWORD
```
public static final String PARAM_PROXY_PASSWORD
```
    The password to authenticate at the proxy. Only effective if PARAM_PROXY_HOST and PARAM_PROXY_USERNAME are used as well.
    
    See Also:
    
    Constant Field Values
  - PARAM_CONNECTION_TIMEOUT_MS
```
public static final String PARAM_CONNECTION_TIMEOUT_MS
```
    The connection timeout in milliseconds as Integer. -1 for default, 0 for infinite.
    
    See Also:
    
    Constant Field Values
  - PARAM_REQUEST_TIMEOUT_MS
```
public static final String PARAM_REQUEST_TIMEOUT_MS
```
    The request timeout in milliseconds as Integer. -1 for default, 0 for infinite.
    
    See Also:
    
    Constant Field Values
  - PARAM_SOCKET_TIMEOUT_MS
```
public static final String PARAM_SOCKET_TIMEOUT_MS
```
    The request timeout in milliseconds as Integer. -1 for default, 0 for infinite.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_CONNECTIONS
```
public static final String PARAM_MAX_CONNECTIONS
```
    Optional configuration parameter: Its value defines the maximumConnectionsPerHost value on the HttpClient configuration and must be an int greater than zero.
    
    See Also:
    
    Constant Field Values
  - MAX_CONNECTIONS_DEFAULT
```
public static final int MAX_CONNECTIONS_DEFAULT
```
    Default value for the maximum number of connections per host such as configured with PoolingHttpClientConnectionManager.setDefaultMaxPerRoute(int).
    
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final ConnectionOptions DEFAULT
```
    The default connection options with regular TLS settings, without proxy and not leveraging system properties
- Method Detail
  - isUseSystemPropertes
```
public boolean isUseSystemPropertes()
```
  - isAllowSelfSignedCertificates
```
public boolean isAllowSelfSignedCertificates()
```
  - isDisableHostnameVerification
```
public boolean isDisableHostnameVerification()
```
  - getMaxConnections
```
public int getMaxConnections()
```
  - getConnectionTimeoutMs
```
public int getConnectionTimeoutMs()
```
  - getRequestTimeoutMs
```
public int getRequestTimeoutMs()
```
  - getSocketTimeoutMs
```
public int getSocketTimeoutMs()
```
  - getProxyHost
```
public String getProxyHost()
```
  - getProxyPort
```
public int getProxyPort()
```
  - getProxyProtocol
```
public String getProxyProtocol()
```
  - getProxyUsername
```
public String getProxyUsername()
```
  - getProxyPassword
```
public String getProxyPassword()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toServiceFactoryParameters
```
public Map<String,String> toServiceFactoryParameters()
```
  - fromServiceFactoryParameters
```
public static ConnectionOptions fromServiceFactoryParameters(Map<?,?> parameters)
```
  - builder
```
public static ConnectionOptions.Builder builder()
```

Class ConnectionOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARAM_USE_SYSTEM_PROPERTIES

PARAM_ALLOW_SELF_SIGNED_CERTIFICATES

PARAM_DISABLE_HOSTNAME_VERIFICATION

PARAM_PROXY_HOST

PARAM_PROXY_PORT

PARAM_PROXY_PROTOCOL

PARAM_PROXY_USERNAME

PARAM_PROXY_PASSWORD

PARAM_CONNECTION_TIMEOUT_MS

PARAM_REQUEST_TIMEOUT_MS

PARAM_SOCKET_TIMEOUT_MS

PARAM_MAX_CONNECTIONS

MAX_CONNECTIONS_DEFAULT

DEFAULT

Method Detail

isUseSystemPropertes

isAllowSelfSignedCertificates

isDisableHostnameVerification

getMaxConnections

getConnectionTimeoutMs

getRequestTimeoutMs

getSocketTimeoutMs

getProxyHost

getProxyPort

getProxyProtocol

getProxyUsername

getProxyPassword

hashCode

equals

toString

toServiceFactoryParameters

fromServiceFactoryParameters

builder