From 02438f0f06f0f5bcb4a7c9f19cd2ac378183356e Mon Sep 17 00:00:00 2001 From: mekkiamiri Date: Sat, 6 Dec 2025 13:52:47 +0100 Subject: [PATCH 1/3] feat: add spring boot starter --- contrib/adk-spring-boot-starter/.gitignore | 33 ++ .../.mvn/wrapper/maven-wrapper.properties | 3 + contrib/adk-spring-boot-starter/README.md | 101 ++++++ contrib/adk-spring-boot-starter/mvnw | 295 ++++++++++++++++++ contrib/adk-spring-boot-starter/mvnw.cmd | 189 +++++++++++ contrib/adk-spring-boot-starter/pom.xml | 47 +++ .../AdkArtifactsAutoConfiguration.java | 35 +++ .../AdkMemoryAutoConfiguration.java | 21 ++ .../AdkRunConfigAutoConfiguration.java | 21 ++ .../AdkSessionAutoConfiguration.java | 29 ++ .../properties/AdkArtifactProperties.java | 25 ++ .../properties/AdkMemoryProperties.java | 20 ++ .../properties/AdkRunConfigProperties.java | 17 + .../properties/AdkSessionProperties.java | 38 +++ ...ot.autoconfigure.AutoConfiguration.imports | 4 + contrib/samples/pom.xml | 1 + .../spring-boot-adk-template/.gitattributes | 2 + .../spring-boot-adk-template/.gitignore | 33 ++ .../.mvn/wrapper/maven-wrapper.properties | 3 + .../spring-boot-adk-template/README.md | 76 +++++ contrib/samples/spring-boot-adk-template/mvnw | 295 ++++++++++++++++++ .../samples/spring-boot-adk-template/mvnw.cmd | 189 +++++++++++ .../samples/spring-boot-adk-template/pom.xml | 51 +++ .../SpringBootAdkTemplate/AgentService.java | 22 ++ .../SpringBootAdkTemplateApplication.java | 47 +++ .../config/AgentConfig.java | 33 ++ .../src/main/resources/application.yaml | 3 + ...SpringBootAdkTemplateApplicationTests.java | 13 + pom.xml | 1 + 29 files changed, 1647 insertions(+) create mode 100644 contrib/adk-spring-boot-starter/.gitignore create mode 100644 contrib/adk-spring-boot-starter/.mvn/wrapper/maven-wrapper.properties create mode 100644 contrib/adk-spring-boot-starter/README.md create mode 100755 contrib/adk-spring-boot-starter/mvnw create mode 100644 contrib/adk-spring-boot-starter/mvnw.cmd create mode 100644 contrib/adk-spring-boot-starter/pom.xml create mode 100644 contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkArtifactsAutoConfiguration.java create mode 100644 contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkMemoryAutoConfiguration.java create mode 100644 contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkRunConfigAutoConfiguration.java create mode 100644 contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkSessionAutoConfiguration.java create mode 100644 contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkArtifactProperties.java create mode 100644 contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkMemoryProperties.java create mode 100644 contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkRunConfigProperties.java create mode 100644 contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkSessionProperties.java create mode 100644 contrib/adk-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports create mode 100644 contrib/samples/spring-boot-adk-template/.gitattributes create mode 100644 contrib/samples/spring-boot-adk-template/.gitignore create mode 100644 contrib/samples/spring-boot-adk-template/.mvn/wrapper/maven-wrapper.properties create mode 100644 contrib/samples/spring-boot-adk-template/README.md create mode 100755 contrib/samples/spring-boot-adk-template/mvnw create mode 100644 contrib/samples/spring-boot-adk-template/mvnw.cmd create mode 100644 contrib/samples/spring-boot-adk-template/pom.xml create mode 100644 contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/AgentService.java create mode 100644 contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplication.java create mode 100644 contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/config/AgentConfig.java create mode 100644 contrib/samples/spring-boot-adk-template/src/main/resources/application.yaml create mode 100644 contrib/samples/spring-boot-adk-template/src/test/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplicationTests.java diff --git a/contrib/adk-spring-boot-starter/.gitignore b/contrib/adk-spring-boot-starter/.gitignore new file mode 100644 index 00000000..667aaef0 --- /dev/null +++ b/contrib/adk-spring-boot-starter/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/contrib/adk-spring-boot-starter/.mvn/wrapper/maven-wrapper.properties b/contrib/adk-spring-boot-starter/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..c0bcafe9 --- /dev/null +++ b/contrib/adk-spring-boot-starter/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,3 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip diff --git a/contrib/adk-spring-boot-starter/README.md b/contrib/adk-spring-boot-starter/README.md new file mode 100644 index 00000000..6015a166 --- /dev/null +++ b/contrib/adk-spring-boot-starter/README.md @@ -0,0 +1,101 @@ +# ADK Spring Boot Starter + +This starter integrates the Google Agent Development Kit (ADK) into Spring Boot applications. It provides auto-configuration for Agents, Runners, and core services like Artifacts, Session, and Memory management. + +## Installation + +Add the following dependency to your `pom.xml`: + +```xml + + com.google.adk + adk-spring-boot-starter + ${adk-starter.version} + +``` + +## Configuration + +By default, the starter configures all services to use **In-Memory** implementations. This is great for local development and testing. + +You can configure the behavior using `application.yaml`: + +### 1. Artifacts Service + +* **Default**: `InMemoryArtifactService` +* **Production**: `GcsArtifactService` (Google Cloud Storage) + +To enable GCS: + +```yaml +adk: + artifacts: + gcs-enabled: true + bucket-name: "my-agent-artifacts-bucket" +``` + +### 2. Session Service + +* **Default**: `InMemorySessionService` +* **Production**: `VertexAiSessionService` + +To enable Vertex AI Sessions: + +```yaml +adk: + session: + type: VERTEX_AI + project-id: "my-gcp-project" + location: "us-central1" +``` + +### 3. Memory Service + +* **Default**: `InMemoryMemoryService` + +Currently, only In-Memory memory service is supported by default. + + +### 4. Run Configuration + +* **Default Streaming Mode**: `NONE` + +To enable streaming (e.g., SSE or BIDI): + +```yaml +adk: + run-config: + streaming-mode: SSE # Options: NONE, SSE, BIDI +``` + +*Note: Other `RunConfig` options (like modalities, audio config) will be added in future versions.* + +## Architecture + +The starter follows the Single Responsibility Principle by splitting configuration into: +* `AdkArtifactsAutoConfiguration` +* `AdkSessionAutoConfiguration` +* `AdkMemoryAutoConfiguration` +* `AdkRunConfigAutoConfiguration` + +Each has its own properties class (e.g., `AdkArtifactProperties`). + +## Usage + +Simply inject the beans into your application: + +```java +@Service +public class MyAgentService { + + private final Runner runner; + // Agent bean is no longer auto-configured by default. + // You must define your own Agent bean or use the Runner directly. + + public MyAgentService(Runner runner) { + this.runner = runner; + } + + // ... use runner +} +``` diff --git a/contrib/adk-spring-boot-starter/mvnw b/contrib/adk-spring-boot-starter/mvnw new file mode 100755 index 00000000..bd8896bf --- /dev/null +++ b/contrib/adk-spring-boot-starter/mvnw @@ -0,0 +1,295 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + if [ -n "${JAVA_HOME-}" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/contrib/adk-spring-boot-starter/mvnw.cmd b/contrib/adk-spring-boot-starter/mvnw.cmd new file mode 100644 index 00000000..92450f93 --- /dev/null +++ b/contrib/adk-spring-boot-starter/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/contrib/adk-spring-boot-starter/pom.xml b/contrib/adk-spring-boot-starter/pom.xml new file mode 100644 index 00000000..0bbfe68a --- /dev/null +++ b/contrib/adk-spring-boot-starter/pom.xml @@ -0,0 +1,47 @@ + + + 4.0.0 + com.google.adk + adk-spring-boot-starter + 0.4.1-SNAPSHOT + jar + adk-spring-boot-starter + ADK Spring Boot Starter + + + 21 + 4.0.0 + + + + + org.springframework.boot + spring-boot-starter + ${spring-boot.version} + + + org.springframework.boot + spring-boot-autoconfigure + ${spring-boot.version} + + + org.springframework.boot + spring-boot-configuration-processor + ${spring-boot.version} + true + + + com.google.adk + google-adk + ${project.version} + + + org.springframework.boot + spring-boot-dependencies + 3.3.0 + pom + import + + + diff --git a/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkArtifactsAutoConfiguration.java b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkArtifactsAutoConfiguration.java new file mode 100644 index 00000000..533b9790 --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkArtifactsAutoConfiguration.java @@ -0,0 +1,35 @@ +package com.google.adk.autoconfigure; + +import com.google.adk.artifacts.BaseArtifactService; +import com.google.adk.artifacts.GcsArtifactService; +import com.google.adk.artifacts.InMemoryArtifactService; +import com.google.adk.autoconfigure.properties.AdkArtifactProperties; +import com.google.cloud.storage.Storage; +import com.google.cloud.storage.StorageOptions; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; + +@AutoConfiguration +@EnableConfigurationProperties(AdkArtifactProperties.class) +public class AdkArtifactsAutoConfiguration { + + @Bean + @ConditionalOnProperty(prefix = "adk.artifacts", name = "gcs-enabled", havingValue = "true") + @ConditionalOnMissingBean + public Storage googleCloudStorage() { + return StorageOptions.getDefaultInstance().getService(); + } + + @Bean + @ConditionalOnMissingBean + public BaseArtifactService artifactService(AdkArtifactProperties properties) { + if (properties.isGcsEnabled()) { + Storage storage = StorageOptions.getDefaultInstance().getService(); + return new GcsArtifactService(properties.getBucketName(), storage); + } + return new InMemoryArtifactService(); + } +} diff --git a/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkMemoryAutoConfiguration.java b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkMemoryAutoConfiguration.java new file mode 100644 index 00000000..efb0b601 --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkMemoryAutoConfiguration.java @@ -0,0 +1,21 @@ +package com.google.adk.autoconfigure; + +import com.google.adk.autoconfigure.properties.AdkMemoryProperties; +import com.google.adk.memory.BaseMemoryService; +import com.google.adk.memory.InMemoryMemoryService; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; + +@AutoConfiguration +@EnableConfigurationProperties(AdkMemoryProperties.class) +public class AdkMemoryAutoConfiguration { + + @Bean + @ConditionalOnMissingBean + public BaseMemoryService memoryService(AdkMemoryProperties properties) { + // VertexAiMemoryService does not exist yet, defaulting to InMemory + return new InMemoryMemoryService(); + } +} diff --git a/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkRunConfigAutoConfiguration.java b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkRunConfigAutoConfiguration.java new file mode 100644 index 00000000..80363e5a --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkRunConfigAutoConfiguration.java @@ -0,0 +1,21 @@ +package com.google.adk.autoconfigure; + +import com.google.adk.agents.RunConfig; +import com.google.adk.autoconfigure.properties.AdkRunConfigProperties; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; + +@AutoConfiguration +@EnableConfigurationProperties(AdkRunConfigProperties.class) +public class AdkRunConfigAutoConfiguration { + + @Bean + @ConditionalOnMissingBean + public RunConfig runConfig(AdkRunConfigProperties properties) { + return RunConfig.builder() + .setStreamingMode(properties.getStreamingMode()) + .build(); + } +} diff --git a/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkSessionAutoConfiguration.java b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkSessionAutoConfiguration.java new file mode 100644 index 00000000..fc99e688 --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/AdkSessionAutoConfiguration.java @@ -0,0 +1,29 @@ +package com.google.adk.autoconfigure; + +import com.google.adk.autoconfigure.properties.AdkSessionProperties; +import com.google.adk.sessions.BaseSessionService; +import com.google.adk.sessions.InMemorySessionService; +import com.google.adk.sessions.VertexAiSessionService; +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.context.annotation.Bean; +import java.util.Optional; + +@AutoConfiguration +@EnableConfigurationProperties(AdkSessionProperties.class) +public class AdkSessionAutoConfiguration { + + @Bean + @ConditionalOnMissingBean + public BaseSessionService sessionService(AdkSessionProperties properties) { + if (properties.getType() == AdkSessionProperties.Type.VERTEX_AI) { + return new VertexAiSessionService( + properties.getProjectId(), + properties.getLocation(), + Optional.empty(), + Optional.empty()); + } + return new InMemorySessionService(); + } +} diff --git a/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkArtifactProperties.java b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkArtifactProperties.java new file mode 100644 index 00000000..5f4772e4 --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkArtifactProperties.java @@ -0,0 +1,25 @@ +package com.google.adk.autoconfigure.properties; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +@ConfigurationProperties(prefix = "adk.artifacts") +public class AdkArtifactProperties { + private boolean gcsEnabled = false; + private String bucketName; + + public boolean isGcsEnabled() { + return gcsEnabled; + } + + public void setGcsEnabled(boolean gcsEnabled) { + this.gcsEnabled = gcsEnabled; + } + + public String getBucketName() { + return bucketName; + } + + public void setBucketName(String bucketName) { + this.bucketName = bucketName; + } +} diff --git a/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkMemoryProperties.java b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkMemoryProperties.java new file mode 100644 index 00000000..9ef4f7bd --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkMemoryProperties.java @@ -0,0 +1,20 @@ +package com.google.adk.autoconfigure.properties; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +@ConfigurationProperties(prefix = "adk.memory") +public class AdkMemoryProperties { + private Type type = Type.IN_MEMORY; + + public enum Type { + IN_MEMORY, VERTEX_AI + } + + public Type getType() { + return type; + } + + public void setType(Type type) { + this.type = type; + } +} diff --git a/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkRunConfigProperties.java b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkRunConfigProperties.java new file mode 100644 index 00000000..98f20439 --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkRunConfigProperties.java @@ -0,0 +1,17 @@ +package com.google.adk.autoconfigure.properties; + +import com.google.adk.agents.RunConfig; +import org.springframework.boot.context.properties.ConfigurationProperties; + +@ConfigurationProperties(prefix = "adk.run-config") +public class AdkRunConfigProperties { + private RunConfig.StreamingMode streamingMode = RunConfig.StreamingMode.NONE; + + public RunConfig.StreamingMode getStreamingMode() { + return streamingMode; + } + + public void setStreamingMode(RunConfig.StreamingMode streamingMode) { + this.streamingMode = streamingMode; + } +} diff --git a/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkSessionProperties.java b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkSessionProperties.java new file mode 100644 index 00000000..5d3c6eb0 --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/java/com/google/adk/autoconfigure/properties/AdkSessionProperties.java @@ -0,0 +1,38 @@ +package com.google.adk.autoconfigure.properties; + +import org.springframework.boot.context.properties.ConfigurationProperties; + +@ConfigurationProperties(prefix = "adk.session") +public class AdkSessionProperties { + private Type type = Type.IN_MEMORY; + private String projectId; + private String location; + + public enum Type { + IN_MEMORY, VERTEX_AI + } + + public Type getType() { + return type; + } + + public void setType(Type type) { + this.type = type; + } + + public String getProjectId() { + return projectId; + } + + public void setProjectId(String projectId) { + this.projectId = projectId; + } + + public String getLocation() { + return location; + } + + public void setLocation(String location) { + this.location = location; + } +} diff --git a/contrib/adk-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/contrib/adk-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 00000000..061132dd --- /dev/null +++ b/contrib/adk-spring-boot-starter/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1,4 @@ +com.google.adk.autoconfigure.AdkArtifactsAutoConfiguration +com.google.adk.autoconfigure.AdkSessionAutoConfiguration +com.google.adk.autoconfigure.AdkMemoryAutoConfiguration +com.google.adk.autoconfigure.AdkRunConfigAutoConfiguration diff --git a/contrib/samples/pom.xml b/contrib/samples/pom.xml index 234fd4e9..ec59fccf 100644 --- a/contrib/samples/pom.xml +++ b/contrib/samples/pom.xml @@ -21,5 +21,6 @@ configagent helloworld mcpfilesystem + spring-boot-adk-template diff --git a/contrib/samples/spring-boot-adk-template/.gitattributes b/contrib/samples/spring-boot-adk-template/.gitattributes new file mode 100644 index 00000000..3b41682a --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/.gitattributes @@ -0,0 +1,2 @@ +/mvnw text eol=lf +*.cmd text eol=crlf diff --git a/contrib/samples/spring-boot-adk-template/.gitignore b/contrib/samples/spring-boot-adk-template/.gitignore new file mode 100644 index 00000000..667aaef0 --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/.gitignore @@ -0,0 +1,33 @@ +HELP.md +target/ +.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/contrib/samples/spring-boot-adk-template/.mvn/wrapper/maven-wrapper.properties b/contrib/samples/spring-boot-adk-template/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 00000000..c0bcafe9 --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,3 @@ +wrapperVersion=3.3.4 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip diff --git a/contrib/samples/spring-boot-adk-template/README.md b/contrib/samples/spring-boot-adk-template/README.md new file mode 100644 index 00000000..f072d31f --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/README.md @@ -0,0 +1,76 @@ +# Spring Boot ADK Template + +This project is a Spring Boot application that serves as a template and verification app for the **Google ADK Spring Boot Starter**. + +It demonstrates how to integrate the Google Agent Development Kit (ADK) into a Spring Boot application using the custom starter. + +## Features + +* **ADK Integration**: Uses `adk-spring-boot-starter` for auto-configuration. +* **Agent Configuration**: Defines a sample `LlmAgent` bean. +* **Bean Verification**: Verifies the injection of core ADK components (`Runner`, `RunConfig`, `ArtifactService`, etc.) on startup. +* **Reactive Web**: Built on Spring WebFlux (though the current test scenario is console-based). + +## Prerequisites + +* Java 21 +* Maven +* **adk-spring-boot-starter**: This project depends on the local `adk-spring-boot-starter` artifact. You must build and install the starter first. + +## Getting Started + +### 1. Build the ADK Starter + +Before running this application, ensure the starter is installed in your local Maven repository: + +```bash +cd ../adk-spring-boot-starter +./mvnw clean install -DskipTests +``` + +### 2. Build and Run the Template + +```bash +cd ../SpringBootAdkTemplate +./mvnw spring-boot:run +``` + +### 3. Verify Output + +On successful startup, you should see logs indicating the ADK components have been initialized: + +```text +=== ADK Starter Verification === +Service Info: Agent created: LlmAgent, Runner: ... +Run Config streaming mode: NONE +RunConfig: com.google.adk.agents.RunConfig +Runner: com.google.adk.runner.Runner +BaseArtifactService: com.google.adk.artifacts.BaseArtifactService +... +================================ +``` + +## Configuration + +The application is configured via `src/main/resources/application.yaml`. + +Key ADK properties (managed by the starter): + +```yaml +adk: + run-config: + streaming-mode: NONE # Options: NONE, SSE, BIDI + artifacts: + gcs-enabled: false # Set to true to use Google Cloud Storage + # bucket-name: my-bucket + session: + type: IN_MEMORY # Options: IN_MEMORY, VERTEX_AI + memory: + type: IN_MEMORY +``` + +## Project Structure + +* `src/main/java/com/example/SpringBootAdkTemplate/config/AgentConfig.java`: Defines the `LlmAgent` and `Runner` beans. +* `src/main/java/com/example/SpringBootAdkTemplate/AgentService.java`: Service that uses the `Runner`. +* `src/main/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplication.java`: Main entry point with verification logic. diff --git a/contrib/samples/spring-boot-adk-template/mvnw b/contrib/samples/spring-boot-adk-template/mvnw new file mode 100755 index 00000000..bd8896bf --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/mvnw @@ -0,0 +1,295 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.4 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + if [ -n "${JAVA_HOME-}" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +scriptDir="$(dirname "$0")" +scriptName="$(basename "$0")" + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"$scriptDir/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${scriptName#mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c - >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +actualDistributionDir="" + +# First try the expected directory name (for regular distributions) +if [ -d "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" ]; then + if [ -f "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/bin/$MVN_CMD" ]; then + actualDistributionDir="$distributionUrlNameMain" + fi +fi + +# If not found, search for any directory with the Maven executable (for snapshots) +if [ -z "$actualDistributionDir" ]; then + # enable globbing to iterate over items + set +f + for dir in "$TMP_DOWNLOAD_DIR"/*; do + if [ -d "$dir" ]; then + if [ -f "$dir/bin/$MVN_CMD" ]; then + actualDistributionDir="$(basename "$dir")" + break + fi + fi + done + set -f +fi + +if [ -z "$actualDistributionDir" ]; then + verbose "Contents of $TMP_DOWNLOAD_DIR:" + verbose "$(ls -la "$TMP_DOWNLOAD_DIR")" + die "Could not find Maven distribution directory in extracted archive" +fi + +verbose "Found extracted Maven distribution directory: $actualDistributionDir" +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$actualDistributionDir/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$actualDistributionDir" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/contrib/samples/spring-boot-adk-template/mvnw.cmd b/contrib/samples/spring-boot-adk-template/mvnw.cmd new file mode 100644 index 00000000..92450f93 --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/mvnw.cmd @@ -0,0 +1,189 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.4 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" ("%__MVNW_CMD__%" %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND -eq $False) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace "^.*$MVNW_REPO_PATTERN",'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' + +$MAVEN_M2_PATH = "$HOME/.m2" +if ($env:MAVEN_USER_HOME) { + $MAVEN_M2_PATH = "$env:MAVEN_USER_HOME" +} + +if (-not (Test-Path -Path $MAVEN_M2_PATH)) { + New-Item -Path $MAVEN_M2_PATH -ItemType Directory | Out-Null +} + +$MAVEN_WRAPPER_DISTS = $null +if ((Get-Item $MAVEN_M2_PATH).Target[0] -eq $null) { + $MAVEN_WRAPPER_DISTS = "$MAVEN_M2_PATH/wrapper/dists" +} else { + $MAVEN_WRAPPER_DISTS = (Get-Item $MAVEN_M2_PATH).Target[0] + "/wrapper/dists" +} + +$MAVEN_HOME_PARENT = "$MAVEN_WRAPPER_DISTS/$distributionUrlNameMain" +$MAVEN_HOME_NAME = ([System.Security.Cryptography.SHA256]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null + +# Find the actual extracted directory name (handles snapshots where filename != directory name) +$actualDistributionDir = "" + +# First try the expected directory name (for regular distributions) +$expectedPath = Join-Path "$TMP_DOWNLOAD_DIR" "$distributionUrlNameMain" +$expectedMvnPath = Join-Path "$expectedPath" "bin/$MVN_CMD" +if ((Test-Path -Path $expectedPath -PathType Container) -and (Test-Path -Path $expectedMvnPath -PathType Leaf)) { + $actualDistributionDir = $distributionUrlNameMain +} + +# If not found, search for any directory with the Maven executable (for snapshots) +if (!$actualDistributionDir) { + Get-ChildItem -Path "$TMP_DOWNLOAD_DIR" -Directory | ForEach-Object { + $testPath = Join-Path $_.FullName "bin/$MVN_CMD" + if (Test-Path -Path $testPath -PathType Leaf) { + $actualDistributionDir = $_.Name + } + } +} + +if (!$actualDistributionDir) { + Write-Error "Could not find Maven distribution directory in extracted archive" +} + +Write-Verbose "Found extracted Maven distribution directory: $actualDistributionDir" +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$actualDistributionDir" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/contrib/samples/spring-boot-adk-template/pom.xml b/contrib/samples/spring-boot-adk-template/pom.xml new file mode 100644 index 00000000..76705e1e --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/pom.xml @@ -0,0 +1,51 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 4.0.0 + + + com.example + spring-boot-adk-template + 0.0.1-SNAPSHOT + spring-boot-adk-template + Spring Boot template with Adk SpringBoot Starter + + 21 + + + + org.springframework.boot + spring-boot-starter + + + + org.springframework.boot + spring-boot-starter-web + + + com.google.adk + adk-spring-boot-starter + 0.3.0 + + + + org.springframework.boot + spring-boot-starter-test + test + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + + diff --git a/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/AgentService.java b/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/AgentService.java new file mode 100644 index 00000000..a9633220 --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/AgentService.java @@ -0,0 +1,22 @@ +package com.example.SpringBootAdkTemplate; + +import com.google.adk.agents.LlmAgent; +import com.google.adk.runner.Runner; +import org.springframework.stereotype.Service; + +@Service +public class AgentService { + + private final Runner runner; + private final LlmAgent agent; + + public AgentService(Runner runner, LlmAgent agent) { + this.runner = runner; + this.agent = agent; + } + + public String getAgentInfo() { + return "Agent created: " + agent.getClass().getSimpleName() + + ", Runner: " + runner.getClass().getSimpleName(); + } +} diff --git a/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplication.java b/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplication.java new file mode 100644 index 00000000..19cd6684 --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplication.java @@ -0,0 +1,47 @@ +package com.example.SpringBootAdkTemplate; + +import com.google.adk.agents.RunConfig; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; +import org.springframework.context.ApplicationContext; + +@SpringBootApplication +public class SpringBootAdkTemplateApplication { + + public static void main(String[] args) { + ApplicationContext context = SpringApplication.run(SpringBootAdkTemplateApplication.class, args); + + // --- TEST SCENARIO FOR ADK STARTER (REMOVE IN PRODUCTION) --- + System.out.println("\n=== ADK Starter Verification ==="); + + // Verify AgentService and injected Agent + AgentService agentService = context.getBean(AgentService.class); + System.out.println("Service Info: " + agentService.getAgentInfo()); + + RunConfig runConfig = context.getBean(RunConfig.class); + System.out.println("Run Config streaming mode: " + runConfig.streamingMode()); + + // Verify Auto-Configured Beans + printBeanInfo(context, "com.google.adk.agents.RunConfig"); + printBeanInfo(context, "com.google.adk.runner.Runner"); + printBeanInfo(context, "com.google.adk.artifacts.BaseArtifactService"); + printBeanInfo(context, "com.google.adk.sessions.BaseSessionService"); + printBeanInfo(context, "com.google.adk.memory.BaseMemoryService"); + + System.out.println("================================\n"); + // ------------------------------------------------------------ + } + + private static void printBeanInfo(ApplicationContext context, String className) { + try { + Class clazz = Class.forName(className); + Object bean = context.getBean(clazz); + System.out.println(clazz.getSimpleName() + ": " + bean.getClass().getName()); + } catch (ClassNotFoundException e) { + System.out.println(className + ": Class not found"); + } catch (Exception e) { + System.out.println(className + ": Bean not found (" + e.getMessage() + ")"); + } + } + +} diff --git a/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/config/AgentConfig.java b/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/config/AgentConfig.java new file mode 100644 index 00000000..b4a97740 --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/src/main/java/com/example/SpringBootAdkTemplate/config/AgentConfig.java @@ -0,0 +1,33 @@ +package com.example.SpringBootAdkTemplate.config; + +import com.google.adk.agents.LlmAgent; +import com.google.adk.artifacts.BaseArtifactService; +import com.google.adk.memory.BaseMemoryService; +import com.google.adk.runner.Runner; +import com.google.adk.sessions.BaseSessionService; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class AgentConfig { + + @Bean + public LlmAgent llmAgent() { + return LlmAgent.builder() + .name("Agent") + .model("gemini-2.5-flash") + .instruction("Answer user questions to the best of your knowledge") + .build(); + } + + @Bean + public Runner runner(BaseArtifactService artifactService, BaseSessionService sessionService, + BaseMemoryService memoryService) { + return new Runner( + llmAgent(), + "appName", + artifactService, + sessionService, + memoryService); + } +} diff --git a/contrib/samples/spring-boot-adk-template/src/main/resources/application.yaml b/contrib/samples/spring-boot-adk-template/src/main/resources/application.yaml new file mode 100644 index 00000000..6cebbd52 --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/src/main/resources/application.yaml @@ -0,0 +1,3 @@ +spring: + application: + name: SpringBootAdkTemplate diff --git a/contrib/samples/spring-boot-adk-template/src/test/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplicationTests.java b/contrib/samples/spring-boot-adk-template/src/test/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplicationTests.java new file mode 100644 index 00000000..bfe888b1 --- /dev/null +++ b/contrib/samples/spring-boot-adk-template/src/test/java/com/example/SpringBootAdkTemplate/SpringBootAdkTemplateApplicationTests.java @@ -0,0 +1,13 @@ +package com.example.SpringBootAdkTemplate; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class SpringBootAdkTemplateApplicationTests { + + @Test + void contextLoads() { + } + +} diff --git a/pom.xml b/pom.xml index 6009c731..222822cf 100644 --- a/pom.xml +++ b/pom.xml @@ -38,6 +38,7 @@ tutorials/live-audio-single-agent a2a a2a/webservice + contrib/adk-spring-boot-starter From ef723eb734a87e11f4a5f7e5aba615fbc2c00546 Mon Sep 17 00:00:00 2001 From: mekkiamiri Date: Sat, 6 Dec 2025 14:17:23 +0100 Subject: [PATCH 2/3] feat: add spring boot starter --- contrib/adk-spring-boot-starter/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/contrib/adk-spring-boot-starter/README.md b/contrib/adk-spring-boot-starter/README.md index 6015a166..7c6a639b 100644 --- a/contrib/adk-spring-boot-starter/README.md +++ b/contrib/adk-spring-boot-starter/README.md @@ -1,6 +1,7 @@ # ADK Spring Boot Starter -This starter integrates the Google Agent Development Kit (ADK) into Spring Boot applications. It provides auto-configuration for Agents, Runners, and core services like Artifacts, Session, and Memory management. +This starter integrates the Google Agent Development Kit (ADK) into Spring Boot applications. +It provides auto-configuration for Runners, and core services like Artifacts, Session, and Memory management. ## Installation From 4f3123cde00bc904dd45f7c7b1331c3f91bc014c Mon Sep 17 00:00:00 2001 From: mekkiamiri Date: Sat, 6 Dec 2025 22:14:43 +0100 Subject: [PATCH 3/3] feat: add spring boot starter --- contrib/adk-spring-boot-starter/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/adk-spring-boot-starter/README.md b/contrib/adk-spring-boot-starter/README.md index 7c6a639b..c228999c 100644 --- a/contrib/adk-spring-boot-starter/README.md +++ b/contrib/adk-spring-boot-starter/README.md @@ -1,7 +1,7 @@ # ADK Spring Boot Starter This starter integrates the Google Agent Development Kit (ADK) into Spring Boot applications. -It provides auto-configuration for Runners, and core services like Artifacts, Session, and Memory management. +It provides auto-configuration for core services like Artifacts, Session, and Memory management. ## Installation