Where is closeOnExit

[telemat]

In the documentation at https://twitter.github.io/finatra/user-guide/getting-started/modules.html#module-lifecycle, it is not clear how to import closeOnExit to be used inline for closing resources.

[cacoco]

Hi @telemat in the linked document, if you scroll down just a bit it shows how closeOnExit can be used by detailing an example TwitterModule extension. FWIW, is not necessarily something to import as it is a function available on any subclass of TwitterModule. So to answer the underlying question, you extend TwitterModule and then you can call closeOnExit to register a callback that will be executed when the server is closed.

The example code:

import com.google.inject.Provides
import com.twitter.conversions.DurationOps._
import com.twitter.inject.{Injector, TwitterModule}
import com.twitter.inject.annotations.Flag
import com.twitter.util.Await
import javax.inject.Singleton

object MyModule extends TwitterModule {
  flag[Int]("configuration.param1", 42, "This is used to configure an instance of a Wicket")
  flag[Double]("configuration.param2", 123.45d, "This is also used to configure an instance of a Wicket")

  @Provides
  @Singleton
  def providesSomeClient(
    @Flag("configuration.param1") configurationParam1: Int,
    @Flag("configuration.param2") configurationParam2: Double
  ): SomeClient = {
    val client =
      new SomeClient(configurationParam1, configurationParam2)
        .withAnotherParam(b = true)
        .withSomeOtherConfiguration(137)

    closeOnExit {
       Await.result(client.close(), 2.seconds)
    }

    client
  }
}

[heligw]

TwitterModuleLifecycle.closeOnExit has been renamed to OnExit more details here https://github.com/twitter/finatra/commit/b8f00879bc3542e0e68f523c23ef46e4444f8d7b

[telemat]

Thanks, that was really helpful. Would help if the documentation is updated as well.