com.adobe.target.edge.client.TargetClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of target-java-sdk Show documentation

Adobe Target Java SDK

There is a newer version: 2.6.1

/*
 * Copyright 2021 Adobe. All rights reserved.
 * This file is licensed 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 REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package com.adobe.target.edge.client;

import com.adobe.target.edge.client.http.ResponseStatus;
import com.adobe.target.edge.client.model.TargetDeliveryRequest;
import com.adobe.target.edge.client.model.TargetDeliveryResponse;
import java.util.concurrent.CompletableFuture;

public interface TargetClient extends AutoCloseable {

  TargetDeliveryResponse getOffers(TargetDeliveryRequest request);

  CompletableFuture getOffersAsync(TargetDeliveryRequest request);

  ResponseStatus sendNotifications(TargetDeliveryRequest request);

  CompletableFuture sendNotificationsAsync(TargetDeliveryRequest request);

  /**
   * Makes a getOffers() call and converts all returned JSON offers into Attributes.
   *
   * @param targetRequest optional TargetDeliveryRequest that can be used to set specific request
   *     items such as Visitor, Context, etc. If null, one will be generated. Request for given mbox
   *     will be added automatically.
   * @param mboxes Name of mboxes to use to retrieve attributes.
   * @return Attributes object
   */
  Attributes getAttributes(TargetDeliveryRequest targetRequest, String... mboxes);

  /**
   * Makes an async getOffers() call and converts all returned JSON offers into Attributes.
   *
   * @param targetRequest optional TargetDeliveryRequest that can be used to set specific request
   *     items such as Visitor, Context, etc. If null, one will be generated. Request for given mbox
   *     will be added automatically.
   * @param mboxes Name of mboxes to use to retrieve attributes.
   * @return CompletableFuture<Attributes> object
   */
  CompletableFuture getAttributesAsync(
      TargetDeliveryRequest targetRequest, String... mboxes);

  static TargetClient create(ClientConfig config) {
    return new DefaultTargetClient(config);
  }
}