com.obs.services

Class ObsConfiguration

java.lang.Object

com.obs.services.ObsConfiguration

All Implemented Interfaces:

Cloneable

public class ObsConfiguration
extends Object
implements Cloneable

Configuration parameters of ObsClient

Constructor Summary

Constructors

Constructor and Description
ObsConfiguration() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
protected Object	clone()
void	disableNio() Deprecated.
void	enableNio() Deprecated.
AuthTypeEnum	getAuthType() Obtain the authentication type.
int	getBufferSize() Deprecated.
int	getConnectionRequestTimeout() Deprecated.
int	getConnectionTimeout() Obtain the timeout interval for establishing HTTP/HTTPS connections (in milliseconds, 60,000 milliseconds by default).
String	getDefaultBucketLocation() Deprecated.
String	getDelimiter()
String	getEndPoint() Obtain the endpoint for accessing OBS.
int	getEndpointHttpPort() Deprecated.
int	getEndpointHttpsPort() Deprecated.
okhttp3.Dispatcher	getHttpDispatcher() Set the customized dispatcher.
HttpProtocolTypeEnum	getHttpProtocolType() Set the HTTP type used for accessing OBS servers.
HttpProxyConfiguration	getHttpProxy() Obtain the proxy configuration.
int	getIdleConnectionTime() Obtain the idle time for obtaining connections from the connection pool.
KeyManagerFactory	getKeyManagerFactory() Obtain the factory for generating the "KeyManager" array.
int	getMaxConnections() Obtain the maximum number of HTTP connections (1000 by default) that can be opened.
int	getMaxErrorRetry() Obtain the maximum number of retry attempts (5 by default) upon a request failure (request exception, or error 500 or 503 on the server).
int	getMaxIdleConnections() Obtain the maximum number of idle connections in the connection pool.
int	getReadBufferSize() Obtain the read cache size used for uploading objects to socket streams (in bytes).
String	getSignatString() Deprecated.
int	getSocketReadBufferSize() Obtain the size (bytes) of the socket receive buffer, corresponding to the "java.net.SocketOptions.SO_RVCBUF" parameter.
int	getSocketTimeout() Obtain the timeout interval for data transmission at the socket layer (in milliseconds, 60,000 milliseconds by default).
int	getSocketWriteBufferSize() Obtain the size (bytes) of the socket send buffer, corresponding to the "java.net.SocketOptions.SO_SNDBUF" parameter.
String	getSslProvider() Set the provider of SSLContext.
TrustManagerFactory	getTrustManagerFactory() Obtain the factory for generating the "TrustManager" array.
int	getUploadStreamRetryBufferSize() Deprecated.
int	getWriteBufferSize() Obtain the write cache size used for uploading objects to socket streams (in bytes).
boolean	isAuthTypeNegotiation() Check whether protocol negotiation is used.
boolean	isCname() Check whether user-defined domain name is used.
boolean	isDisableDnsBucket() Deprecated.
boolean	isHttpsOnly() Deprecated.
boolean	isKeepAlive() Specify whether to use persistent connections.
boolean	isNio() Deprecated.
boolean	isPathStyle() Deprecated.
boolean	isStrictHostnameVerification() Obtain the identifier specifying whether to verify the domain name ("false" by default).
boolean	isUseReaper() Deprecated.
boolean	isValidateCertificate() Check whether server-side verification is enabled.
boolean	isVerifyResponseContentType() Check whether "ContentType" in the response is verified.
void	setAuthType(AuthTypeEnum authType) Set the authentication type.
void	setAuthTypeNegotiation(boolean authTypeNegotiation) Specify whether to use protocol negotiation.
void	setBufferSize(int bufferSize) Deprecated.
void	setCname(boolean cname) Specify whether to use user-defined domain name.
void	setConnectionRequestTimeout(int connectionRequestTimeout) Deprecated.
void	setConnectionTimeout(int connectionTimeout) Set the timeout interval for establishing HTTP/HTTPS connections (in milliseconds, 60,000 milliseconds by default).
void	setDefaultBucketLocation(String defaultBucketLocation) Deprecated.
void	setDelimiter(String delimiter) Set folder isolators to slashes.
void	setDisableDnsBucket(boolean disableDns) Deprecated.
void	setEndPoint(String endPoint) Set the endpoint for accessing OBS.
void	setEndpointHttpPort(int endpointHttpPort) Deprecated.
void	setEndpointHttpsPort(int endpointHttpsPort) Deprecated.
void	setHttpDispatcher(okhttp3.Dispatcher httpDispatcher) Obtain the customized dispatcher.
void	setHttpProtocolType(HttpProtocolTypeEnum httpProtocolType) Obtain the HTTP type used for accessing OBS servers.
void	setHttpProxy(HttpProxyConfiguration httpProxy) Configure the proxy.
void	setHttpProxy(String proxyAddr, int proxyPort, String userName, String password) Configure the proxy server.
void	setHttpProxy(String proxyAddr, int proxyPort, String userName, String password, String domain) Deprecated.
void	setHttpsOnly(boolean httpsOnly) Deprecated.
void	setIdleConnectionTime(int idleConnectionTime) Set the idle time for obtaining connections from the connection pool.
void	setIsStrictHostnameVerification(boolean isStrictHostnameVerification) Set the identifier specifying whether to verify the domain name.
void	setKeepAlive(boolean keepAlive) Check whether persistent connections are used.
void	setKeyManagerFactory(KeyManagerFactory keyManagerFactory) Set the factory for generating the "KeyManager" array.
void	setMaxConnections(int maxConnections) Set the maximum number of HTTP connections (1000 by default) that can be opened.
void	setMaxErrorRetry(int maxErrorRetry) Set the maximum number of retry attempts (5 by default) upon a request failure (request exception, or error 500 or 503 on the server).
void	setMaxIdleConnections(int maxIdleConnections) Set the maximum number of idle connections in the connection pool.
void	setPathStyle(boolean pathStyle) Deprecated.
void	setReadBufferSize(int readBufferSize) Set the read cache size used for uploading objects to socket streams (in bytes).
void	setSignatString(String signatString) Deprecated.
void	setSocketReadBufferSize(int socketReadBufferSize) Set the size (bytes) of the socket receive buffer, corresponding to the "java.net.SocketOptions.SO_RVCBUF" parameter.
void	setSocketTimeout(int socketTimeout) Set the timeout interval for data transmission at the socket layer (in milliseconds, 60,000 milliseconds by default).
void	setSocketWriteBufferSize(int socketWriteBufferSize) Set the size (bytes) of the socket send buffer (in bytes), corresponding to the "java.net.SocketOptions.SO_SNDBUF" parameter.
void	setSslProvider(String sslProvider) Obtain the provider of SSLContext.
void	setTrustManagerFactory(TrustManagerFactory trustManagerFactory) Set the factory for generating the "TrustManager" array.
void	setUploadStreamRetryBufferSize(int uploadStreamRetryBufferSize) Deprecated.
void	setUseReaper(boolean useReaper) Deprecated.
void	setValidateCertificate(boolean validateCertificate) Specify whether to enable server-side certificate verification.
void	setVerifyResponseContentType(boolean verifyResponseContentType) Specify whether to verify "ContentType" in the response.
void	setWriteBufferSize(int writeBufferSize) Set the write cache size used for uploading objects to socket streams (in bytes).

Methods inherited from class java.lang.Object

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

Constructor Detail

ObsConfiguration

public ObsConfiguration()

Constructor

Method Detail

getDelimiter

public String getDelimiter()

setDelimiter

public void setDelimiter(String delimiter)

Set folder isolators to slashes.

Parameters:

delimiter - Folder isolator

getSignatString

@Deprecated
public String getSignatString()

Deprecated.

setSignatString

@Deprecated
public void setSignatString(String signatString)

Deprecated.

getDefaultBucketLocation

@Deprecated
public String getDefaultBucketLocation()

Deprecated.

setDefaultBucketLocation

@Deprecated
public void setDefaultBucketLocation(String defaultBucketLocation)

Deprecated.

getBufferSize

@Deprecated
public int getBufferSize()

Deprecated.

setBufferSize

@Deprecated
public void setBufferSize(int bufferSize)

Deprecated.

isDisableDnsBucket

@Deprecated
public boolean isDisableDnsBucket()

Deprecated.

Check whether path-style access to OBS is enabled. "true" indicates that path-style access is enabled while "false" (default) indicates virtual hosted-style access is enabled. Note: If the path-style access is enabled, new bucket features of OBS 3.0 are not supported.

Returns:

Whether to enable path-style access to OBS.

setDisableDnsBucket

@Deprecated
public void setDisableDnsBucket(boolean disableDns)

Deprecated.

Specify whether to enable path-style access to OBS. "true" indicates that path-style access is enabled while "false" (default) indicates that virtual hosted-style access is enabled. Note: If the path-style access is enabled, new bucket features of OBS 3.0 are not supported.

Parameters:

disableDns - Whether to enable path-style access to OBS.

getSocketReadBufferSize

public int getSocketReadBufferSize()

Obtain the size (bytes) of the socket receive buffer, corresponding to the "java.net.SocketOptions.SO_RVCBUF" parameter. The default value is "-1", indicating that the size is not set.

Returns:

Socket receive buffer size

setSocketReadBufferSize

public void setSocketReadBufferSize(int socketReadBufferSize)

Set the size (bytes) of the socket receive buffer, corresponding to the "java.net.SocketOptions.SO_RVCBUF" parameter. The default value is "-1", indicating that the size is not set.

Parameters:

socketReadBufferSize - Socket receive buffer size

getSocketWriteBufferSize

public int getSocketWriteBufferSize()

Obtain the size (bytes) of the socket send buffer, corresponding to the "java.net.SocketOptions.SO_SNDBUF" parameter. The default value is "-1", indicating that the size is not set.

Returns:

socketSocket send buffer size

setSocketWriteBufferSize

public void setSocketWriteBufferSize(int socketWriteBufferSize)

Set the size (bytes) of the socket send buffer (in bytes), corresponding to the "java.net.SocketOptions.SO_SNDBUF" parameter. The default value is "-1", indicating that the size is not set.

Parameters:

socketWriteBufferSize - socket Socket send buffer size

getConnectionRequestTimeout

@Deprecated
public int getConnectionRequestTimeout()

Deprecated.

setConnectionRequestTimeout

@Deprecated
public void setConnectionRequestTimeout(int connectionRequestTimeout)

Deprecated.

disableNio

@Deprecated
public void disableNio()

Deprecated.

enableNio

@Deprecated
public void enableNio()

Deprecated.

isNio

@Deprecated
public boolean isNio()

Deprecated.

isUseReaper

@Deprecated
public boolean isUseReaper()

Deprecated.

setUseReaper

@Deprecated
public void setUseReaper(boolean useReaper)

Deprecated.

getKeyManagerFactory

public KeyManagerFactory getKeyManagerFactory()

Obtain the factory for generating the "KeyManager" array.

Returns:

Factory for generating the "KeyManager" array

setKeyManagerFactory

public void setKeyManagerFactory(KeyManagerFactory keyManagerFactory)

Set the factory for generating the "KeyManager" array.

Parameters:

keyManagerFactory - Factory for generating the "KeyManager" array

getTrustManagerFactory

public TrustManagerFactory getTrustManagerFactory()

Obtain the factory for generating the "TrustManager" array.

Returns:

Factory for generating the "TrustManager" array

setTrustManagerFactory

public void setTrustManagerFactory(TrustManagerFactory trustManagerFactory)

Set the factory for generating the "TrustManager" array.

Parameters:

trustManagerFactory - Factory for generating the "TrustManager" array

isStrictHostnameVerification

public boolean isStrictHostnameVerification()

Obtain the identifier specifying whether to verify the domain name ("false" by default).

Returns:

Identifier specifying whether to verify the domain name

setIsStrictHostnameVerification

public void setIsStrictHostnameVerification(boolean isStrictHostnameVerification)

Set the identifier specifying whether to verify the domain name.

Parameters:

isStrictHostnameVerification - Identifier specifying whether to verify the domain name

isPathStyle

@Deprecated
public boolean isPathStyle()

Deprecated.

Check whether path-style access to OBS is enabled. "true" indicates that path-style access is enabled while "false" (default) indicates virtual hosted-style access is enabled. Note: If the path-style access is enabled, new bucket features of OBS 3.0 are not supported.

Returns:

Whether to enable path-style access to OBS.

setPathStyle

@Deprecated
public void setPathStyle(boolean pathStyle)

Deprecated.

Specify whether to enable path-style access to OBS. "true" indicates that path-style access is enabled while "false" (default) indicates that virtual hosted-style access is enabled. Note: If the path-style access is enabled, new bucket features of OBS 3.0 are not supported.

Parameters:

pathStyle - Whether to enable path-style access to OBS.

getConnectionTimeout

public int getConnectionTimeout()

Obtain the timeout interval for establishing HTTP/HTTPS connections (in milliseconds, 60,000 milliseconds by default).

Returns:

Timeout interval for establishing HTTP/HTTPS connections

setConnectionTimeout

public void setConnectionTimeout(int connectionTimeout)

Set the timeout interval for establishing HTTP/HTTPS connections (in milliseconds, 60,000 milliseconds by default).

Parameters:

connectionTimeout - Timeout interval for establishing HTTP/HTTPS connections

getMaxConnections

public int getMaxConnections()

Obtain the maximum number of HTTP connections (1000 by default) that can be opened.

Returns:

Maximum number of concurrently opened HTTP connections

setMaxConnections

public void setMaxConnections(int maxConnections)

Set the maximum number of HTTP connections (1000 by default) that can be opened.

Parameters:

maxConnections - Maximum number of concurrently opened HTTP connections

getMaxErrorRetry

public int getMaxErrorRetry()

Obtain the maximum number of retry attempts (5 by default) upon a request failure (request exception, or error 500 or 503 on the server).

Returns:

Maximum number of retry attempts upon a request failure

setMaxErrorRetry

public void setMaxErrorRetry(int maxErrorRetry)

Set the maximum number of retry attempts (5 by default) upon a request failure (request exception, or error 500 or 503 on the server).

Parameters:

maxErrorRetry - Maximum number of retry attempts upon a request failure

getSocketTimeout

public int getSocketTimeout()

Obtain the timeout interval for data transmission at the socket layer (in milliseconds, 60,000 milliseconds by default).

Returns:

Timeout interval for data transmission at the socket layer

setSocketTimeout

public void setSocketTimeout(int socketTimeout)

Set the timeout interval for data transmission at the socket layer (in milliseconds, 60,000 milliseconds by default).

Parameters:

socketTimeout - Timeout interval for data transmission at the socket layer

getEndPoint

public String getEndPoint()

Obtain the endpoint for accessing OBS.

Returns:

OBS endpoint

setEndPoint

public void setEndPoint(String endPoint)

Set the endpoint for accessing OBS.

Parameters:

endPoint - OBS endpoint

getEndpointHttpPort

@Deprecated
public int getEndpointHttpPort()

Deprecated.

Obtain the port number of the HTTP request (80 by default).

Returns:

Port number of the HTTP request

setEndpointHttpPort

@Deprecated
public void setEndpointHttpPort(int endpointHttpPort)

Deprecated.

Set the port number of the HTTP request (80 by default).

Parameters:

endpointHttpPort - Port number of the HTTP request

getEndpointHttpsPort

@Deprecated
public int getEndpointHttpsPort()

Deprecated.

Obtain the port number of the HTTPS request (443 by default).

Returns:

Port number of the HTTPS request

setEndpointHttpsPort

@Deprecated
public void setEndpointHttpsPort(int endpointHttpsPort)

Deprecated.

Set the port number of the HTTPS request (443 by default).

Parameters:

endpointHttpsPort - Port number of the HTTPS request

setHttpsOnly

@Deprecated
public void setHttpsOnly(boolean httpsOnly)

Deprecated.

Specify whether to use HTTPS to connect OBS ("true" by default).

Parameters:

httpsOnly - Identifier specifying whether to use HTTPS to connect OBS

isHttpsOnly

@Deprecated
public boolean isHttpsOnly()

Deprecated.

Check whether HTTPS is used to connect OBS ("true" by default).

Returns:

Identifier specifying whether to use HTTPS to connect OBS

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

getHttpProxy

public HttpProxyConfiguration getHttpProxy()

Obtain the proxy configuration.

Returns:

Proxy configuration

setHttpProxy

public void setHttpProxy(HttpProxyConfiguration httpProxy)

Configure the proxy.

Parameters:

httpProxy - HTTP proxy configuration

setHttpProxy

@Deprecated
public void setHttpProxy(String proxyAddr,
                           int proxyPort,
                           String userName,
                           String password,
                           String domain)

Deprecated.

Configure the proxy server.

Parameters:

proxyAddr - Proxy server address

proxyPort - Proxy server port

userName - Proxy username

password - Proxy password

domain - Proxy domain

setHttpProxy

public void setHttpProxy(String proxyAddr,
                int proxyPort,
                String userName,
                String password)

Configure the proxy server.

Parameters:

proxyAddr - Proxy server address

proxyPort - Proxy server port

userName - Proxy username

password - Proxy password

setUploadStreamRetryBufferSize

@Deprecated
public void setUploadStreamRetryBufferSize(int uploadStreamRetryBufferSize)

Deprecated.

Set the buffer size used for uploading stream objects (in bytes). The default value is 512 KB.

Parameters:

uploadStreamRetryBufferSize - Buffer size used for uploading stream objects

getUploadStreamRetryBufferSize

@Deprecated
public int getUploadStreamRetryBufferSize()

Deprecated.

Obtain the buffer size used for uploading stream objects (in bytes). The default value is 512 KB.

Returns:

Buffer size used for uploading stream objects

isValidateCertificate

public boolean isValidateCertificate()

Check whether server-side verification is enabled. The default value is "false".

Returns:

Identifier specifying whether to enable server-side verification

setValidateCertificate

public void setValidateCertificate(boolean validateCertificate)

Specify whether to enable server-side certificate verification. The default value is "false".

Parameters:

validateCertificate - Identifier specifying whether to enable server-side verification

isVerifyResponseContentType

public boolean isVerifyResponseContentType()

Check whether "ContentType" in the response is verified. The default value is "true".

Returns:

Identifier specifying whether to verify "ContentType" in the response

setVerifyResponseContentType

public void setVerifyResponseContentType(boolean verifyResponseContentType)

Specify whether to verify "ContentType" in the response. The default value is "true".

Parameters:

verifyResponseContentType - Identifier specifying whether to verify "ContentType" in the response

getReadBufferSize

public int getReadBufferSize()

Obtain the read cache size used for uploading objects to socket streams (in bytes). The default value is 8192.

Returns:

Read cache size used for uploading objects to socket streams

setReadBufferSize

public void setReadBufferSize(int readBufferSize)

Set the read cache size used for uploading objects to socket streams (in bytes). The default value is 8192.

Parameters:

readBufferSize - Read cache size used for uploading objects to socket streams

getWriteBufferSize

public int getWriteBufferSize()

Obtain the write cache size used for uploading objects to socket streams (in bytes). The default value is 8192.

Returns:

Write cache size used for uploading objects to socket streams

setWriteBufferSize

public void setWriteBufferSize(int writeBufferSize)

Set the write cache size used for uploading objects to socket streams (in bytes). The default value is 8192.

Parameters:

writeBufferSize - Write cache size used for uploading objects to socket streams

getIdleConnectionTime

public int getIdleConnectionTime()

Obtain the idle time for obtaining connections from the connection pool. The unit is millisecond and the default value is 30000.

Returns:

Maximum idle time for obtaining connections from the connection pool

setIdleConnectionTime

public void setIdleConnectionTime(int idleConnectionTime)

Set the idle time for obtaining connections from the connection pool. The unit is millisecond and the default value is 30000.

Parameters:

idleConnectionTime - Maximum idle time for obtaining connections from the connection pool

getMaxIdleConnections

public int getMaxIdleConnections()

Obtain the maximum number of idle connections in the connection pool. The default value is 1000.

Returns:

Maximum number of idle connections in the connection pool

setMaxIdleConnections

public void setMaxIdleConnections(int maxIdleConnections)

Set the maximum number of idle connections in the connection pool. The default value is 1000.

Parameters:

maxIdleConnections - Maximum number of idle connections in the connection pool

getAuthType

public AuthTypeEnum getAuthType()

Obtain the authentication type.

Returns:

Authentication type

setAuthType

public void setAuthType(AuthTypeEnum authType)

Set the authentication type.

Parameters:

authType - Authentication type

isKeepAlive

public boolean isKeepAlive()

Specify whether to use persistent connections.

Returns:

Identifier specifying whether to use the persistent connections

setKeepAlive

public void setKeepAlive(boolean keepAlive)

Check whether persistent connections are used.

Parameters:

keepAlive - Identifier specifying whether to use the persistent connections

isAuthTypeNegotiation

public boolean isAuthTypeNegotiation()

Check whether protocol negotiation is used.

Returns:

Identifier specifying whether to use protocol negotiation

setAuthTypeNegotiation

public void setAuthTypeNegotiation(boolean authTypeNegotiation)

Specify whether to use protocol negotiation.

Parameters:

authTypeNegotiation - Identifier specifying whether to use protocol negotiation

isCname

public boolean isCname()

Check whether user-defined domain name is used.

Returns:

Identifier specifying whether to use user-defined domain name

setCname

public void setCname(boolean cname)

Specify whether to use user-defined domain name.

Parameters:

cname - Identifier specifying whether to use user-defined domain name

getSslProvider

public String getSslProvider()

Set the provider of SSLContext.

Returns:

SSLContext provider

setSslProvider

public void setSslProvider(String sslProvider)

Obtain the provider of SSLContext.

Parameters:

sslProvider - SSLContext provider

getHttpProtocolType

public HttpProtocolTypeEnum getHttpProtocolType()

Set the HTTP type used for accessing OBS servers.

Returns:

HTTP type

setHttpProtocolType

public void setHttpProtocolType(HttpProtocolTypeEnum httpProtocolType)

Obtain the HTTP type used for accessing OBS servers.

Parameters:

httpProtocolType - HTTP type

getHttpDispatcher

public okhttp3.Dispatcher getHttpDispatcher()

Set the customized dispatcher.

Returns:

Customized dispatcher

setHttpDispatcher

public void setHttpDispatcher(okhttp3.Dispatcher httpDispatcher)

Obtain the customized dispatcher.

Parameters:

httpDispatcher - Customized dispatcher