io.micronaut.rxjava3.http.client.Rx3StreamingHttpClient Maven / Gradle / Ivy
/*
* Copyright 2017-2020 original 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
*
* https://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.micronaut.rxjava3.http.client;
import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.core.io.buffer.ByteBuffer;
import io.micronaut.core.type.Argument;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
import io.micronaut.http.client.HttpClientConfiguration;
import io.micronaut.http.client.StreamingHttpClient;
import io.reactivex.rxjava3.core.Flowable;
import java.net.URL;
import java.util.Map;
/**
* RxJava 3 variation of the {@link StreamingHttpClient} interface.
*
* @author graemerocher
* @since 1.0.0
*/
public interface Rx3StreamingHttpClient extends Rx3HttpClient, StreamingHttpClient {
@Override
Flowable> dataStream(@NonNull HttpRequest request);
@Override
Flowable>> exchangeStream(@NonNull HttpRequest request);
@Override
Flowable> jsonStream(@NonNull HttpRequest request);
@Override
Flowable jsonStream(@NonNull HttpRequest request, @NonNull Argument type);
@Override
Flowable jsonStream(@NonNull HttpRequest request, @NonNull Class type);
/**
* Create a new {@link Rx3StreamingHttpClient}.
* Note that this method should only be used outside of the context of a Micronaut application.
* The returned {@link Rx3StreamingHttpClient} is not subject to dependency injection.
* The creator is responsible for closing the client to avoid leaking connections.
* Within a Micronaut application use {@link jakarta.inject.Inject} to inject a client instead.
*
* @param url The base URL
* @return The client
* @since 2.1.0
*/
static Rx3StreamingHttpClient create(@Nullable URL url) {
return new BridgedRx3StreamingHttpClient(StreamingHttpClient.create(url));
}
/**
* Create a new {@link Rx3StreamingHttpClient} with the specified configuration. Note that this method should only be used
* outside of the context of an application. Within Micronaut use {@link jakarta.inject.Inject} to inject a client instead
*
* @param url The base URL
* @param configuration the client configuration
* @return The client
* @since 2.1.0
*/
static Rx3StreamingHttpClient create(@Nullable URL url, @NonNull HttpClientConfiguration configuration) {
return new BridgedRx3StreamingHttpClient(StreamingHttpClient.create(url, configuration));
}
}