com.ibm.cloud.platform_services.user_management.v1.model.UsersPager Maven / Gradle / Ivy

/*
 * (C) Copyright IBM Corp. 2023.
 *
 * Licensed 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 com.ibm.cloud.platform_services.user_management.v1.model;

import com.ibm.cloud.platform_services.user_management.v1.UserManagement;
import com.ibm.cloud.sdk.core.util.UrlHelper;
import java.util.ArrayList;
import java.util.List;
import java.util.NoSuchElementException;

/**
 * UsersPager can be used to simplify the use of the "listUsers" method.
 */
public class UsersPager {
  private static class PageContext {
    private String next;
    public String getNext() {
      return next;
    }
    public void setNext(String next) {
      this.next = next;
    }
  }

  protected boolean hasNext;
  protected ListUsersOptions options;
  protected UserManagement client;
  protected PageContext pageContext;

  // Hide the default ctor.
  protected UsersPager() { }

  /**
   * Constructs a new UsersPager instance with the specified client and options model instance.
   * @param client the UserManagement instance to be used to invoke the "listUsers" method
   * @param options the ListUsersOptions instance to be used to invoke the "listUsers" method
   */
  public UsersPager(UserManagement client, ListUsersOptions options) {
    if (options.start() != null) {
      throw new IllegalArgumentException("The options 'start' field should not be set");
    }

    this.hasNext = true;
    this.client = client;
    this.options = options.newBuilder().build();
    this.pageContext = new PageContext();
  }

  /**
   * Returns true if there are more results to be retrieved.
   * @return boolean
   */
  public boolean hasNext() {
    return hasNext;
  }

  /**
   * Returns the next page of results.
   * @return a List<UserProfile> that contains the next page of results
   */
  public List getNext() {
    if (!hasNext()) {
      throw new NoSuchElementException("No more results available");
    }

    ListUsersOptions.Builder builder = this.options.newBuilder();
    if (this.pageContext.getNext() != null) {
      builder.start(this.pageContext.getNext());
    }
    this.options = builder.build();

    UserList result = client.listUsers(options).execute().getResult();

    String next = null;
    if (result.getNextUrl() != null) {
      String queryParam = UrlHelper.getQueryParam(result.getNextUrl(), "_start");
      if (queryParam != null) {
        next = queryParam;
      }
    }
    this.pageContext.setNext(next);
    if (next == null) {
      this.hasNext = false;
    }

    return result.getResources();
  }

  /**
   * Returns all results by invoking getNext() repeatedly until all pages of results have been retrieved.
   * @return a List<UserProfile> containing all results returned by the "listUsers" method
   */
  public List getAll() {
    List results = new ArrayList<>();
    while (hasNext()) {
      List nextPage = getNext();
      results.addAll(nextPage);
    }
    return results;
  }
}