Package org.bonitasoft.web.client

Interface BonitaClient

All Superinterfaces:

ApiProvider

public interface BonitaClient
extends ApiProvider

A Bonita client that communicate via http request with a Bonita running instance.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADMIN_PROFILE_NAME
static String	DEFAULT_TENANT_ID
static String	USER_PROFILE_NAME

Method Summary

Modifier and Type	Method	Description
ApplicationService	applications()	Return the application API
BdmService	bdm()	Return the BDM API
static <T extends BonitaClientBuilder<T>> BonitaClientBuilder<T>	builder(String url)	Create a client builder for the given bonita URL
String	getUrl()	The Bonita target url (ie.
String	getVersion()	The targeted Bonita version
boolean	isPlatformUpAndRunning()	Return true if platform is up
Session	login(String username, String password)	Perform client authentication.
Session	login(String username, String password, String tenant)	Perform client authentication.
void	logout()	Logout the current user
void	logoutSilent()	Logout the current user (with no exceptions)
ProcessService	processes()	Return the process API
SystemService	system()	Return the system tenant API
UserService	users()	Return the user API

Methods inherited from interface org.bonitasoft.web.client.feign.ApiProvider

get

Field Detail

DEFAULT_TENANT_ID

static final String DEFAULT_TENANT_ID

See Also:

Constant Field Values

USER_PROFILE_NAME

static final String USER_PROFILE_NAME

See Also:

Constant Field Values

ADMIN_PROFILE_NAME

static final String ADMIN_PROFILE_NAME

See Also:

Constant Field Values

Method Detail

builder

static <T extends BonitaClientBuilder<T>> BonitaClientBuilder<T> builder(String url)

Create a client builder for the given bonita URL

Parameters:

url - the bonita instance url

Returns:

a builder instance

login

Session login(String username,
              String password)

Perform client authentication. Authentication will be stored internally to be used for the future requests
Account tenant default to 1

Parameters:

username - Account username

password - Account password

Returns:

A session with the authenticated user info

Throws:

UnauthorizedException - if authentication failed

login

Session login(String username,
              String password,
              String tenant)

Perform client authentication. Authentication will be stored internally to be used for the future requests

Parameters:

username - Account username

password - Account password

tenant - Account tenant

Returns:

A session with the authenticated user info

Throws:

UnauthorizedException - if authentication failed

logout

void logout()

Logout the current user

logoutSilent

void logoutSilent()

Logout the current user (with no exceptions)

isPlatformUpAndRunning

boolean isPlatformUpAndRunning()

Return true if platform is up

Returns:

getUrl

String getUrl()

The Bonita target url (ie. http://localhost:8080/bonita/)

Returns:

getVersion

String getVersion()

The targeted Bonita version

Returns:

applications

ApplicationService applications()

Return the application API

Returns:

bdm

BdmService bdm()

Return the BDM API

Returns:

users

UserService users()

Return the user API

Returns:

processes

ProcessService processes()

Return the process API

Returns:

system

SystemService system()

Return the system tenant API

Returns: