org.seppiko.commons.utils.http.UriBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-utils Show documentation
A toolkit package
There is a newer version: 2.11.0
/*
 * Copyright 2023 the original author or authors.
 *
 * 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 org.seppiko.commons.utils.http;

import java.net.URI;
import java.util.Arrays;
import java.util.Objects;
import java.util.StringJoiner;
import org.seppiko.commons.utils.NumberUtil;
import org.seppiko.commons.utils.StringUtil;

/**
 * URI builder
 *
 * 
 * [scheme ":"] ["//" authority] "/" path ["?" query] ["#" fragment]
 * authority = [userinfo "@"] host [":" port]
 * userinfo = username [":" password]
 * 
 *
 * @author Leonard Woo
 */
public final class UriBuilder {

  private String scheme;
  private String userInfo;
  private String hostname;
  private Integer port;
  private final StringJoiner pathJoiner = new StringJoiner("/");
  private final StringJoiner queryJoiner = new StringJoiner("&", "?", "");
  private String fragment;

  private UriBuilder() {}

  /**
   * {@link UriBuilder} from url string
   *
   * @param url URL
   * @return {@link UriBuilder} instance.
   * @throws NullPointerException If the url is null.
   * @throws IllegalArgumentException If the given string violates RFC 2396.
   */
  public static UriBuilder fromString(String url)
      throws NullPointerException, IllegalArgumentException {
    URI uri = URIUtil.getUri(url);
    String userInfo = uri.getUserInfo();
    String query = uri.getQuery();
    UriBuilder builder = new UriBuilder().withScheme(uri.getScheme());

    if (!StringUtil.isNullOrEmpty(userInfo)) {
      if (userInfo.contains(":"))  {
        String[] user = userInfo.split(":");
        builder.withUserInfo(user[0], user[1]);
      } else {
        builder.withUserInfo(userInfo, "");
      }
    }

    builder.withHostname(uri.getHost())
        .withPort(uri.getPort())
        .addPath(uri.getPath());

    if (!StringUtil.isNullOrEmpty(query)) {
      String[] params = query.split("&");
      Arrays.stream(params).forEach(param -> {
        String[] part = param.split("=");
         builder.addQuery(part[0], part[1]);
      });
    }

    if (!StringUtil.isNullOrEmpty(uri.getFragment())) {
      builder.withFragment(uri.getFragment());
    }

    return builder;
  }

  /**
   * @return A new UriBuilder instance.
   */
  public static UriBuilder create() {
    return new UriBuilder();
  }

  /**
   * @param scheme URI scheme.
   * @return this instance.
   */
  public UriBuilder withScheme(String scheme) {
    Objects.requireNonNull(scheme);
    this.scheme = scheme;
    return this;
  }

  /**
   * @param username Login username.
   * @param password Login password.
   * @return this instance.
   */
  public UriBuilder withUserInfo(String username, String password) {
    if (!StringUtil.isNullOrEmpty(username) && !StringUtil.isNullOrEmpty(password)) {
      this.userInfo = String.format("%s:%s", username, password);
    } else if (!StringUtil.isNullOrEmpty(username)) {
      this.userInfo = username;
    } else {
      throw new NullPointerException("Not found user info");
    }
    return this;
  }

  /**
   * @param hostname Host
   * @return this instance.
   */
  public UriBuilder withHostname(String hostname) {
    Objects.requireNonNull(hostname);
    if (hostname.endsWith("/")) {
      hostname = hostname.substring(0, hostname.length() - 1);
    }
    this.hostname = hostname;
    return this;
  }

  /**
   * @param port Port
   * @return this instance.
   */
  public UriBuilder withPort(int port) {
    if (NumberUtil.between(port, 1, 65535)) {
      this.port = port;
    } else {
      this.port = null;
    }
    return this;
  }

  /**
   * @param path URI path
   * @return this instance.
   */
  public UriBuilder addPath(String path) {
    Objects.requireNonNull(path);
    if (path.startsWith("/")) {
      path = path.substring(1);
    }
    pathJoiner.add(path);
    return this;
  }

  /**
   * @param name query name
   * @param value query value
   * @return this instance.
   */
  public UriBuilder addQuery(String name, String value) {
    Objects.requireNonNull(name);
    Objects.requireNonNull(value);
    queryJoiner.add(String.format("%s=%s", name, value));
    return this;
  }

  /**
   * @param fragment fragment
   * @return this instance.
   */
  public UriBuilder withFragment(String fragment) {
    if (!StringUtil.isNullOrEmpty(fragment)) {
      this.fragment = fragment;
    }
    return this;
  }

  /**
   * @return URI string.
   */
  public String toUri() {
    StringBuilder uriSB = new StringBuilder();
    uriSB.append(scheme);
    uriSB.append("://");
    if (!StringUtil.isNullOrEmpty(userInfo)) {
      uriSB.append(userInfo);
      uriSB.append("@");
    }
    uriSB.append(hostname);
    if (port != null) {
      uriSB.append(":");
      uriSB.append(port);
    }
    uriSB.append("/");
    if (pathJoiner.length() > 0) {
      uriSB.append(pathJoiner.toString());
    }
    if (queryJoiner.length() > 0) {
      uriSB.append(queryJoiner.toString());
    }
    if (fragment != null) {
      uriSB.append("#");
      uriSB.append(fragment);
    }
    return uriSB.toString();
  }

  /**
   * @return URI instance.
   */
  public URI toURI() {
    return URIUtil.getUri(toUri());
  }
}