Package org.nuxeo.client

Class NuxeoClient.Builder

java.lang.Object

org.nuxeo.client.objects.AbstractBase<NuxeoClient.Builder>

org.nuxeo.client.NuxeoClient.Builder

Enclosing class:

NuxeoClient

public static class NuxeoClient.Builder
extends AbstractBase<NuxeoClient.Builder>

NuxeoClient builder.

Since:

3.0

Field Summary

Fields

Modifier and Type	Field	Description
protected okhttp3.Interceptor	authenticationMethod
protected NuxeoResponseCache	cache
protected NuxeoConverterFactory	converterFactory

Fields inherited from class org.nuxeo.client.objects.AbstractBase

headerInterceptors, headerValues, okhttpBuilder, retrofit, retrofitBuilder

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NuxeoClient.Builder	authentication(java.lang.String username, java.lang.String password)
NuxeoClient.Builder	authentication(okhttp3.Interceptor authenticationMethod)
NuxeoClient	build()	Builds a NuxeoClient.
NuxeoClient.Builder	cache(NuxeoResponseCache cache)
NuxeoClient	connect()	Builds a NuxeoClient and log it, it will throw a NuxeoClientException if failed.
NuxeoClient.Builder	interceptor(okhttp3.Interceptor interceptor)
NuxeoClient.Builder	registerEntity(java.lang.String entityType, java.lang.Class<?> clazz)	Register entity type to class link for automatic unmarshalling process in operation.
NuxeoClient.Builder	url(java.lang.String url)

Methods inherited from class org.nuxeo.client.objects.AbstractBase

buildRetrofit, connectTimeout, depth, enrichers, enrichers, enrichersForDocument, fetchProperties, fetchProperties, fetchPropertiesForDocument, fetchPropertiesForGroup, header, header, header, header, header, header, header, readTimeout, replaceWith, retryOnConnectionFailure, schemas, schemas, timeout, transactionTimeout, version, writeTimeout

Methods inherited from class java.lang.Object

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

Field Detail

converterFactory

protected final NuxeoConverterFactory converterFactory

authenticationMethod

protected okhttp3.Interceptor authenticationMethod

cache

protected NuxeoResponseCache cache

Constructor Detail

Builder

public Builder()

Method Detail

url

public NuxeoClient.Builder url(java.lang.String url)

authentication

public NuxeoClient.Builder authentication(java.lang.String username,
                                          java.lang.String password)

authentication

public NuxeoClient.Builder authentication(okhttp3.Interceptor authenticationMethod)

interceptor

public NuxeoClient.Builder interceptor(okhttp3.Interceptor interceptor)

cache

public NuxeoClient.Builder cache(NuxeoResponseCache cache)

registerEntity

public NuxeoClient.Builder registerEntity(java.lang.String entityType,
                                          java.lang.Class<?> clazz)

Register entity type to class link for automatic unmarshalling process in operation.

CAUTION: this method is just a convenient way to register entity pojo. This operation is done in a static way on NuxeoConverterFactory.

build

public NuxeoClient build()

Builds a NuxeoClient.

Since:

3.6

connect

public NuxeoClient connect()

Builds a NuxeoClient and log it, it will throw a NuxeoClientException if failed.