play.libs.ws.ahc.AhcWSComponents Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of play-ahc-ws_3 Show documentation

Play-AHC-WS

The newest version!

/*
 * Copyright (C) from 2022 The Play Framework Contributors , 2011-2021 Lightbend Inc. 
 */

package play.libs.ws.ahc;

import play.Environment;
import play.api.libs.ws.ahc.AsyncHttpClientProvider;
import play.components.ConfigurationComponents;
import play.components.PekkoComponents;
import play.inject.ApplicationLifecycle;
import play.libs.ws.StandaloneWSClient;
import play.libs.ws.WSClient;
import play.shaded.ahc.org.asynchttpclient.AsyncHttpClient;

/**
 * AsyncHttpClient WS implementation components.
 *
 * 
 *
 * 
Usage:
 *
 * 

 *
 * 
 * public class MyComponents extends BuiltInComponentsFromContext implements AhcWSComponents {
 *
 *   public MyComponents(ApplicationLoader.Context context) {
 *       super(context);
 *   }
 *
 *   // some service class that depends on WSClient
 *   public SomeService someService() {
 *       // wsClient is provided by AhcWSComponents
 *       return new SomeService(wsClient());
 *   }
 *
 *   // other methods
 * }
 * 
 *
 * @see play.BuiltInComponents
 * @see WSClient
 */
public interface AhcWSComponents
    extends WSClientComponents, ConfigurationComponents, PekkoComponents {

  Environment environment();

  ApplicationLifecycle applicationLifecycle();

  default WSClient wsClient() {
    return new AhcWSClient((StandaloneAhcWSClient) standaloneWSClient(), materializer());
  }

  default StandaloneWSClient standaloneWSClient() {
    return new StandaloneAhcWSClient(asyncHttpClient(), materializer());
  }

  default AsyncHttpClient asyncHttpClient() {
    return new AsyncHttpClientProvider(
            environment().asScala(),
            configuration(),
            applicationLifecycle().asScala(),
            executionContext())
        .get();
  }
}