Package com.ardoq

Class ArdoqClient

java.lang.Object

com.ardoq.ArdoqClient

public class ArdoqClient
extends Object

ArdoqClient connects to your Ardoq installation via it's REST-apis. You can connect with token authentication or username and password.

Author:

Erik Bakstad

Constructor Summary

Constructors

Constructor	Description
ArdoqClient(String endpoint, String token)	Connects to your Ardoq installation with token authentication.
ArdoqClient(String endpoint, String token, long connectionTimeoutSeconds, long readTimeoutSeconds)	Connects to your Ardoq installation with token authentication.
ArdoqClient(String endpoint, String username, String password)	Connects to Ardoq with username and password **We Strongly suggest that you connect with a token instead**
ArdoqClient(String endpoint, String username, String password, long connectionTimeoutSeconds, long readTimeoutSeconds)	Connects to Ardoq with username and password **We Strongly suggest that you connect with a token instead**
ArdoqClient(String endpoint, String username, String password, org.apache.http.client.config.RequestConfig defaultRequestConfig)	Connects to Ardoq with username and password and a custom request configuration **We Strongly suggest that you connect with a token instead**
ArdoqClient(String endpoint, String username, String password, org.apache.http.client.HttpClient client)	Connects to Ardoq with username and password, and a custom HTTP client **We Strongly suggest that you connect with a token instead**
ArdoqClient(String endpoint, String token, org.apache.http.client.config.RequestConfig defaultRequestConfig)	Connects to your Ardoq installation with token authentication and a custom request configuration.
ArdoqClient(String endpoint, String token, org.apache.http.client.HttpClient client)	Connects to Ardoq with token authentication, and a custom client

Method Summary

Modifier and Type	Method	Description
AttachmentService	attachment()
BatchService	batch()
ComponentService	component()
FieldService	field()
SimpleModelService	model()
ReferenceService	reference()
void	setLogLevel(retrofit.RestAdapter.LogLevel level)	Set log level
ArdoqClient	setOrganization(String org)	Sets the organization you wish to work on.
TagService	tag()
WorkspaceService	workspace()	Creates a workspaceService that allows you to do operations with our Workspace API

Methods inherited from class java.lang.Object

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

Constructor Details

ArdoqClient

public ArdoqClient(String endpoint, String token)

Connects to your Ardoq installation with token authentication.

Parameters:

endpoint - The Ardoq installation you wish to connect to (e.g. https://app.ardoq.com)

token - The token generated via Profile -> APIS token that you wish to authenticate with

ArdoqClient

public ArdoqClient(String endpoint, String token, org.apache.http.client.HttpClient client)

Connects to Ardoq with token authentication, and a custom client

Parameters:

endpoint - The Ardoq installation you wish to connect to (e.g. https://app.ardoq.com)

token - The token generated via Profile -> APIS token that you wish to authenticate with

client - pre-instantiated HttpClient

ArdoqClient

public ArdoqClient(String endpoint, String token, long connectionTimeoutSeconds, long readTimeoutSeconds)

Connects to your Ardoq installation with token authentication.

Parameters:

endpoint - The Ardoq installation you wish to connect to (e.g. https://app.ardoq.com)

token - The token generated via Profile -> APIS token that you wish to authenticate with

connectionTimeoutSeconds - HttpClient connection timeout in seconds (defaults to 15s)

readTimeoutSeconds - HttpClient read timeout in seconds (defaults to 20s)

ArdoqClient

public ArdoqClient(String endpoint, String token, org.apache.http.client.config.RequestConfig defaultRequestConfig)

Connects to your Ardoq installation with token authentication and a custom request configuration.

Parameters:

endpoint - The Ardoq installation you wish to connect to (e.g. https://app.ardoq.com)

token - The token generated via Profile -> APIS token that you wish to authenticate with

defaultRequestConfig - User provided org.apache.http.client.config.RequestConfig (for setting i.e. proxy settings etc.)

ArdoqClient

public ArdoqClient(String endpoint, String username, String password)

Connects to Ardoq with username and password **We Strongly suggest that you connect with a token instead**

Parameters:

endpoint - The Ardoq installation you wish to connect to (e.g. https://app.ardoq.com)

username - Your username

password - Your password

ArdoqClient

public ArdoqClient(String endpoint, String username, String password, org.apache.http.client.HttpClient client)

Connects to Ardoq with username and password, and a custom HTTP client **We Strongly suggest that you connect with a token instead**

Parameters:

endpoint - The Ardoq installation you wish to connect to (e.g. https://app.ardoq.com)

username - Your username

password - Your password

client - pre-instantiated HttpClient

ArdoqClient

public ArdoqClient(String endpoint, String username, String password, org.apache.http.client.config.RequestConfig defaultRequestConfig)

Connects to Ardoq with username and password and a custom request configuration **We Strongly suggest that you connect with a token instead**

Parameters:

endpoint - The Ardoq installation you wish to connect to (e.g. https://app.ardoq.com)

username - Your username

password - Your password

defaultRequestConfig - User provided org.apache.http.client.config.RequestConfig (for setting i.e. proxy settings etc.)

ArdoqClient

public ArdoqClient(String endpoint, String username, String password, long connectionTimeoutSeconds, long readTimeoutSeconds)

Connects to Ardoq with username and password **We Strongly suggest that you connect with a token instead**

Parameters:

endpoint - The Ardoq installation you wish to connect to (e.g. https://app.ardoq.com)

username - Your username

password - Your password

connectionTimeoutSeconds - HttpClient connection timeout in seconds (defaults to 15s)

readTimeoutSeconds - HttpClient read timeout in seconds (defaults to 20s)

Method Details

setLogLevel

public void setLogLevel(retrofit.RestAdapter.LogLevel level)

Set log level

Parameters:

level - log level

setOrganization

public ArdoqClient setOrganization(String org)

Sets the organization you wish to work on. If you have a private organization account, please use this!

Parameters:

org - The organization account, default is the global Ardoq account (Personal)

Returns:

this ArdoqClient

workspace

public WorkspaceService workspace()

Creates a workspaceService that allows you to do operations with our Workspace API

Returns:

WorkspaceService

component

public ComponentService component()

batch

public BatchService batch()

reference

public ReferenceService reference()

tag

public TagService tag()

field

public FieldService field()

attachment

public AttachmentService attachment()

model

public SimpleModelService model()