com.cybozu.kintone.database

Class Connection

java.lang.Object

com.cybozu.kintone.database.Connection

public class Connection
extends java.lang.Object

kintone data access class.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CONTENT_TYPE

Constructor Summary

Constructors

Constructor and Description
Connection(java.lang.String domain, java.lang.String apiToken) Constructor
Connection(java.lang.String domain, java.lang.String login, java.lang.String password) Constructor

Method Summary

Modifier and Type	Method and Description
long	addComment(long app, long record, java.lang.String text, java.util.List<MentionDto> mentions) Add comment.
void	addHeader(java.lang.String name, java.lang.String value) Adds a user customized header.
void	bulkRequest(BulkRequest bulk) Build update.
void	close() Clears the settings of this connection.
void	delete(long app, java.util.List<java.lang.Long> ids) Deletes records.
void	delete(long app, long id) Deletes a record.
void	deleteByQuery(long app, java.lang.String query) Deletes records.
void	deleteComment(long app, long record, long id) Delete comment.
void	deleteRecord(long app, Record record) Deletes a record.
void	deleteRecords(long app, java.util.List<Record> records) Deletes records.
java.io.File	downloadFile(java.lang.String fileKey) Downloads a file.
AppDto	getApp(long id) Return the app information object
java.util.List<AppDto>	getApps(java.util.List<java.lang.Long> ids, java.util.List<java.lang.String> codes, java.lang.String name, java.util.List<java.lang.Long> spaceIds, long limit, long offset) Search apps with id, code or name
java.util.List<AppDto>	getApps(java.lang.String name) Search apps with name
CommentSet	getComments(long app, long record, boolean descending)
CommentSet	getComments(long app, long record, boolean descending, long limit, long offset) Get record comments
long	getGuestSpaceId()
java.util.List<java.lang.Long>	insert(long app, java.util.List<Record> records) Inserts new records.
long	insert(long app, Record record) Inserts a new record.
boolean	isTrustAllHosts() Returns if this connection trusts all hosts (for debug).
void	lazyUpload(Field field) Uploads the file binded with the field and sets the file key.
java.lang.String	request(java.lang.String method, java.lang.String api, java.lang.String body) Sends a request to kintone.
java.lang.String	request(java.lang.String method, java.lang.String api, java.lang.String body, java.io.File outFile) Sends a request to kintone.
ResultSet	select(long app, java.lang.String query) Selects the records from kintone using a query string.
ResultSet	select(long app, java.lang.String query, java.lang.String[] columns) Selects the records from kintone using a query string.
ResultSet	selectWithTotalCount(long app, java.lang.String query) Selects the records and total count from kintone using a query string.
ResultSet	selectWithTotalCount(long app, java.lang.String query, java.lang.String[] columns) Selects the records and total count from kintone using a query string.
void	setBasicAuth(java.lang.String username, java.lang.String password) Sets an basic authentication password.
void	setClientCert(java.lang.String cert, java.lang.String password) Sets the client certificate authentication.
void	setGuestSpaceId(long guestSpaceId)
void	setProxy(java.lang.String host, int port) Sets the proxy host.
void	setTrustAllHosts(boolean trustAllHosts) Sets to trust all hosts without verifying (for debug).
void	update(long app, java.util.List<java.lang.Long> ids, Record record) Updates records.
void	update(long app, long id, Record record) Updates a record(deprecated).
long	updateAssignees(long app, long id, java.util.List<java.lang.String> codes)
long	updateAssignees(long app, long id, java.util.List<java.lang.String> codes, long revision) Updates assignees.
void	updateByQuery(long app, java.lang.String query, Record record) Updates records.
long	updateRecord(long app, Record record) Updates a record.
long	updateRecordByKey(long app, java.lang.String key, Record record) Updates a record by specified key.
void	updateRecords(long app, java.util.List<Record> records) Updates records.
void	updateRecordsByKey(long app, java.lang.String key, java.util.List<Record> records) Updates records by specified key.
void	updateStatus(long app, java.util.List<java.lang.Long> ids, java.util.List<java.lang.String> actions, java.util.List<java.lang.String> assignees, java.util.List<java.lang.Long> revisions) Updates status.
long	updateStatus(long app, long id, java.lang.String action, java.lang.String assignee)
long	updateStatus(long app, long id, java.lang.String action, java.lang.String assignee, long revision) Updates status.
java.lang.String	uploadFile(java.io.File file) Uploads a file.
java.lang.String	uploadFile(java.io.File file, java.lang.String contentType) Uploads a file with the content type.
java.lang.String	uploadFile(java.lang.String contentType, java.io.InputStream file, java.lang.String fileName) Uploads a file from input stream.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_TYPE

public static final java.lang.String DEFAULT_CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

Connection

public Connection(java.lang.String domain,
                  java.lang.String login,
                  java.lang.String password)

Constructor

Parameters:

domain - FQDN. for example "example1.cybozu.com" or "example2.cybozu.cn" or "example3.kintone.com" .

login - login name

password - password of the login name

Connection

public Connection(java.lang.String domain,
                  java.lang.String apiToken)

Constructor

Parameters:

domain - FQDN. for example "example1.cybozu.com" or "example2.cybozu.cn" or "example3.kintone.com" .

apiToken - api Token

Method Detail

close

public void close()

Clears the settings of this connection.

isTrustAllHosts

public boolean isTrustAllHosts()

Returns if this connection trusts all hosts (for debug).

Returns:

true if this connection trusts all hosts

setTrustAllHosts

public void setTrustAllHosts(boolean trustAllHosts)

Sets to trust all hosts without verifying (for debug).

Parameters:

trustAllHosts -

setBasicAuth

public void setBasicAuth(java.lang.String username,
                         java.lang.String password)

Sets an basic authentication password.

Parameters:

username -

password -

getGuestSpaceId

public long getGuestSpaceId()

Returns:

the guestSpaceId

setGuestSpaceId

public void setGuestSpaceId(long guestSpaceId)

Parameters:

guestSpaceId - the guestSpaceId to set

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)

Adds a user customized header.

Parameters:

name - header name

value - header value

setProxy

public void setProxy(java.lang.String host,
                     int port)

Sets the proxy host.

Parameters:

host - proxy host

port - proxy port

setClientCert

public void setClientCert(java.lang.String cert,
                          java.lang.String password)

Sets the client certificate authentication.

Parameters:

cert - cert file path

password - cert password

request

public java.lang.String request(java.lang.String method,
                                java.lang.String api,
                                java.lang.String body)
                         throws DBException

Sends a request to kintone.

Parameters:

method - GET, POST, PUT or DELETE

api - api file path and query string

body - request data body

Returns:

response string

Throws:

DBException

request

public java.lang.String request(java.lang.String method,
                                java.lang.String api,
                                java.lang.String body,
                                java.io.File outFile)
                         throws DBException

Sends a request to kintone.

Parameters:

method - GET, POST, PUT or DELETE

api - api file path and query string

body - request data body

outFile - download file to the stream

Returns:

response string

Throws:

DBException

select

public ResultSet select(long app,
                        java.lang.String query)
                 throws DBException

Selects the records from kintone using a query string.

Parameters:

app - application id

query - query string

Returns:

ResultSet object

Throws:

DBException

selectWithTotalCount

public ResultSet selectWithTotalCount(long app,
                                      java.lang.String query)
                               throws DBException

Selects the records and total count from kintone using a query string.

Parameters:

app - application id

query - query string

Returns:

ResultSet object

Throws:

DBException

select

public ResultSet select(long app,
                        java.lang.String query,
                        java.lang.String[] columns)
                 throws DBException

Selects the records from kintone using a query string.

Parameters:

app - application id

query - query string

columns - column names if needed

Returns:

ResultSet object

Throws:

DBException

selectWithTotalCount

public ResultSet selectWithTotalCount(long app,
                                      java.lang.String query,
                                      java.lang.String[] columns)
                               throws DBException

Selects the records and total count from kintone using a query string.

Parameters:

app - application id

query - query string

columns - column names if needed

Returns:

ResultSet object

Throws:

DBException

insert

public long insert(long app,
                   Record record)
            throws DBException

Inserts a new record.

Parameters:

app - application id

record - The Record object to be inserted

Returns:

The id number of inserted record

Throws:

DBException

lazyUpload

public void lazyUpload(Field field)
                throws DBException

Uploads the file binded with the field and sets the file key.

Parameters:

field -

Throws:

DBException

insert

public java.util.List<java.lang.Long> insert(long app,
                                             java.util.List<Record> records)
                                      throws DBException

Inserts new records.

Parameters:

app - application id

records - The array of Record objects to be inserted

Returns:

The list of inserted id number

Throws:

DBException

update

public void update(long app,
                   long id,
                   Record record)
            throws DBException

Updates a record(deprecated).

Parameters:

app - application id

id - record number of the updated record

record - updated record object

Throws:

DBException

updateRecord

public long updateRecord(long app,
                         Record record)
                  throws DBException

Updates a record.

Parameters:

app - application id

record - updated record object

Returns:

new revision number

Throws:

DBException

update

public void update(long app,
                   java.util.List<java.lang.Long> ids,
                   Record record)
            throws DBException

Updates records.

Parameters:

app - application id

ids - an array of record numbers of the updated records

record - updated record object

Throws:

DBException

updateRecords

public void updateRecords(long app,
                          java.util.List<Record> records)
                   throws DBException

Updates records.

Parameters:

app - application id

records - an array of the updated record object

Throws:

DBException

updateByQuery

public void updateByQuery(long app,
                          java.lang.String query,
                          Record record)
                   throws DBException

Updates records.

Parameters:

app - application id

query - query string to determine the updated records

record - updated record object

Throws:

DBException

updateRecordByKey

public long updateRecordByKey(long app,
                              java.lang.String key,
                              Record record)
                       throws DBException

Updates a record by specified key.

Parameters:

app - application id

key - the key field

record - updated record object

Returns:

new revision number

Throws:

DBException

updateRecordsByKey

public void updateRecordsByKey(long app,
                               java.lang.String key,
                               java.util.List<Record> records)
                        throws DBException

Updates records by specified key.

Parameters:

app - application id

key - the key field

records - an array of the updated record object

Throws:

DBException

updateAssignees

public long updateAssignees(long app,
                            long id,
                            java.util.List<java.lang.String> codes,
                            long revision)
                     throws DBException

Updates assignees.

Parameters:

app - application id

id - record id

code - array of the code of the assigned users

revision - revision number (-1 means "not set")

Returns:

the new revision number

Throws:

DBException

updateAssignees

public long updateAssignees(long app,
                            long id,
                            java.util.List<java.lang.String> codes)
                     throws DBException

Throws:

DBException

updateStatus

public long updateStatus(long app,
                         long id,
                         java.lang.String action,
                         java.lang.String assignee,
                         long revision)
                  throws DBException

Updates status.

Parameters:

app - application id

id - record id

action - action name

assignee - login name of the assignee

revision - revision number (-1 means "not set")

Returns:

the new revision number

Throws:

DBException

updateStatus

public long updateStatus(long app,
                         long id,
                         java.lang.String action,
                         java.lang.String assignee)
                  throws DBException

Throws:

DBException

updateStatus

public void updateStatus(long app,
                         java.util.List<java.lang.Long> ids,
                         java.util.List<java.lang.String> actions,
                         java.util.List<java.lang.String> assignees,
                         java.util.List<java.lang.Long> revisions)
                  throws DBException

Updates status.

Parameters:

app - application id

ids - an array of the record id

actions - an array of the action name

assignees - an array of the login name of the assignee

revisions - an array of the revision number (-1 means "not set")

Throws:

DBException

delete

public void delete(long app,
                   long id)
            throws DBException

Deletes a record.

Parameters:

app - application id

id - record number to be deleted

Throws:

DBException

deleteRecord

public void deleteRecord(long app,
                         Record record)
                  throws DBException

Deletes a record.

Parameters:

app - application id

record - a record object to be deleted

Throws:

DBException

deleteRecords

public void deleteRecords(long app,
                          java.util.List<Record> records)
                   throws DBException

Deletes records.

Parameters:

app - application id

records - a list of the record object to be deleted

Throws:

DBException

delete

public void delete(long app,
                   java.util.List<java.lang.Long> ids)
            throws DBException

Deletes records.

Parameters:

app - application id

ids - a list of record numbers to be deleted

Throws:

DBException

deleteByQuery

public void deleteByQuery(long app,
                          java.lang.String query)
                   throws DBException

Deletes records.

Parameters:

app - application id

query - query string to determine the deleted records

Throws:

DBException

uploadFile

public java.lang.String uploadFile(java.io.File file,
                                   java.lang.String contentType)
                            throws DBException

Uploads a file with the content type.

Parameters:

file - file object to be uploaded

contentType - content type

Returns:

file key

Throws:

DBException

uploadFile

public java.lang.String uploadFile(java.io.File file)
                            throws DBException

Uploads a file.

Parameters:

file - file object to be uploaded

Returns:

file key

Throws:

DBException

uploadFile

public java.lang.String uploadFile(java.lang.String contentType,
                                   java.io.InputStream file,
                                   java.lang.String fileName)
                            throws DBException

Uploads a file from input stream.

Parameters:

contentType - content type

file - file object to be uploaded

fileName - upload file name

Returns:

file key

Throws:

DBException

downloadFile

public java.io.File downloadFile(java.lang.String fileKey)
                          throws java.io.IOException,
                                 DBException

Downloads a file.

Parameters:

fileKey - file key

Returns:

file object

Throws:

java.io.IOException

DBException

bulkRequest

public void bulkRequest(BulkRequest bulk)
                 throws DBException

Build update.

Parameters:

bulk - an instance of bulk request

Throws:

DBException

getApp

public AppDto getApp(long id)
              throws DBException

Return the app information object

Parameters:

id - app id

Returns:

app object

Throws:

DBException

getApps

public java.util.List<AppDto> getApps(java.lang.String name)
                               throws DBException

Search apps with name

Parameters:

name -

Returns:

the list of apps

Throws:

DBException

getApps

public java.util.List<AppDto> getApps(java.util.List<java.lang.Long> ids,
                                      java.util.List<java.lang.String> codes,
                                      java.lang.String name,
                                      java.util.List<java.lang.Long> spaceIds,
                                      long limit,
                                      long offset)
                               throws DBException

Search apps with id, code or name

Parameters:

ids -

codes -

name -

spaceIds -

limit -

offset -

Returns:

the list of apps

Throws:

DBException

addComment

public long addComment(long app,
                       long record,
                       java.lang.String text,
                       java.util.List<MentionDto> mentions)
                throws DBException

Add comment.

Parameters:

app - application id

record - record id

mentions - an array of mentions

Throws:

DBException

deleteComment

public void deleteComment(long app,
                          long record,
                          long id)
                   throws DBException

Delete comment.

Parameters:

app - application id

record - record id

id - comment id

Throws:

DBException

getComments

public CommentSet getComments(long app,
                              long record,
                              boolean descending,
                              long limit,
                              long offset)
                       throws DBException

Get record comments

Parameters:

app - application id

record - record id

descending - sort in a descending order if true

limit -

offset -

Returns:

the list of comments

Throws:

DBException

getComments

public CommentSet getComments(long app,
                              long record,
                              boolean descending)
                       throws DBException

Throws:

DBException