Package de.xima.fc.proma.context
Interface IPublicPromaInvocationContext
-
- All Known Subinterfaces:
IPublicAsyncWebSocketContext
,IPublicNativeSyncContext
,IPublicPromaInvocationContextAsync
,IPublicPromaInvocationContextSync
,IPublicSyncWebSocketContext
public interface IPublicPromaInvocationContext
Context that controls how the PROMA API is accessed. An invocation context is required for each method of the variousAPI providers
.- Since:
- 8.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Duration
binaryTimeout()
de.xima.proma.restclient.pub.gen.ApiBundle
bundle()
Duration
combinedTimeout()
Supplier<IEntityContext>
entityContextFactory()
IPublicPromaCallInvoker
invoker()
boolean
sendsRequestsViaClient()
IStageChainFactory
stages()
Duration
timeout()
UserContext
userContext()
-
-
-
Method Detail
-
binaryTimeout
Duration binaryTimeout()
- Returns:
- Timeout for binary requests or "large" requests such as downloads that you expect might take a long time.
-
bundle
de.xima.proma.restclient.pub.gen.ApiBundle bundle()
- Returns:
- The API bundle to use, see
PromaManager
for obtaining bundles.
-
combinedTimeout
Duration combinedTimeout()
- Returns:
- Combined timeout for multiple plain text requests or "small" requests which you do not expect to take a long time.
-
entityContextFactory
Supplier<IEntityContext> entityContextFactory()
- Returns:
- The entity context factory to use for obtaining new entity context when required.
-
invoker
IPublicPromaCallInvoker invoker()
- Returns:
- Instance that is responsible for sending
ApiCall
. An invoker might prepare an API call by adding certain properties etc. or running the call in a different thread.
-
sendsRequestsViaClient
boolean sendsRequestsViaClient()
- Returns:
true
if the entire request or part of a request is sent via the browser of the user or requests data is in any way disclosed to the user and access is not strictly limited to the server only,false
otherwise.
-
stages
IStageChainFactory stages()
- Returns:
- A factory for prepared
response stages
.
-
timeout
Duration timeout()
- Returns:
- Timeout for plain text requests or "small" requests which you do not expect to take a long time.
-
userContext
UserContext userContext()
- Returns:
- User who initiated the action that resulted in a request to PROMA.
-
-