Class DefaultA2AClientBuilder<T>

java.lang.Object
dev.langchain4j.agentic.a2a.DefaultA2AClientBuilder<T>
All Implemented Interfaces:
A2AClientBuilder<T>, InternalAgent, AgentInstance, InvocationHandler

public class DefaultA2AClientBuilder<T> extends Object implements A2AClientBuilder<T>, InternalAgent, InvocationHandler
  • Method Details

    • build

      public T build()
      Description copied from interface: A2AClientBuilder
      Builds the A2A client proxy implementing the agent service interface.
      Specified by:
      build in interface A2AClientBuilder<T>
      Returns:
      the proxy instance
    • invoke

      public Object invoke(Object proxy, Method method, Object[] args) throws Exception
      Specified by:
      invoke in interface InvocationHandler
      Throws:
      Exception
    • name

      public DefaultA2AClientBuilder<T> name(String name)
      Description copied from interface: A2AClientBuilder
      Sets the name of the agent, from which its id in the reports, in the agents list sent to a supervisor and in the error handler context is derived. When not set, a typed agent takes the name of the annotation of its agent method or, when that is not set either, the name of the method, and an untyped one gets a placeholder derived from the host, port and path of the A2A server URL, so that the name is known without fetching the agent card, which happens only on the first invocation. The name never changes once the agent is built, even after the card has been fetched.
      Specified by:
      name in interface A2AClientBuilder<T>
      Parameters:
      name - the name of the agent, ignored when null or blank
      Returns:
      this builder for method chaining
    • description

      public DefaultA2AClientBuilder<T> description(String description)
      Description copied from interface: A2AClientBuilder
      Sets the description of the agent, used by the supervisor and the other planners to decide when to invoke it. When neither this method nor the annotation of the agent method set it, the description is read from the agent card, which is fetched on the first call to AgentInstance.description(): for a subagent of a supervisor this happens on the first invocation of the supervisor, which then depends on the availability of the remote agent, so an explicit description is recommended there.
      Specified by:
      description in interface A2AClientBuilder<T>
      Parameters:
      description - the description of the agent, ignored when null or blank
      Returns:
      this builder for method chaining
    • inputKeys

      public DefaultA2AClientBuilder<T> inputKeys(String... inputKeys)
      Description copied from interface: A2AClientBuilder
      Sets the state keys whose values will be sent as message parts to the remote agent.
      Specified by:
      inputKeys in interface A2AClientBuilder<T>
      Parameters:
      inputKeys - the names of the input keys
      Returns:
      this builder for method chaining
    • outputKey

      public DefaultA2AClientBuilder<T> outputKey(String outputKey)
      Description copied from interface: A2AClientBuilder
      Sets the state key under which the agent's response will be stored.
      Specified by:
      outputKey in interface A2AClientBuilder<T>
      Parameters:
      outputKey - the name of the output key
      Returns:
      this builder for method chaining
    • async

      public DefaultA2AClientBuilder<T> async(boolean async)
      Description copied from interface: A2AClientBuilder
      Sets whether the agent should be invoked asynchronously, allowing the workflow to continue without waiting for the agent's result. The result is awaited only where it is read: by another agent taking it as an argument, or by the output function or output key of the agentic system.

      When nothing reads the result, the call to the agentic system returns while the agent is still running, and the result or the failure of the agent is then reported only to its AgentListener. The next call on the same memory id waits for these agents to complete before it starts.

      Specified by:
      async in interface A2AClientBuilder<T>
      Parameters:
      async - true for asynchronous invocation
      Returns:
      this builder for method chaining
    • listener

      public DefaultA2AClientBuilder<T> listener(AgentListener agentListener)
      Description copied from interface: A2AClientBuilder
      Sets an AgentListener for observing agent invocations.
      Specified by:
      listener in interface A2AClientBuilder<T>
      Parameters:
      agentListener - the listener to attach
      Returns:
      this builder for method chaining
    • activationCondition

      public DefaultA2AClientBuilder<T> activationCondition(String description, Predicate<AgenticScope> activationCondition)
      Description copied from interface: A2AClientBuilder
      Sets the condition under which the agent runs when it is invoked as a subagent of an agentic system. When the condition is false the remote agent is not called and the agent is skipped. It can be evaluated more than once, so it must be free of side effects.
      Specified by:
      activationCondition in interface A2AClientBuilder<T>
      Parameters:
      description - a human-readable description of the condition, used in logs, listeners and reports
      activationCondition - the predicate deciding whether the agent runs
      Returns:
      this builder for method chaining
    • clientCustomizer

      public DefaultA2AClientBuilder<T> clientCustomizer(Consumer<?> clientCustomizer)
      Description copied from interface: A2AClientBuilder
      Sets a customizer that will be applied to the underlying a2a-java SDK ClientBuilder before the Client is constructed.

      The wildcard type avoids a compile-time dependency on the a2a-java SDK in this module. At runtime the value must be a Consumer<org.a2aproject.sdk.client.ClientBuilder>.

      Specified by:
      clientCustomizer in interface A2AClientBuilder<T>
      Parameters:
      clientCustomizer - a Consumer<ClientBuilder> from the a2a-java SDK
      Returns:
      this builder for method chaining
    • agentCardHeaders

      public DefaultA2AClientBuilder<T> agentCardHeaders(Supplier<Map<String,String>> headers)
      Description copied from interface: A2AClientBuilder
      Sets the HTTP headers used to fetch the remote agent card, for example an Authorization header. The supplier is called when the card is first needed, not when the agent is built, and again if a failed fetch is retried. A successfully fetched card is cached, so the supplier is not called on every invocation. It runs on the thread fetching the card, normally a thread of the LangChain4j executor.

      These headers apply only to agent card discovery. Configure authentication for A2A messages separately through A2AClientBuilder.clientCustomizer(Consumer).

      Specified by:
      agentCardHeaders in interface A2AClientBuilder<T>
      Parameters:
      headers - the supplier of request headers; null, or a supplier returning null or an empty map, sends no additional headers
      Returns:
      this builder for method chaining
    • resolutionTimeout

      public DefaultA2AClientBuilder<T> resolutionTimeout(Duration resolutionTimeout)
      Description copied from interface: A2AClientBuilder
      Sets the time given to the fetch of the agent card, which happens the first time the card is needed, normally on the first invocation of the agent, on a thread of the LangChain4j executor. It does not limit the messages sent to the agent. When the card is not fetched within this time the fetch is interrupted and the invocation fails with an A2AAgentCardException caused by a TimeoutException. Concurrent first invocations wait on the same fetch, so none of them waits longer than this time, and they all fail when it fails. An invocation arriving before the interrupted fetch has ended fails at once with the same timeout, and the next one after that fetches the card again. The default is 30 seconds, and a time of zero removes the limit: the card is then fetched by the first invocation needing it, on its own thread, and the fetch takes as long as the server of the agent makes it take.
      Specified by:
      resolutionTimeout in interface A2AClientBuilder<T>
      Parameters:
      resolutionTimeout - the time given to the fetch of the agent card, Duration.ZERO for no limit, or null for the default
      Returns:
      this builder for method chaining
    • streamingClientListener

      public A2AClientBuilder<T> streamingClientListener(A2AStreamingClientListener<?> clientListener)
      Description copied from interface: A2AClientBuilder
      Sets an A2AStreamingClientListener for observing updates received from the remote agent during streaming invocation.

      Like DefaultA2AClientBuilder, which uses a2a-java, can be used with the following example:

      streamingClientListener((TaskUpdateEvent event) -> {
          // handle the streaming event
      });
      

      The listener is invoked with task update events received from the remote agent.

      Specified by:
      streamingClientListener in interface A2AClientBuilder<T>
      Parameters:
      clientListener - the listener to attach
      Returns:
      this builder for method chaining
    • setParent

      public void setParent(InternalAgent parent)
      Specified by:
      setParent in interface InternalAgent
    • registerInheritedParentListener

      public void registerInheritedParentListener(AgentListener parentListener)
      Specified by:
      registerInheritedParentListener in interface InternalAgent
    • appendId

      public void appendId(String idSuffix)
      Specified by:
      appendId in interface InternalAgent
    • listener

      public AgentListener listener()
      Specified by:
      listener in interface InternalAgent
    • type

      public Class<?> type()
      Specified by:
      type in interface AgentInstance
    • plannerType

      public Class<? extends Planner> plannerType()
      Specified by:
      plannerType in interface AgentInstance
    • name

      public String name()
      The name is always known locally, without fetching the agent card: it is the explicit one, else the one of the annotation of the agent method, else the name of that method for a typed agent, else a placeholder derived from the A2A server URL. It never changes afterwards, not even when the card is fetched, because the agent id is derived from it.
      Specified by:
      name in interface AgentInstance
    • agentId

      public String agentId()
      Specified by:
      agentId in interface AgentInstance
    • description

      public String description()
      The explicit description, else the one of the agent card, which is fetched at this point if not yet done.
      Specified by:
      description in interface AgentInstance
    • outputType

      public Type outputType()
      Specified by:
      outputType in interface AgentInstance
    • outputKey

      public String outputKey()
      Specified by:
      outputKey in interface AgentInstance
    • async

      public boolean async()
      Specified by:
      async in interface AgentInstance
    • activationCondition

      public AgentCondition activationCondition()
      Description copied from interface: AgentInstance
      The condition under which this agent runs when it is invoked as a subagent, or null when it always runs. When the condition is false, the agent is skipped: it is not invoked, it writes nothing to the AgenticScope and its parent's planner is notified of the skip. The condition is ignored when the agent is invoked directly, as the root of an agentic system.

      The condition can be evaluated more than once for a single invocation, by the planner of the parent while selecting its next agents and again when the agent is invoked, so it must be cheap and free of side effects.

      Specified by:
      activationCondition in interface AgentInstance
    • arguments

      public List<AgentArgument> arguments()
      Specified by:
      arguments in interface AgentInstance
    • parent

      public AgentInstance parent()
      Specified by:
      parent in interface AgentInstance
    • subagents

      public List<AgentInstance> subagents()
      Specified by:
      subagents in interface AgentInstance
    • topology

      public AgenticSystemTopology topology()
      Specified by:
      topology in interface AgentInstance
    • tenant

      public DefaultA2AClientBuilder<T> tenant(String tenant)
      Description copied from interface: A2AClientBuilder
      Sets the tenant identifier that will be sent with every A2A message.
      Specified by:
      tenant in interface A2AClientBuilder<T>
      Parameters:
      tenant - the tenant identifier
      Returns:
      this builder for method chaining