Module com.azure.runtime.host
Package com.azure.runtime.host

Interface AppHost

public interface AppHost
The AppHost interface is the primary entry point for users to interact with the Java Runtime for Azure framework. It provides methods for booting the apphost, running it locally, and generating a manifest file for the apphost.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    boot(String... args)
    This is the primary front door through which users interact with the apphost.
    void
    configureApplication(DistributedApplication app)
    Called with a new DistributedApplication instance, allowing for the apphost to configure it.
    default void
    generateManifest(Path outputDir)
    Call this to generate a manifest file for the apphost.
    default void
    run()
    Call this from the main method of your AppHost implementation to run the apphost locally.

  • Method Details

    • boot

      default void boot(String... args)
      This is the primary front door through which users interact with the apphost. It can be called directly from the main method of your AppHost implementation. It will parse the runtime arguments and determine the mode of operation, and then proceed to execute the appropriate method.
      Parameters:
      args - An array of runtime arguments received when the application first starts.

    • run

      default void run()
      Call this from the main method of your AppHost implementation to run the apphost locally.

    • generateManifest

      default void generateManifest(Path outputDir)
      Call this to generate a manifest file for the apphost.

    • configureApplication

      void configureApplication(DistributedApplication app)
      Called with a new DistributedApplication instance, allowing for the apphost to configure it.