play.libs.concurrent

Class HttpExecutionContext

java.lang.Object

play.libs.concurrent.HttpExecutionContext

@Singleton
public class HttpExecutionContext
extends java.lang.Object

Execution context for managing Play Java HTTP thread local state.

This is essentially a factory for getting an executor for the current HTTP context. Tasks executed by that executor will have the HTTP context setup in them.

For example, it may be used in combination with CompletionStage.thenApplyAsync, to ensure the callbacks executed when the completion stage is redeemed have the correct context:

     CompletionStage<WSResponse> response = ws.url(...).get();
     CompletionStage<Result> result = response.thenApplyAsync(response -> {
         return ok("Got response body " + ws.body() + " while executing request " + request().uri());
     }, httpExecutionContext.current());
 

Note, this is not a Scala execution context, and is not intended to be used where Scala execution contexts are required.

Constructor Summary

Constructors

Constructor and Description
HttpExecutionContext(java.util.concurrent.Executor delegate)

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.Executor	current() Get the current executor associated with the current HTTP context.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpExecutionContext

@Inject
public HttpExecutionContext(java.util.concurrent.Executor delegate)

Method Detail

current

public java.util.concurrent.Executor current()

Get the current executor associated with the current HTTP context.

Note that the returned executor is only valid for the current context. It should be used in a transient fashion, long lived references to it should not be kept.

Returns:

An executor that will execute its tasks in the current HTTP context.