io.vertx.reactivex.ext.web.client.WebClientSession Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file 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 CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.vertx.reactivex.ext.web.client;

import io.vertx.reactivex.RxHelper;
import io.vertx.reactivex.ObservableHelper;
import io.vertx.reactivex.FlowableHelper;
import io.vertx.reactivex.impl.AsyncResultMaybe;
import io.vertx.reactivex.impl.AsyncResultSingle;
import io.vertx.reactivex.impl.AsyncResultCompletable;
import io.vertx.reactivex.WriteStreamObserver;
import io.vertx.reactivex.WriteStreamSubscriber;
import java.util.Map;
import java.util.Set;
import java.util.List;
import java.util.Iterator;
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import io.vertx.core.Handler;
import io.vertx.core.AsyncResult;
import io.vertx.core.json.JsonObject;
import io.vertx.core.json.JsonArray;
import io.vertx.lang.rx.RxGen;
import io.vertx.lang.rx.TypeArg;
import io.vertx.lang.rx.MappingIterator;

/**
 * An asynchronous sessions aware HTTP / HTTP/2 client called WebClientSession.
 * 
 * This client wraps a {@link io.vertx.reactivex.ext.web.client.WebClient} and makes it session aware adding features to it:
 * 

 *   Per client headers, to be send with every request
 *   Per client cookies, to be send with every request
 *   Automatic storage and sending of cookies received from the server(s)
 * 
 * 
 * The client honors the cookies attributes:
 * 

 *  domain
 *  path
 *  secure
 *  max-age and expires
 * 
 * 
 *
 * 

 * NOTE: This class has been automatically generated from the {@link io.vertx.ext.web.client.WebClientSession original} non RX-ified interface using Vert.x codegen.
 */

@RxGen(io.vertx.ext.web.client.WebClientSession.class)
public class WebClientSession extends io.vertx.reactivex.ext.web.client.WebClient {

  @Override
  public String toString() {
    return delegate.toString();
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) return true;
    if (o == null || getClass() != o.getClass()) return false;
    WebClientSession that = (WebClientSession) o;
    return delegate.equals(that.delegate);
  }
  
  @Override
  public int hashCode() {
    return delegate.hashCode();
  }

  public static final TypeArg __TYPE_ARG = new TypeArg<>(    obj -> new WebClientSession((io.vertx.ext.web.client.WebClientSession) obj),
    WebClientSession::getDelegate
  );

  private final io.vertx.ext.web.client.WebClientSession delegate;
  
  public WebClientSession(io.vertx.ext.web.client.WebClientSession delegate) {
    super(delegate);
    this.delegate = delegate;
  }

  public WebClientSession(Object delegate) {
    super((io.vertx.ext.web.client.WebClientSession)delegate);
    this.delegate = (io.vertx.ext.web.client.WebClientSession)delegate;
  }

  public io.vertx.ext.web.client.WebClientSession getDelegate() {
    return delegate;
  }

  /**
   * Create a session aware web client using the provided webClient instance.
   * @param webClient the web client instance
   * @return the created client
   */
  public static io.vertx.reactivex.ext.web.client.WebClientSession create(io.vertx.reactivex.ext.web.client.WebClient webClient) { 
    io.vertx.reactivex.ext.web.client.WebClientSession ret = io.vertx.reactivex.ext.web.client.WebClientSession.newInstance((io.vertx.ext.web.client.WebClientSession)io.vertx.ext.web.client.WebClientSession.create(webClient.getDelegate()));
    return ret;
  }

  /**
   * Configure the client to add an HTTP header to every request.
   * @param name the header name
   * @param value the header value
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.client.WebClientSession addHeader(java.lang.String name, java.lang.String value) { 
    delegate.addHeader(name, value);
    return this;
  }

  /**
   * Removes a previously added header.
   * @param name the header name
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.client.WebClientSession removeHeader(java.lang.String name) { 
    delegate.removeHeader(name);
    return this;
  }

  /**
   * Create a session aware web client using the provided webClient instance.
   * @param webClient the web client instance
   * @param cookieStore 
   * @return the created client
   */
  public static io.vertx.reactivex.ext.web.client.WebClientSession create(io.vertx.reactivex.ext.web.client.WebClient webClient, io.vertx.ext.web.client.spi.CookieStore cookieStore) { 
    io.vertx.reactivex.ext.web.client.WebClientSession ret = io.vertx.reactivex.ext.web.client.WebClientSession.newInstance((io.vertx.ext.web.client.WebClientSession)io.vertx.ext.web.client.WebClientSession.create(webClient.getDelegate(), cookieStore));
    return ret;
  }

  /**
   * Configure the client to add an HTTP header to every request.
   * @param name the header name
   * @param value the header value
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.client.WebClientSession addHeader(java.lang.CharSequence name, java.lang.CharSequence value) { 
    delegate.addHeader(name, value);
    return this;
  }

  /**
   * Configure the client to add an HTTP header to every request.
   * @param name the header name
   * @param values the header value
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.client.WebClientSession addHeader(java.lang.CharSequence name, java.lang.Iterable values) { 
    delegate.addHeader(name, values);
    return this;
  }

  /**
   * Configure the client to add an HTTP header to every request.
   * @param name the header name
   * @param values the header value
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.client.WebClientSession addHeader(java.lang.String name, java.lang.Iterable values) { 
    delegate.addHeader(name, values);
    return this;
  }

  /**
   * Removes a previously added header.
   * @param name the header name
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.reactivex.ext.web.client.WebClientSession removeHeader(java.lang.CharSequence name) { 
    delegate.removeHeader(name);
    return this;
  }

  /**
   * Returns this client's CookieStore
   * 
   * All cookies added to this store will be sent with every request.
   * The CookieStore honors the domain, path, secure and max-age properties of received cookies
   * and is automatically updated with cookies present in responses received by this client.
   * @return this client's cookie store
   */
  public io.vertx.ext.web.client.spi.CookieStore cookieStore() { 
    io.vertx.ext.web.client.spi.CookieStore ret = delegate.cookieStore();
    return ret;
  }

  public static WebClientSession newInstance(io.vertx.ext.web.client.WebClientSession arg) {
    return arg != null ? new WebClientSession(arg) : null;
  }

}