public class KintoneClientBuilder
extends Object
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
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.
|
public static KintoneClientBuilder create(String baseUrl)
baseUrl
- the Kintone URLpublic static KintoneClient defaultClient(String baseUrl, String user, String password)
KintoneClient
with Password authentication.baseUrl
- the Kintone URLuser
- the login name of the userpassword
- the passwordpublic static KintoneClient defaultClient(String baseUrl, String apiToken)
KintoneClient
with API token authentication.baseUrl
- the Kintone URLapiToken
- the API tokenpublic static KintoneClient defaultClient(String baseUrl, List<String> apiTokens)
KintoneClient
with API token authentication using multiple API tokens.baseUrl
- the Kintone URLapiTokens
- the list of API tokenspublic KintoneClientBuilder withBasicAuth(String user, String password)
user
- the user of BASIC authenticationpassword
- the password of BASIC authenticationpublic KintoneClientBuilder authByPassword(String user, String password)
user
- the login name of the userpassword
- the passwordpublic KintoneClientBuilder authByApiToken(String apiToken)
apiToken
- the API tokenpublic KintoneClientBuilder authByApiToken(Collection<String> apiTokens)
apiTokens
- the list of API tokenspublic KintoneClientBuilder withProxy(String scheme, String hostname, int port)
scheme
- the proxy schemehostname
- the proxy server nameport
- the proxy portpublic KintoneClientBuilder setProxyAuthentication(String user, String password)
user
- the user for proxy authenticationpassword
- the password for proxy authenticationpublic KintoneClientBuilder withClientCertificate(Path certificate, String password)
certificate
- the path of client certificate filepassword
- the password for the certificatepublic KintoneClientBuilder withClientCertificate(InputStream stream, String password)
stream
- the input stream of client certificate datapassword
- the password for the certificatepublic KintoneClientBuilder setGuestSpaceId(long guestSpaceId)
guestSpaceId
- the Guest Space IDpublic KintoneClientBuilder setAppendixUserAgent(String appendixUserAgent)
appendixUserAgent
- the additional user agent stringpublic KintoneClientBuilder setConnectionTimeout(int connectionTimeout)
connectionTimeout
- the timeout in millisecondspublic KintoneClientBuilder setSocketTimeout(int socketTimeout)
socketTimeout
- the timeout in millisecondspublic KintoneClientBuilder setConnectionRequestTimeout(int connectionRequestTimeout)
connectionRequestTimeout
- the timeout in millisecondspublic KintoneClient build()