example/java/rocketmq-multiagent-session-consistency/common-session-consistency/src/main/java/model/RocketMQRequest.java

/*
 * 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.
 */
package model;

/**
 * Represents a request sent from a client to an AI agent via RocketMQ.
 */
public class RocketMQRequest {
    /**
     * The user's input question to the AI agent.
     */
    private String question;

    /**
     * The RocketMQ topic used by the agent service to receive this request.
     */
    private String agentTopic;

    /**
     * The dedicated topic for receiving reply messages from the target agent (typically a lightweight topic).
     */
    private String workAgentResponseTopic;

    /**
     * The dedicated topic for receiving reply messages from the target agent.
     * Typically, a liteTopic that is bound to {@link #workAgentResponseTopic}.
     * LiteTopic is a session identifier, similar to a SessionId,
     * dynamically created at runtime for data storage and isolation.
     */
    private String liteTopic;

    /**
     * Unique identifier of the user initiating the request.
     */
    private String userId;

    /**
     * Unique identifier for tracking this specific task or conversation.
     */
    private String taskId;

    /**
     * Constructs a new RocketMQRequest instance.
     *
     * @param question the user's input question to the AI agent.
     * @param agentTopic the RocketMQ topic used by the agent service to receive this request.
     * @param workAgentResponseTopic the dedicated topic for receiving reply messages from the target agent (typically a
     * lightweight topic).
     * @param userId the unique identifier of the user initiating the request.
     * @param liteTopic the dedicated topic for receiving reply messages from the target agent.
     * typically, a liteTopic that is bound to {@link #workAgentResponseTopic}.
     * liteTopic is a lightweight session identifier, similar to a SessionId,
     * dynamically created at runtime for data storage and isolation.
     * @param taskId Unique identifier for tracking this specific task or conversation.
     */
    public RocketMQRequest(String question, String agentTopic, String workAgentResponseTopic, String userId,
        String liteTopic, String taskId) {
        this.question = question;
        this.agentTopic = agentTopic;
        this.workAgentResponseTopic = workAgentResponseTopic;
        this.userId = userId;
        this.liteTopic = liteTopic;
        this.taskId = taskId;
    }

    /**
     * Default constructor.
     */
    public RocketMQRequest() {}

    /**
     * Gets the user ID.
     */
    public String getUserId() {
        return userId;
    }

    /**
     * Sets the user ID.
     */
    public void setUserId(String userId) {
        this.userId = userId;
    }

    /**
     * Gets the user's input question.
     */
    public String getQuestion() {
        return question;
    }

    /**
     * Sets the user's input question.
     */
    public void setQuestion(String question) {
        this.question = question;
    }

    /**
     * Gets the agent topic.
     */
    public String getAgentTopic() {
        return agentTopic;
    }

    /**
     * Sets the agent topic.
     */
    public void setAgentTopic(String agentTopic) {
        this.agentTopic = agentTopic;
    }

    /**
     * Gets the work agent response topic.
     */
    public String getWorkAgentResponseTopic() {
        return workAgentResponseTopic;
    }

    /**
     * Sets the work agent response topic.
     */
    public void setWorkAgentResponseTopic(String workAgentResponseTopic) {
        this.workAgentResponseTopic = workAgentResponseTopic;
    }

    /**
     * Gets the lite topic.
     */
    public String getLiteTopic() {
        return liteTopic;
    }

    /**
     * Sets the lite topic.
     */
    public void setLiteTopic(String liteTopic) {
        this.liteTopic = liteTopic;
    }

    /**
     * Gets the task ID.
     */
    public String getTaskId() {
        return taskId;
    }

    /**
     * Sets the task ID.
     */
    public void setTaskId(String taskId) {
        this.taskId = taskId;
    }

    /**
     * Returns a new Builder instance for fluent construction.
     */
    public static Builder builder() {
        return new Builder();
    }

    /**
     * Builder class for constructing RocketMQRequest instances fluently.
     */
    public static class Builder {
        private final RocketMQRequest rocketMQRequest = new RocketMQRequest();

        /**
         * Sets the user's input question.
         */
        public Builder question(String question) {
            rocketMQRequest.setQuestion(question);
            return this;
        }

        /**
         * Sets the agent topic.
         */
        public Builder agentTopic(String agentTopic) {
            rocketMQRequest.setAgentTopic(agentTopic);
            return this;
        }

        /**
         * Sets the work agent response topic.
         */
        public Builder workAgentResponseTopic(String workAgentResponseTopic) {
            rocketMQRequest.setWorkAgentResponseTopic(workAgentResponseTopic);
            return this;
        }

        /**
         * Sets the user ID.
         */
        public Builder userId(String userId) {
            rocketMQRequest.setUserId(userId);
            return this;
        }

        /**
         * Sets the lite topic.
         */
        public Builder liteTopic(String liteTopic) {
            rocketMQRequest.setLiteTopic(liteTopic);
            return this;
        }

        /**
         * Sets the task ID.
         */
        public Builder taskId(String taskId) {
            rocketMQRequest.setTaskId(taskId);
            return this;
        }

        /**
         * Returns a new RocketMQRequest instance.
         */
        public RocketMQRequest build() {
            return rocketMQRequest;
        }
    }
}