com.hcl.domino.DominoClientBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * 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 .
 *
 * 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.hcl.domino;

import java.nio.file.Path;
import java.util.List;
import java.util.NoSuchElementException;
import java.util.Objects;

import com.hcl.domino.misc.DominoClientBuilderFactory;
import com.hcl.domino.misc.JNXServiceFinder;

/**
 * Builder for creating and configuring a DominoClient
 *
 * @author Karsten Lehmann
 * @author Paul Withers
 * @since 0.5.0
 */
public abstract class DominoClientBuilder {
  /**
   * Constructor for generating a DominoClient
   *
   * @return new DominoClientBuilder
   * @throws NoSuchElementException if there is no implementation of
   *                               {@link DominoClientBuilder} available
   */
  public static DominoClientBuilder newDominoClient() {
    return JNXServiceFinder.findRequiredService(DominoClientBuilderFactory.class, DominoClientBuilderFactory.class.getClassLoader())
        .get();
  }

  private Path m_idFilePath;

  private String m_idPassword;
  private boolean m_asIdUser;
  private String m_userName;

  private List m_userNamesList;
  private String m_credServer;
  private String m_credUser;
  private String m_credPassword;

  private Object m_credToken;
  private boolean m_fullAccess;

  private boolean m_maxInternetRights;

  /**
   * Accesses NSFs as the owner of the active user ID file
   *
   * @return DominoClientBuilder this builder
   */
  public DominoClientBuilder asIDUser() {
    this.m_asIdUser = true;
    return this;
  }

  /**
   * Accesses NSFs as a specific user
   *
   * @param userNamesList Domino username to access as
   * @return DominoClientBuilder this builder
   */
  public DominoClientBuilder asUser(final List userNamesList) {
    this.m_userNamesList = userNamesList;
    return this;
  }

  /**
   * Accesses NSFs as a specific user
   *
   * @param userName Domino username to access as
   * @return DominoClientBuilder this builder
   */
  public DominoClientBuilder asUser(final String userName) {
    this.m_userName = userName;
    return this;
  }

  /**
   * Accesses NSFs as a specific user, validating the password when
   * the client is constructed.
   * 
   * This is distinct from the password assigned to a Notes ID file, but instead
   * refers to credentials according to an active local runtime or remote server.
   * 
   *
   * @param serverName remote Domino server to authenticate against. May be
   *                   {@code null} to use
   *                   the local runtime
   * @param userName   Domino username to access as
   * @param password   the user's password
   * @return this builder
   * @throws IllegalArgumentException if userName is null or empty
   */
  public DominoClientBuilder authenticateUser(final String serverName, final String userName, final String password) {
    if (userName == null || userName.isEmpty()) {
      throw new IllegalArgumentException("userName cannot be empty");
    }
    this.m_credServer = serverName;
    this.m_credUser = userName;
    this.m_credPassword = password;
    return this;
  }

  /**
   * Accesses NSFs as a specific user, validating the provided credentials token
   * with any registered providers.
   * 
   * This is distinct from the password assigned to a Notes ID file, but instead
   * refers to credentials according to an active local runtime or remote server.
   * 
   *
   * @param serverName the name of the server to contact
   * @param token      the token to use to authenticate. The class of the token
   *                   depends on the available
   *                   provider implementations
   * @return this builder
   * @throws NullPointerException if {@code token} is null
   * @since 1.0.19
   */
  public DominoClientBuilder authenticateUserWithToken(final String serverName, final Object token) {
    Objects.requireNonNull(token, "token cannot be null");
    this.m_credServer = serverName;
    this.m_credToken = token;
    return this;
  }

  /**
   * Builds a DominoClient
   *
   * @return DominoClient for settings requested
   */
  public abstract DominoClient build();

  protected String getCredPassword() {
    return this.m_credPassword;
  }

  protected String getCredServer() {
    return this.m_credServer;
  }

  // *******************************************************************************
  // * Implementation class utilities
  // *******************************************************************************

  protected Object getCredToken() {
    return this.m_credToken;
  }

  protected String getCredUser() {
    return this.m_credUser;
  }

  protected Path getIDFilePath() {
    return this.m_idFilePath;
  }

  protected String getIDPassword() {
    return this.m_idPassword;
  }

  protected String getUserName() {
    return this.m_userName;
  }

  protected List getUserNamesList() {
    return this.m_userNamesList;
  }

  protected boolean isAsIDUser() {
    return this.m_asIdUser;
  }

  protected boolean isFullAccess() {
    return this.m_fullAccess;
  }

  protected boolean isMaxInternetAccess() {
    return this.m_maxInternetRights;
  }

  /**
   * Accesses the NSFs and server with full access
   *
   * @return DominoClientBuilder this builder
   */
  public DominoClientBuilder withFullAccess() {
    this.m_fullAccess = true;
    return this;
  }

  /**
   * Applies maximum internet access settings from the NSF to the requests
   *
   * @return DominoClientBuilder this builder
   */
  public DominoClientBuilder withMaxInternetAccess() {
    this.m_maxInternetRights = true;
    return this;
  }
}