KintoneClientBuilder (kintone-java-client 2.4.0 API)

Object
- KintoneClientBuilder

```
public class KintoneClientBuilder
extends Object
```
A builder for KintoneClient.
First, creates an instance of the builder using create(String) with your Kintone URL.
```
 KintoneClientBuilder builder = KintoneClientBuilder.create("https://{your Kintone domain}.cybozu.com");
 
```
A client requires an authentication setting, sets using one of the following:
Other settings, like a Guest Space ID for specifying the operating Guest Space, Basic authentication settings and an additional user agent string, are optional. After completing the configurations, gets a KintoneClient by calling build().
```
 KintoneClient client = builder.authByPassword(user, password).build();
 
```
This class also provides shorthand methods for typical setups:
- defaultClient(String, String, String) for setup with Password authentication
- defaultClient(String, String) for setup with API token authentication
- defaultClient(String, List) for setup with API token authentication using multiple tokens

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KintoneClientBuilder`	`authByApiToken(Collection<String> apiTokens)` Sets API token authentication.
`KintoneClientBuilder`	`authByApiToken(String apiToken)` Sets API token authentication.
`KintoneClientBuilder`	`authByPassword(String user, String password)` Sets Password authentication.
`KintoneClient`	`build()`
`static KintoneClientBuilder`	`create(String baseUrl)` Returns an instance of this builder.
`static KintoneClient`	`defaultClient(String baseUrl, List<String> apiTokens)` Builds a `KintoneClient` with API token authentication using multiple API tokens.
`static KintoneClient`	`defaultClient(String baseUrl, String apiToken)` Builds a `KintoneClient` with API token authentication.
`static KintoneClient`	`defaultClient(String baseUrl, String user, String password)` Builds a `KintoneClient` with Password authentication.
`KintoneClientBuilder`	`setAppendixUserAgent(String appendixUserAgent)` Sets the additional user agent string.
`KintoneClientBuilder`	`setConnectionRequestTimeout(int connectionRequestTimeout)` Sets the connection request timeout in milliseconds.
`KintoneClientBuilder`	`setConnectionTimeout(int connectionTimeout)` Sets the connection timeout in milliseconds.
`KintoneClientBuilder`	`setGuestSpaceId(long guestSpaceId)` Sets the Guest Space ID for specifying the operating Guest Space.
`KintoneClientBuilder`	`setProxyAuthentication(String user, String password)` Sets the proxy authentication settings.
`KintoneClientBuilder`	`setSocketTimeout(int socketTimeout)` Sets the socket timeout in milliseconds.
`KintoneClientBuilder`	`withBasicAuth(String user, String password)` Sets the user and password for BASIC authentication.
`KintoneClientBuilder`	`withClientCertificate(InputStream stream, String password)` Sets the certificate for client certificate authentication.
`KintoneClientBuilder`	`withClientCertificate(Path certificate, String password)` Sets the certificate for client certificate authentication.
`KintoneClientBuilder`	`withProxy(String scheme, String hostname, int port)` Sets the proxy settings.

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

- Method Detail
  - create
```
public static KintoneClientBuilder create(String baseUrl)
```
    Returns an instance of this builder.
    
    Parameters:
    
    baseUrl - the Kintone URL
    
    Returns:
    
    the builder
  - defaultClient
```
public static KintoneClient defaultClient(String baseUrl,
                                          String user,
                                          String password)
```
    Builds a KintoneClient with Password authentication.
    
    Parameters:
    
    baseUrl - the Kintone URL
    
    user - the login name of the user
    
    password - the password
    
    Returns:
    
    the client
  - defaultClient
```
public static KintoneClient defaultClient(String baseUrl,
                                          String apiToken)
```
    Builds a KintoneClient with API token authentication.
    
    Parameters:
    
    baseUrl - the Kintone URL
    
    apiToken - the API token
    
    Returns:
    
    the client
  - defaultClient
```
public static KintoneClient defaultClient(String baseUrl,
                                          List<String> apiTokens)
```
    Builds a KintoneClient with API token authentication using multiple API tokens.
    
    Parameters:
    
    baseUrl - the Kintone URL
    
    apiTokens - the list of API tokens
    
    Returns:
    
    the client
  - withBasicAuth
```
public KintoneClientBuilder withBasicAuth(String user,
                                          String password)
```
    Sets the user and password for BASIC authentication. This is an optional setting.
    
    Parameters:
    
    user - the user of BASIC authentication
    
    password - the password of BASIC authentication
    
    Returns:
    
    this builder instance
  - authByPassword
```
public KintoneClientBuilder authByPassword(String user,
                                           String password)
```
    Sets Password authentication.
    
    Parameters:
    
    user - the login name of the user
    
    password - the password
    
    Returns:
    
    this builder instance
  - authByApiToken
```
public KintoneClientBuilder authByApiToken(String apiToken)
```
    Sets API token authentication.
    
    Parameters:
    
    apiToken - the API token
    
    Returns:
    
    this builder instance
  - authByApiToken
```
public KintoneClientBuilder authByApiToken(Collection<String> apiTokens)
```
    Sets API token authentication.
    
    Parameters:
    
    apiTokens - the list of API tokens
    
    Returns:
    
    this builder instance
  - withProxy
```
public KintoneClientBuilder withProxy(String scheme,
                                      String hostname,
                                      int port)
```
    Sets the proxy settings. This is an optional setting.
    
    Parameters:
    
    scheme - the proxy scheme
    
    hostname - the proxy server name
    
    port - the proxy port
    
    Returns:
    
    this builder instance
  - setProxyAuthentication
```
public KintoneClientBuilder setProxyAuthentication(String user,
                                                   String password)
```
    Sets the proxy authentication settings. This is an optional setting. Note that this library only supports the proxy authentication with Basic authentication scheme. Other authentication schemes, such as Digest access authentication scheme, are not supported.
    
    Parameters:
    
    user - the user for proxy authentication
    
    password - the password for proxy authentication
    
    Returns:
    
    this builder instance
  - withClientCertificate
```
public KintoneClientBuilder withClientCertificate(Path certificate,
                                                  String password)
```
    Sets the certificate for client certificate authentication. This is an optional setting.
    
    Parameters:
    
    certificate - the path of client certificate file
    
    password - the password for the certificate
    
    Returns:
    
    this builder instance
  - withClientCertificate
```
public KintoneClientBuilder withClientCertificate(InputStream stream,
                                                  String password)
```
    Sets the certificate for client certificate authentication. This is an optional setting.
    
    Parameters:
    
    stream - the input stream of client certificate data
    
    password - the password for the certificate
    
    Returns:
    
    this builder instance
  - setGuestSpaceId
```
public KintoneClientBuilder setGuestSpaceId(long guestSpaceId)
```
    Sets the Guest Space ID for specifying the operating Guest Space. To operate with a Guest Space or Apps in a Guest Space, this setting is required. Clients must be created for each Guest Space.
    
    Parameters:
    
    guestSpaceId - the Guest Space ID
    
    Returns:
    
    this builder instance
  - setAppendixUserAgent
```
public KintoneClientBuilder setAppendixUserAgent(String appendixUserAgent)
```
    Sets the additional user agent string. This is an optional setting.
    
    Parameters:
    
    appendixUserAgent - the additional user agent string
    
    Returns:
    
    this builder instance
  - setConnectionTimeout
```
public KintoneClientBuilder setConnectionTimeout(int connectionTimeout)
```
    Sets the connection timeout in milliseconds.
    
    Parameters:
    
    connectionTimeout - the timeout in milliseconds
    
    Returns:
    
    this builder instance
  - setSocketTimeout
```
public KintoneClientBuilder setSocketTimeout(int socketTimeout)
```
    Sets the socket timeout in milliseconds.
    
    Parameters:
    
    socketTimeout - the timeout in milliseconds
    
    Returns:
    
    this builder instance
  - setConnectionRequestTimeout
```
public KintoneClientBuilder setConnectionRequestTimeout(int connectionRequestTimeout)
```
    Sets the connection request timeout in milliseconds.
    
    Parameters:
    
    connectionRequestTimeout - the timeout in milliseconds
    
    Returns:
    
    this builder instance
  - build
```
public KintoneClient build()
```

Class KintoneClientBuilder

Method Summary

Methods inherited from class Object

Method Detail

create

defaultClient

defaultClient

defaultClient

withBasicAuth

authByPassword

authByApiToken

authByApiToken

withProxy

setProxyAuthentication

withClientCertificate

withClientCertificate

setGuestSpaceId

setAppendixUserAgent

setConnectionTimeout

setSocketTimeout

setConnectionRequestTimeout

build