Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
import org.a2aproject.sdk.spec.TaskPushNotificationConfig;
import org.a2aproject.sdk.spec.TaskQueryParams;
import org.a2aproject.sdk.spec.util.Utils;
import org.a2aproject.sdk.util.InterceptorPayloads;
import org.jspecify.annotations.Nullable;

public class JSONRPCTransport implements ClientTransport {
Expand Down Expand Up @@ -328,7 +329,7 @@ public void close() {
// no-op
}

private PayloadAndHeaders applyInterceptors(String methodName, @Nullable Object payload,
private PayloadAndHeaders applyInterceptors(String methodName, Object payload,
@Nullable AgentCard agentCard, @Nullable ClientCallContext clientCallContext) {
PayloadAndHeaders payloadAndHeaders = new PayloadAndHeaders(payload, getHttpHeaders(clientCallContext));
if (interceptors != null && ! interceptors.isEmpty()) {
Expand Down Expand Up @@ -362,7 +363,7 @@ private A2AHttpClient.PostBuilder createPostBuilder(
.addHeader("Content-Type", "application/json")
.addHeader(A2AHeaders.A2A_VERSION, AgentInterface.CURRENT_PROTOCOL_VERSION)
.followRedirects(followRedirects)
.body(JSONRPCUtils.toJsonRPCRequest(requestId, method, (MessageOrBuilder) payloadAndHeaders.getPayload()));
.body(JSONRPCUtils.toJsonRPCRequest(requestId, method, InterceptorPayloads.cast(payloadAndHeaders.getPayload(), MessageOrBuilder.class)));

if (payloadAndHeaders.getHeaders() != null) {
for (Map.Entry<String, String> entry : payloadAndHeaders.getHeaders().entrySet()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
import org.a2aproject.sdk.spec.TaskPushNotificationConfig;
import org.a2aproject.sdk.spec.TaskQueryParams;
import org.a2aproject.sdk.spec.util.Utils;
import org.a2aproject.sdk.util.InterceptorPayloads;
import org.jspecify.annotations.Nullable;

public class RestTransport implements ClientTransport {
Expand Down Expand Up @@ -441,8 +442,15 @@ public void subscribeToTask(TaskIdParams request, Consumer<StreamingEventKind> e
@Override
public AgentCard getExtendedAgentCard(GetExtendedAgentCardParams params, @Nullable ClientCallContext context) throws A2AClientException {
try {
PayloadAndHeaders payloadAndHeaders = applyInterceptors(GET_EXTENDED_AGENT_CARD_METHOD, null, agentCard, context);
String url = Utils.buildBaseUrl(agentInterface, params.tenant()) + "/extendedAgentCard";
org.a2aproject.sdk.grpc.GetExtendedAgentCardRequest.Builder builder = org.a2aproject.sdk.grpc.GetExtendedAgentCardRequest.newBuilder();
if (params.tenant() != null) {
builder.setTenant(params.tenant());
}
PayloadAndHeaders payloadAndHeaders = applyInterceptors(GET_EXTENDED_AGENT_CARD_METHOD, builder, agentCard, context);
org.a2aproject.sdk.grpc.GetExtendedAgentCardRequestOrBuilder interceptedRequest =
InterceptorPayloads.cast(payloadAndHeaders.getPayload(),
org.a2aproject.sdk.grpc.GetExtendedAgentCardRequestOrBuilder.class);
String url = Utils.buildBaseUrl(agentInterface, interceptedRequest.getTenant()) + "/extendedAgentCard";
A2AHttpClient.GetBuilder getBuilder = httpClient.createGet().url(url);
addStandardHeaders(getBuilder, payloadAndHeaders);
A2AHttpResponse response = getBuilder.get();
Expand All @@ -463,7 +471,7 @@ public void close() {
// no-op
}

private PayloadAndHeaders applyInterceptors(String methodName, @Nullable MessageOrBuilder payload,
private PayloadAndHeaders applyInterceptors(String methodName, MessageOrBuilder payload,
AgentCard agentCard, @Nullable ClientCallContext clientCallContext) {
PayloadAndHeaders payloadAndHeaders = new PayloadAndHeaders(payload, getHttpHeaders(clientCallContext));
if (interceptors != null && !interceptors.isEmpty()) {
Expand All @@ -476,7 +484,7 @@ private PayloadAndHeaders applyInterceptors(String methodName, @Nullable Message
}

private String sendPostRequest(String url, PayloadAndHeaders payloadAndHeaders) throws IOException, InterruptedException, JsonProcessingException {
MessageOrBuilder payload = (MessageOrBuilder) payloadAndHeaders.getPayload();
MessageOrBuilder payload = InterceptorPayloads.cast(payloadAndHeaders.getPayload(), MessageOrBuilder.class);
String body = payload != null ? ProtoJsonUtils.toJson(JsonFormat.printer(), payload) : "";
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(body);
Expand All @@ -495,7 +503,7 @@ private String sendPostRequest(String url, PayloadAndHeaders payloadAndHeaders)
private A2AHttpClient.PostBuilder createPostBuilder(
String url, PayloadAndHeaders payloadAndHeaders, boolean followRedirects)
throws JsonProcessingException, InvalidProtocolBufferException {
String body = ProtoJsonUtils.toJson(JsonFormat.printer(), (MessageOrBuilder) payloadAndHeaders.getPayload());
String body = ProtoJsonUtils.toJson(JsonFormat.printer(), InterceptorPayloads.cast(payloadAndHeaders.getPayload(), MessageOrBuilder.class));
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(body);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import static org.junit.jupiter.api.Assertions.assertInstanceOf;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockserver.model.HttpRequest.request;
import static org.mockserver.model.HttpResponse.response;
Expand Down Expand Up @@ -52,6 +53,7 @@
import org.a2aproject.sdk.spec.FilePart;
import org.a2aproject.sdk.spec.FileWithBytes;
import org.a2aproject.sdk.spec.FileWithUri;
import org.a2aproject.sdk.spec.GetExtendedAgentCardParams;
import org.a2aproject.sdk.spec.GetTaskPushNotificationConfigParams;
import org.a2aproject.sdk.spec.ListTaskPushNotificationConfigsParams;
import org.a2aproject.sdk.spec.ListTaskPushNotificationConfigsResult;
Expand Down Expand Up @@ -124,6 +126,68 @@ public void configBuilderEnablesRedirectFollowing() {
public RestTransportTest() {
}

@Test
public void testExtendedAgentCardUsesInterceptedTenant() throws Exception {
ClientCallInterceptor interceptor = new ClientCallInterceptor() {
@Override
public PayloadAndHeaders intercept(String methodName, Object payload,
java.util.Map<String, String> headers, AgentCard agentCard,
ClientCallContext clientCallContext) {
org.a2aproject.sdk.grpc.GetExtendedAgentCardRequest.Builder request =
(org.a2aproject.sdk.grpc.GetExtendedAgentCardRequest.Builder) payload;
assertEquals("original", request.getTenant());
return new PayloadAndHeaders(request.setTenant("intercepted").build(), headers);
}
};
server.when(request().withMethod("GET").withPath("/intercepted/extendedAgentCard"))
.respond(response().withStatusCode(200).withBody(new Gson().toJson(CARD)));

AgentInterface agentInterface = new AgentInterface("HTTP+JSON", "http://localhost:4001");
RestTransport client = new RestTransport(null, CARD, agentInterface, List.of(interceptor));
assertEquals(CARD.name(), client.getExtendedAgentCard(new GetExtendedAgentCardParams("original"), null).name());
}

@Test
public void testExtendedAgentCardInterceptorReceivesAbsentTenant() throws Exception {
AtomicReference<String> capturedTenant = new AtomicReference<>();
ClientCallInterceptor interceptor = new ClientCallInterceptor() {
@Override
public PayloadAndHeaders intercept(String methodName, Object payload,
java.util.Map<String, String> headers, AgentCard agentCard,
ClientCallContext clientCallContext) {
org.a2aproject.sdk.grpc.GetExtendedAgentCardRequestOrBuilder request =
(org.a2aproject.sdk.grpc.GetExtendedAgentCardRequestOrBuilder) payload;
capturedTenant.set(request.getTenant());
return new PayloadAndHeaders(payload, headers);
}
};
server.when(request().withMethod("GET").withPath("/extendedAgentCard"))
.respond(response().withStatusCode(200).withBody(new Gson().toJson(CARD)));

AgentInterface agentInterface = new AgentInterface("HTTP+JSON", "http://localhost:4001");
RestTransport client = new RestTransport(null, CARD, agentInterface, List.of(interceptor));
client.getExtendedAgentCard(new GetExtendedAgentCardParams(null), null);
assertEquals("", capturedTenant.get());
}

@Test
public void testExtendedAgentCardRejectsUnrelatedInterceptorPayload() {
ClientCallInterceptor interceptor = new ClientCallInterceptor() {
@Override
public PayloadAndHeaders intercept(String methodName, Object payload,
java.util.Map<String, String> headers, AgentCard agentCard, ClientCallContext context) {
return new PayloadAndHeaders("unexpected", headers);
}
};
AgentInterface agentInterface = new AgentInterface("HTTP+JSON", "http://localhost:4001");
RestTransport client = new RestTransport(null, CARD, agentInterface, List.of(interceptor));

IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
() -> client.getExtendedAgentCard(new GetExtendedAgentCardParams(null), null));
assertEquals("Interceptor payload must be org.a2aproject.sdk.grpc.GetExtendedAgentCardRequestOrBuilder; got java.lang.String",
exception.getMessage());
}

/**
* Test of sendMessage method, of class JSONRestTransport.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ public abstract class ClientCallInterceptor {
* Intercept a client call before the request is sent.
*
* @param methodName the name of the protocol method (e.g., 'message/send')
* @param payload the request payload
* @param payload the non-null request payload
* @param headers the headers to use
* @param agentCard the agent card (may be {@code null})
* @param clientCallContext the {@code ClientCallContext} for this call (may be {@code null})
* @return the potentially modified payload and headers
* @return the potentially modified payload and headers; the payload must not be null
*/
public abstract PayloadAndHeaders intercept(String methodName, @Nullable Object payload, Map<String, String> headers,
public abstract PayloadAndHeaders intercept(String methodName, Object payload, Map<String, String> headers,
@Nullable AgentCard agentCard, @Nullable ClientCallContext clientCallContext);
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,27 @@
import java.util.HashMap;
import java.util.Map;

import org.a2aproject.sdk.util.Assert;
import org.jspecify.annotations.Nullable;

public class PayloadAndHeaders {

private final @Nullable Object payload;
private final Object payload;
private final Map<String, String> headers;

public PayloadAndHeaders(@Nullable Object payload, @Nullable Map<String, String> headers) {
this.payload = payload;
/**
* Creates an interceptor result.
*
* @param payload the non-null request payload
* @param headers the request headers, or null for an empty map
* @throws IllegalArgumentException if payload is null
*/
public PayloadAndHeaders(Object payload, @Nullable Map<String, String> headers) {
this.payload = Assert.checkNotNullParam("payload", payload);
Comment thread
ehsavoie marked this conversation as resolved.
Resolved
this.headers = headers == null ? Collections.emptyMap() : new HashMap<>(headers);
}

public @Nullable Object getPayload() {
public Object getPayload() {
return payload;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public AuthInterceptor(final CredentialService credentialService) {
}

@Override
public PayloadAndHeaders intercept(String methodName, @Nullable Object payload, Map<String, String> headers,
public PayloadAndHeaders intercept(String methodName, Object payload, Map<String, String> headers,
@Nullable AgentCard agentCard, @Nullable ClientCallContext clientCallContext) {
Map<String, String> updatedHeaders = new HashMap<>(headers == null ? new HashMap<>() : headers);
if (agentCard == null || agentCard.securityRequirements()== null || agentCard.securitySchemes() == null) {
Expand All @@ -70,10 +70,10 @@ public PayloadAndHeaders intercept(String methodName, @Nullable Object payload,
}
if (securityScheme instanceof HTTPAuthSecurityScheme httpAuthSecurityScheme) {
String scheme = httpAuthSecurityScheme.scheme().toLowerCase(Locale.ROOT);
if (scheme.equals(BEARER_SCHEME)) {
if (BEARER_SCHEME.equals(scheme)) {
updatedHeaders.put(AUTHORIZATION, getBearerValue(credential));
return new PayloadAndHeaders(payload, updatedHeaders);
} else if (scheme.equals(BASIC_SCHEME)) {
} else if (BASIC_SCHEME.equals(scheme)) {
updatedHeaders.put(AUTHORIZATION, getBasicValue(credential));
return new PayloadAndHeaders(payload, updatedHeaders);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package org.a2aproject.sdk.client.transport.spi.interceptors;

import static org.junit.jupiter.api.Assertions.assertThrows;

import org.junit.jupiter.api.Test;

class PayloadAndHeadersTest {

@Test
void rejectsNullPayload() {
assertThrows(IllegalArgumentException.class, () -> new PayloadAndHeaders(null, null));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
package org.a2aproject.sdk.util;

import org.jspecify.annotations.Nullable;

/** Type checks for payloads returned by client interceptors. */
public final class InterceptorPayloads {

private InterceptorPayloads() {
}

/**
* Casts a non-null interceptor payload.
*
* @param payload the interceptor payload
* @param expectedType the expected payload type
* @param <T> the expected payload type
* @return the cast payload
* @throws IllegalArgumentException if the payload has an unexpected type
*/
public static <T> T cast(Object payload, Class<T> expectedType) {
return Assert.checkNotNullParam("payload", castNullable(payload, expectedType));
}

/** Casts a payload while preserving null for transports that allow it. */
public static <T> @Nullable T castNullable(@Nullable Object payload, Class<T> expectedType) {
if (payload != null && !expectedType.isInstance(payload)) {
throw new IllegalArgumentException("Interceptor payload must be " + expectedType.getName()
+ "; got " + payload.getClass().getName());
}
return expectedType.cast(payload);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package org.a2aproject.sdk.util;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertThrows;

import org.junit.jupiter.api.Test;

class InterceptorPayloadsTest {

@Test
void castsCompatiblePayloadsAndPreservesNull() {
String payload = "request";
assertSame(payload, InterceptorPayloads.cast(payload, CharSequence.class));
assertNull(InterceptorPayloads.castNullable(null, CharSequence.class));
}

@Test
void describesUnexpectedPayloadType() {
IllegalArgumentException exception = assertThrows(IllegalArgumentException.class,
() -> InterceptorPayloads.cast(42, CharSequence.class));
assertEquals("Interceptor payload must be java.lang.CharSequence; got java.lang.Integer", exception.getMessage());
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
import org.a2aproject.sdk.client.http.A2AHttpClient;
import org.a2aproject.sdk.client.http.A2AHttpClientFactory;
import org.a2aproject.sdk.client.http.A2AHttpResponse;
import org.a2aproject.sdk.client.http.ServerSentEvent;
import org.a2aproject.sdk.compat03.client.http.A2ACardResolver_v0_3;
import org.a2aproject.sdk.compat03.client.transport.rest.sse.RestSSEEventListener_v0_3;
import org.a2aproject.sdk.compat03.client.transport.spi.ClientTransport_v0_3;
Expand Down Expand Up @@ -57,6 +56,7 @@
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import org.a2aproject.sdk.grpc.utils.ProtoJsonUtils;
import org.a2aproject.sdk.util.InterceptorPayloads;
import org.jspecify.annotations.Nullable;

public class RestTransport_v0_3 implements ClientTransport_v0_3 {
Expand Down Expand Up @@ -339,7 +339,8 @@ public AgentCard_v0_3 getAgentCard(@Nullable ClientCallContext_v0_3 context) thr
if (!needsExtendedCard) {
return agentCard;
}
PayloadAndHeaders_v0_3 payloadAndHeaders = applyInterceptors(GetAuthenticatedExtendedCardRequest_v0_3.METHOD, null,
org.a2aproject.sdk.compat03.grpc.GetAgentCardRequestOrBuilder builder = org.a2aproject.sdk.compat03.grpc.GetAgentCardRequest.newBuilder();
PayloadAndHeaders_v0_3 payloadAndHeaders = applyInterceptors(GetAuthenticatedExtendedCardRequest_v0_3.METHOD, builder,
agentCard, context);
String url = agentUrl + String.format("/v1/card");
A2AHttpClient.GetBuilder getBuilder = httpClient.createGet().url(url);
Expand Down Expand Up @@ -368,7 +369,7 @@ public void close() {
// no-op
}

private PayloadAndHeaders_v0_3 applyInterceptors(String methodName, @Nullable MessageOrBuilder payload,
private PayloadAndHeaders_v0_3 applyInterceptors(String methodName, MessageOrBuilder payload,
AgentCard_v0_3 agentCard, @Nullable ClientCallContext_v0_3 clientCallContext) {
PayloadAndHeaders_v0_3 payloadAndHeaders = new PayloadAndHeaders_v0_3(payload, getHttpHeaders(clientCallContext));
if (interceptors != null && !interceptors.isEmpty()) {
Expand All @@ -381,7 +382,7 @@ private PayloadAndHeaders_v0_3 applyInterceptors(String methodName, @Nullable Me
}

private String sendPostRequest(String url, PayloadAndHeaders_v0_3 payloadAndHeaders) throws IOException, InterruptedException, JsonProcessingException_v0_3 {
MessageOrBuilder payload = (MessageOrBuilder) payloadAndHeaders.getPayload();
MessageOrBuilder payload = InterceptorPayloads.castNullable(payloadAndHeaders.getPayload(), MessageOrBuilder.class);
String body = payload != null ? ProtoJsonUtils.toJson(JsonFormat.printer(), payload) : "";
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(body);
Expand All @@ -398,7 +399,7 @@ private String sendPostRequest(String url, PayloadAndHeaders_v0_3 payloadAndHead
}

private A2AHttpClient.PostBuilder createPostBuilder(String url, PayloadAndHeaders_v0_3 payloadAndHeaders) throws JsonProcessingException_v0_3, InvalidProtocolBufferException {
String body = ProtoJsonUtils_v0_3.toJson(JsonFormat.printer(), (MessageOrBuilder) payloadAndHeaders.getPayload());
String body = ProtoJsonUtils_v0_3.toJson(JsonFormat.printer(), InterceptorPayloads.castNullable(payloadAndHeaders.getPayload(), MessageOrBuilder.class));
if (LOGGER.isLoggable(Level.FINE)) {
LOGGER.fine(body);
}
Expand Down
Loading
Loading