Package de.xima.fc.proma.context

Interface IPublicNativeSyncContextBuilder

All Superinterfaces:

IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

public interface IPublicNativeSyncContextBuilder
extends IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

A builder for a IPublicNativeSyncContext.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IPublicNativeSyncContextBuilder	binaryTimeout(Duration binaryTimeout)
IPublicNativeSyncContext	build()
IPublicNativeSyncContextBuilder	bundle(de.xima.proma.restclient.pub.gen.ApiBundle bundle)
IPublicNativeSyncContextBuilder	combinedTimeout(Duration combinedTimeout)
IPublicNativeSyncContextBuilder	entityContextFactory(Supplier<IEntityContext> entityContextFactory)
IPublicNativeSyncContextBuilder	timeout(Duration timeout)
IPublicNativeSyncContextBuilder	userContext(UserContext userContext)

Method Detail

binaryTimeout

IPublicNativeSyncContextBuilder binaryTimeout(Duration binaryTimeout)

Specified by:

binaryTimeout in interface IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

Parameters:

binaryTimeout - Timeout for plain text requests or "small" requests which you do not expect to take a long time.

Returns:

This builder instance for chaining method calls.

build

IPublicNativeSyncContext build()

Specified by:

build in interface IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

Returns:

A new invocation context with the current settings. Further modifications to this builder will not be reflected in the returned instance.

bundle

IPublicNativeSyncContextBuilder bundle(de.xima.proma.restclient.pub.gen.ApiBundle bundle)

Specified by:

bundle in interface IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

Parameters:

bundle - The API bundle to use, see PromaManager for obtaining bundles.

Returns:

This builder instance for chaining method calls.

combinedTimeout

IPublicNativeSyncContextBuilder combinedTimeout(Duration combinedTimeout)

Specified by:

combinedTimeout in interface IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

Parameters:

combinedTimeout - Combined timeout for multiple plain text requests or "small" requests which you do not expect to take a long time.

Returns:

This builder instance for chaining method calls.

entityContextFactory

IPublicNativeSyncContextBuilder entityContextFactory(Supplier<IEntityContext> entityContextFactory)

Specified by:

entityContextFactory in interface IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

Parameters:

entityContextFactory - The factory to use for obtaining new entity contexts.

Returns:

This builder instance for chaining method calls.

timeout

IPublicNativeSyncContextBuilder timeout(Duration timeout)

Specified by:

timeout in interface IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

Parameters:

timeout - Timeout for binary requests or "large" requests such as downloads that you expect might take a long time.

Returns:

This builder instance for chaining method calls.

userContext

IPublicNativeSyncContextBuilder userContext(UserContext userContext)

Specified by:

userContext in interface IPublicPromaInvocationContextBuilder<IPublicNativeSyncContext,IPublicNativeSyncContextBuilder>

Parameters:

userContext - User context of the user who initiated the PROMA request.

Returns:

This builder instance for chaining method calls.