ClouderaManagerClientBuilder (Cloudera Manager API (5.12.0))

java.lang.Object
- com.cloudera.api.ClouderaManagerClientBuilder

public class ClouderaManagerClientBuilder
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_CONNECTION_TIMEOUT`
`static TimeUnit`	`DEFAULT_CONNECTION_TIMEOUT_UNITS`
`static long`	`DEFAULT_RECEIVE_TIMEOUT`
`static TimeUnit`	`DEFAULT_RECEIVE_TIMEOUT_UNITS`
`static int`	`DEFAULT_TCP_PORT`

Constructor Summary

Constructors
Constructor and Description

ClouderaManagerClientBuilder()

Constructors
Constructor and Description
`ClouderaManagerClientBuilder()`

Method Summary

Methods
Modifier and Type	Method and Description
`ApiRootResource`	`build()` Build an ApiRootResource proxy object for communicating with the remote server.
`protected <T> T`	`build(Class<T> proxyType)` Build a client proxy, for a specific proxy type.
`static void`	`clearCachedResources()` Clears any cached resources shared during build operations across instances of this class.
`static void`	`closeClient(Object root)` Releases the internal state and configuration associated with this client.
`ClouderaManagerClientBuilder`	`disableTlsCertValidation()`
`ClouderaManagerClientBuilder`	`disableTlsCnValidation()`
`ClouderaManagerClientBuilder`	`enableLogging()`
`ClouderaManagerClientBuilder`	`enableStreamAutoClosure()` By default, ClouderaManagerClientBuilder disables auto-closure of response streams when generated client are making requests.
`ClouderaManagerClientBuilder`	`enableTLS()`
`ClouderaManagerClientBuilder`	`setMaintainSessionAcrossRequests(boolean maintainSessionAcrossRequests)`
`ClouderaManagerClientBuilder`	`setThreadSafe(boolean threadSafe)`
`void`	`setTrustManagers(TrustManager[] managers)`
`ClouderaManagerClientBuilder`	`withAcceptLanguage(String acceptLaunguage)`
`ClouderaManagerClientBuilder`	`withBaseURL(URL baseUrl)`
`ClouderaManagerClientBuilder`	`withConnectionTimeout(long connectionTimeout, TimeUnit connectionTimeoutUnits)`
`ClouderaManagerClientBuilder`	`withHost(String hostname)`
`ClouderaManagerClientBuilder`	`withPort(int port)`
`ClouderaManagerClientBuilder`	`withReceiveTimeout(long receiveTimeout, TimeUnit receiveTimeoutUnits)`
`ClouderaManagerClientBuilder`	`withUsernamePassword(String username, String password)`

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

- Field Detail
  - DEFAULT_TCP_PORT
```
public static final int DEFAULT_TCP_PORT
```
    See Also:
    Constant Field Values
  - DEFAULT_CONNECTION_TIMEOUT
```
public static final long DEFAULT_CONNECTION_TIMEOUT
```
    See Also:
    Constant Field Values
  - DEFAULT_CONNECTION_TIMEOUT_UNITS
```
public static final TimeUnit DEFAULT_CONNECTION_TIMEOUT_UNITS
```
  - DEFAULT_RECEIVE_TIMEOUT
```
public static final long DEFAULT_RECEIVE_TIMEOUT
```
    See Also:
    Constant Field Values
  - DEFAULT_RECEIVE_TIMEOUT_UNITS
```
public static final TimeUnit DEFAULT_RECEIVE_TIMEOUT_UNITS
```
- Constructor Detail
  - ClouderaManagerClientBuilder
```
public ClouderaManagerClientBuilder()
```
- Method Detail
  - withAcceptLanguage
```
public ClouderaManagerClientBuilder withAcceptLanguage(String acceptLaunguage)
```
  - withBaseURL
```
public ClouderaManagerClientBuilder withBaseURL(URL baseUrl)
```
  - withHost
```
public ClouderaManagerClientBuilder withHost(String hostname)
```
  - withPort
```
public ClouderaManagerClientBuilder withPort(int port)
```
  - enableTLS
```
public ClouderaManagerClientBuilder enableTLS()
```
  - enableLogging
```
public ClouderaManagerClientBuilder enableLogging()
```
  - setThreadSafe
```
public ClouderaManagerClientBuilder setThreadSafe(boolean threadSafe)
```
    Parameters:
    threadSafe - Set if to create a thread safe client.
    
    Returns:
  - setMaintainSessionAcrossRequests
```
public ClouderaManagerClientBuilder setMaintainSessionAcrossRequests(boolean maintainSessionAcrossRequests)
```
    Parameters:
    maintainSessionAcrossRequests - If set to true, created client will maintain HTTP session across multiple requests. Setting this to true also means that login attempt will be made for the 1st request for a new client or when the previous session has time out.
    
    Returns:
  - withUsernamePassword
```
public ClouderaManagerClientBuilder withUsernamePassword(String username,
                                                String password)
```
  - withConnectionTimeout
```
public ClouderaManagerClientBuilder withConnectionTimeout(long connectionTimeout,
                                                 TimeUnit connectionTimeoutUnits)
```
  - withReceiveTimeout
```
public ClouderaManagerClientBuilder withReceiveTimeout(long receiveTimeout,
                                              TimeUnit receiveTimeoutUnits)
```
  - disableTlsCertValidation
```
public ClouderaManagerClientBuilder disableTlsCertValidation()
```
  - disableTlsCnValidation
```
public ClouderaManagerClientBuilder disableTlsCnValidation()
```
  - enableStreamAutoClosure
```
public ClouderaManagerClientBuilder enableStreamAutoClosure()
```
    By default, ClouderaManagerClientBuilder disables auto-closure of response streams when generated client are making requests. This method enables this. If this is not enabled, caller of the client is responsible for closing the response streams.
    
    Returns:
    ClouderaManagerClientBuilder
  - setTrustManagers
```
public void setTrustManagers(TrustManager[] managers)
```
  - build
```
public ApiRootResource build()
```
    Build an ApiRootResource proxy object for communicating with the remote server.
    
    Returns:
    an ApiRootResource proxy object
  - build
```
protected <T> T build(Class<T> proxyType)
```
    Build a client proxy, for a specific proxy type.
    
    Parameters:
    proxyType - proxy type class
    
    Returns:
    client proxy stub
  - closeClient
```
public static void closeClient(Object root)
```
    Releases the internal state and configuration associated with this client. Reopening a new connection requires creating a new client object using the build() method in this builder.
    
    Parameters:
    root - The resource returned by the build() method of this builder class
  - clearCachedResources
```
public static void clearCachedResources()
```
    Clears any cached resources shared during build operations across instances of this class. This includes shared proxy/stub information, that will be automatically garbage collected when used heap memory in the JVM nears max heap memory in the JVM. In general, it is unnecessary to invoke this method, unless you are concerned with reducing used heap memory in the JVM.

Class ClouderaManagerClientBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TCP_PORT

DEFAULT_CONNECTION_TIMEOUT

DEFAULT_CONNECTION_TIMEOUT_UNITS

DEFAULT_RECEIVE_TIMEOUT

DEFAULT_RECEIVE_TIMEOUT_UNITS

Constructor Detail

ClouderaManagerClientBuilder

Method Detail

withAcceptLanguage

withBaseURL

withHost

withPort

enableTLS

enableLogging

setThreadSafe

setMaintainSessionAcrossRequests

withUsernamePassword

withConnectionTimeout

withReceiveTimeout

disableTlsCertValidation

disableTlsCnValidation

enableStreamAutoClosure

setTrustManagers

build

build

closeClient

clearCachedResources