GetActivityRequest.java

/*
 * Copyright 2016-2025 Berry Cloud Ltd. All rights reserved.
 */

package dev.learning.xapi.client;

import static dev.learning.xapi.client.XapiClientConstants.ACTIVITIES_PATH;
import static dev.learning.xapi.client.XapiClientConstants.ACTIVITY_ID_PARAM;
import static dev.learning.xapi.client.XapiClientConstants.ACTIVITY_ID_TEMPLATE;

import java.net.URI;
import java.util.Map;
import lombok.Builder;
import lombok.Getter;
import lombok.NonNull;
import org.springframework.http.HttpMethod;
import org.springframework.web.util.UriBuilder;

/**
 * Request for getting a single Activity.
 *
 * @see <a href=
 *     "https://github.com/adlnet/xAPI-Spec/blob/master/xAPI-Communication.md#full-activity-object-get">Full
 *     Activity Object GET</a>
 * @author Thomas Turrell-Croft
 * @author István Rátkai (Selindek)
 */
@Getter
@Builder
public class GetActivityRequest implements Request {

  @NonNull private final URI activityId;

  @Override
  public UriBuilder url(UriBuilder uriBuilder, Map<String, Object> queryParams) {

    queryParams.put(ACTIVITY_ID_PARAM, activityId);

    return uriBuilder.path(ACTIVITIES_PATH).queryParam(ACTIVITY_ID_PARAM, ACTIVITY_ID_TEMPLATE);
  }

  @Override
  public HttpMethod getMethod() {

    return HttpMethod.GET;
  }

  /** Builder for GetActivityRequest. */
  public static class Builder {

    /**
     * Sets the activityId.
     *
     * @param activityId The activityId of the GetActivityRequest.
     * @return This builder
     * @see GetActivityRequest#activityId
     */
    public Builder activityId(String activityId) {

      this.activityId = URI.create(activityId);

      return this;
    }

    /**
     * Sets the activityId.
     *
     * @param activityId The activityId of the GetActivityRequest.
     * @return This builder
     * @see GetActivityRequest#activityId
     */
    public Builder activityId(URI activityId) {

      this.activityId = activityId;

      return this;
    }
  }
}