Package net.worcade.client.internal

Class WorcadeClient

java.lang.Object

net.worcade.client.internal.WorcadeClient

All Implemented Interfaces:

Worcade

public abstract class WorcadeClient
extends Object
implements Worcade

Field Summary

Fields

Modifier and Type	Field	Description
protected static Function<Object,IncomingDto>	DTO_FUNCTION
protected static String	PUBLIC_API

Fields inherited from interface net.worcade.client.Worcade

VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WorcadeClient(String baseUrl)

Method Summary

Modifier and Type	Method	Description
protected Result<? extends Worcade>	checkServerVersion()
protected abstract WorcadeClient	copy()
WorcadeClient	copyWithSameAuth()	Creates a copy of this client which uses the same internal client instance.
ExternalNumber	createExternalNumber(String number, String description)
OptionalField	createOptionalField(String name, String value, Reference owner)
RemoteId	createRemoteId(String remoteIdType, String remoteId)	Create a remote id object for use with RemoteIdsApi methods
Webhook.Header	createWebhookHeader(String name, String value)
WorkOrder.Row	createWorkOrderRow(String description, Duration duration, Double cost, Currency currency)
protected abstract Result<IncomingDto>	delete(String url, Object data, net.worcade.client.internal.Header... additionalHeader)
protected abstract Result<IncomingDto>	delete(String url, net.worcade.client.internal.Header... additionalHeader)
protected abstract Result<IncomingDto>	get(String url, net.worcade.client.internal.Header... additionalHeader)
Result<? extends Authentication>	getAuthentication()	Get information about the currently authenticated application and/or user, and the company and groups they are members of
protected abstract Result<BinaryData>	getBinary(String url, net.worcade.client.internal.Header... additionalHeader)
protected abstract Result<List<IncomingDto>>	getList(String url, net.worcade.client.internal.Header... additionalHeader)
Result<? extends Collection<? extends Notification>>	getNotifications()
Result<? extends Authentication>	getSecretAuthentication(String userId, String secret)
Result<?>	invalidateCurrentApiKey()
Result<ReferenceWithName>	loginApplication(String applicationId, PrivateKey applicationPrivateKey, PublicKey worcadePublicKey)	Login an application.
Result<ReferenceWithName>	loginUserByEmail(String email, String password)	Login a user by email address.
Result<ReferenceWithName>	loginUserById(String userId, String password)	Login a user by id.
Result<?>	logoutApplication()	Logout the current logged in user, invalidating the session token.
Result<?>	logoutUser()	Logout the current logged in user, invalidating the session token.
protected abstract Result<IncomingDto>	post(String url, Object data, net.worcade.client.internal.Header... additionalHeader)
protected abstract Result<IncomingDto>	postBinary(String url, InputStream data, String contentType, net.worcade.client.internal.Header... additionalHeader)
Result<Boolean>	probeUserTrust(String userId, String applicationId)	Checks if the given user trusts the given application.
protected abstract Result<IncomingDto>	put(String url, Object data, net.worcade.client.internal.Header... additionalHeader)
Result<ReferenceWithName>	setApplicationApiKey(String apiKey)
Result<ReferenceWithName>	setApplicationSourceAuth(String id)
Result<? extends Authentication>	setTrustedUser(Reference user)	Set a trusted user for the logged in application
Result<ReferenceWithName>	setUserApiKey(String apiKey)

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.worcade.client.Worcade

close, getApplicationApi, getAssetApi, getAttachmentApi, getChecklistApi, getCompanyApi, getContactsApi, getConversationApi, getGroupApi, getLabelApi, getReclaimApi, getRoomApi, getSearchApi, getSiteApi, getUserApi, getWebhookApi, getWorkOrderApi

Field Detail

PUBLIC_API

protected static String PUBLIC_API

DTO_FUNCTION

protected static final Function<Object,IncomingDto> DTO_FUNCTION

Constructor Detail

WorcadeClient

protected WorcadeClient(String baseUrl)

Method Detail

checkServerVersion

protected Result<? extends Worcade> checkServerVersion()

loginUserByEmail

public Result<ReferenceWithName> loginUserByEmail(String email,
                                                  String password)

Description copied from interface: Worcade

Login a user by email address. This call replaces all existing authentications.

Specified by:

loginUserByEmail in interface Worcade

Returns:

A reference to the logged in user

loginUserById

public Result<ReferenceWithName> loginUserById(String userId,
                                               String password)

Description copied from interface: Worcade

Login a user by id. This call replaces all existing authentications.

Specified by:

loginUserById in interface Worcade

Returns:

A reference to the logged in user

setUserApiKey

public Result<ReferenceWithName> setUserApiKey(String apiKey)

Specified by:

setUserApiKey in interface Worcade

logoutUser

public Result<?> logoutUser()

Description copied from interface: Worcade

Logout the current logged in user, invalidating the session token.

Specified by:

logoutUser in interface Worcade

loginApplication

public Result<ReferenceWithName> loginApplication(String applicationId,
                                                  PrivateKey applicationPrivateKey,
                                                  PublicKey worcadePublicKey)

Description copied from interface: Worcade

Login an application. This call replaces all existing authentications.

Specified by:

loginApplication in interface Worcade

Returns:

A reference to the logged in application

setApplicationSourceAuth

public Result<ReferenceWithName> setApplicationSourceAuth(String id)

Specified by:

setApplicationSourceAuth in interface Worcade

setApplicationApiKey

public Result<ReferenceWithName> setApplicationApiKey(String apiKey)

Specified by:

setApplicationApiKey in interface Worcade

setTrustedUser

public Result<? extends Authentication> setTrustedUser(Reference user)

Description copied from interface: Worcade

Set a trusted user for the logged in application

Specified by:

setTrustedUser in interface Worcade

Returns:

a failed result if the application does not trust the user, and a successful one otherwise

logoutApplication

public Result<?> logoutApplication()

Description copied from interface: Worcade

Logout the current logged in user, invalidating the session token.

Specified by:

logoutApplication in interface Worcade

invalidateCurrentApiKey

public Result<?> invalidateCurrentApiKey()

Specified by:

invalidateCurrentApiKey in interface Worcade

getSecretAuthentication

public Result<? extends Authentication> getSecretAuthentication(String userId,
                                                                String secret)

getAuthentication

public Result<? extends Authentication> getAuthentication()

Description copied from interface: Worcade

Get information about the currently authenticated application and/or user, and the company and groups they are members of

Specified by:

getAuthentication in interface Worcade

probeUserTrust

public Result<Boolean> probeUserTrust(String userId,
                                      String applicationId)

Description copied from interface: Worcade

Checks if the given user trusts the given application. The application must be authenticated to use this endpoint.

Specified by:

probeUserTrust in interface Worcade

Returns:

a result of `true` if the user trusts the application

getNotifications

public Result<? extends Collection<? extends Notification>> getNotifications()

Specified by:

getNotifications in interface Worcade

createRemoteId

public RemoteId createRemoteId(String remoteIdType,
                               String remoteId)

Description copied from interface: Worcade

Create a remote id object for use with RemoteIdsApi methods

Specified by:

createRemoteId in interface Worcade

createOptionalField

public OptionalField createOptionalField(String name,
                                         String value,
                                         Reference owner)

Specified by:

createOptionalField in interface Worcade

createExternalNumber

public ExternalNumber createExternalNumber(String number,
                                           String description)

Specified by:

createExternalNumber in interface Worcade

createWebhookHeader

public Webhook.Header createWebhookHeader(String name,
                                          String value)

Specified by:

createWebhookHeader in interface Worcade

createWorkOrderRow

public WorkOrder.Row createWorkOrderRow(String description,
                                        Duration duration,
                                        Double cost,
                                        Currency currency)

Specified by:

createWorkOrderRow in interface Worcade

copyWithSameAuth

public WorcadeClient copyWithSameAuth()

Description copied from interface: Worcade

Creates a copy of this client which uses the same internal client instance. This is useful if you need a client that's not logged in, a client logged in with an application only, and a client logged in with an application and user simultaneously. Note that calling Worcade.close() on any copied instance closes the internal client, and hence closes all copies.

Specified by:

copyWithSameAuth in interface Worcade

copy

protected abstract WorcadeClient copy()

get

protected abstract Result<IncomingDto> get(String url,
                                           net.worcade.client.internal.Header... additionalHeader)

getList

protected abstract Result<List<IncomingDto>> getList(String url,
                                                     net.worcade.client.internal.Header... additionalHeader)

getBinary

protected abstract Result<BinaryData> getBinary(String url,
                                                net.worcade.client.internal.Header... additionalHeader)

post

protected abstract Result<IncomingDto> post(String url,
                                            Object data,
                                            net.worcade.client.internal.Header... additionalHeader)

postBinary

protected abstract Result<IncomingDto> postBinary(String url,
                                                  InputStream data,
                                                  String contentType,
                                                  net.worcade.client.internal.Header... additionalHeader)

put

protected abstract Result<IncomingDto> put(String url,
                                           Object data,
                                           net.worcade.client.internal.Header... additionalHeader)

delete

protected abstract Result<IncomingDto> delete(String url,
                                              net.worcade.client.internal.Header... additionalHeader)

delete

protected abstract Result<IncomingDto> delete(String url,
                                              Object data,
                                              net.worcade.client.internal.Header... additionalHeader)