CommunityToolkit.Aspire.Hosting.Java

Docs/Reference/Search TypeScript APIs/CommunityToolkit.Aspire.Hosting.Java

CommunityToolkit.Aspire.Hosting.Java

Docs Reference Search TypeScript APIs CommunityToolkit.Aspire.Hosting.Java

📦 CommunityToolkit.Aspire.Hosting.Javav13.4.0

10Functions

2Types

Search types, functions, members in CommunityToolkit.Aspire.Hosting.Java...

handlemethodproperty

2 types and 2 membersClear filters

Types

handleJavaAppContainerResource

handleJavaAppExecutableResource7 members

Functions

methodaddJavaAppbuilder

Adds a Java application to the application model. Executes the executable Java app.

addJavaApp(name: string, workingDirectory: string): JavaAppExecutableResource

methodaddJavaAppWithJarbuilder

Adds a Java application to the application model. Executes the executable Java app.

addJavaAppWithJar(name: string, workingDirectory: string, jarPath: string, args?: string[]): JavaAppExecutableResource

methodaddJavaContainerAppbuilder

Adds a Java application to the application model. Executes the containerized Java app.

addJavaContainerApp(name: string, image: string, imageTag?: string): JavaAppContainerResource

methodwithGradleBuildbuilder

Adds a Gradle build step to the Java application

withGradleBuild(args: string[]): JavaAppExecutableResource

methodwithGradleTaskbuilder

Configures the Java application to run using a Gradle task

withGradleTask(task: string, args: string[]): JavaAppExecutableResource

methodwithJvmArgsbuilder

Configures the Java Virtual Machine arguments for the Java application. The arguments are set via the `JAVA_TOOL_OPTIONS` environment variable, which is recognized by the JVM regardless of how the application is launched (e.g., `java -jar`, Maven wrapper, or Gradle wrapper).

withJvmArgs(args: string[]): IResourceWithEnvironment

methodwithMavenBuildbuilder

Adds a Maven build step to the Java application

withMavenBuild(args: string[]): JavaAppExecutableResource

methodwithMavenGoalbuilder

Configures the Java application to run using a Maven goal

withMavenGoal(goal: string, args: string[]): JavaAppExecutableResource

methodwithOtelAgentbuilder

Configures the OpenTelemetry Java Agent for the Java application.

withOtelAgent(agentPath?: string): IResourceWithEnvironment

methodwithWrapperPathbuilder

Configures a custom build tool wrapper script path. This is useful when the wrapper script is not in the default location or has a non-standard name.

withWrapperPath(wrapperScript: string): JavaAppExecutableResource