io.micronaut.websocket.WebSocketClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of micronaut-websocket Show documentation
Natively Cloud Native
There is a newer version: 4.7.9
/*
 * 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.websocket;

import io.micronaut.core.annotation.NonNull;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.MutableHttpRequest;
import io.micronaut.http.client.HttpClientConfiguration;
import org.reactivestreams.Publisher;

import java.net.URI;
import java.net.URL;
import java.util.Map;

/**
 * Interface that provides a way to connect a client over WebSocket.
 *
 * @author graemerocher
 * @since 1.0
 */
public interface WebSocketClient extends AutoCloseable {

    /**
     * Constant for HTTP scheme.
     */
    String SCHEME_WS = "ws";

    /**
     * Constant for HTTPS scheme.
     */
    String SCHEME_WSS = "wss";

    /**
     * Connect the given client endpoint type to the URI over WebSocket.
     *
     * @param clientEndpointType The endpoint type. Should be a class annotated with {@link io.micronaut.websocket.annotation.ClientWebSocket}
     * @param request The original request to establish the connection
     * @param  The generic type
     * @return A {@link Publisher} that emits the {@link io.micronaut.websocket.annotation.ClientWebSocket} instance
     */
     Publisher connect(
        Class clientEndpointType,
        MutableHttpRequest request
    );

    /**
     * Connect the given client endpoint type. Unlike {@link #connect(Class, URI)} this method will the value declared within the {@link io.micronaut.websocket.annotation.ClientWebSocket} as the URI
     * and expand the URI with the given parameters.
     *
     * @param clientEndpointType The endpoint type. Should be a class annotated with {@link io.micronaut.websocket.annotation.ClientWebSocket}
     * @param parameters The URI parameters for the endpoint
     * @param  The generic type
     * @return A {@link Publisher} that emits the {@link io.micronaut.websocket.annotation.ClientWebSocket} instance
     */
     Publisher connect(
        Class clientEndpointType,
        Map parameters
    );

    @Override
    void close();

    /**
     * Connect the given client endpoint type to the URI over WebSocket.
     *
     * @param clientEndpointType The endpoint type. Should be a class annotated with {@link io.micronaut.websocket.annotation.ClientWebSocket}
     * @param uri The URI to connect over
     * @param  The generic type
     * @return A {@link Publisher} that emits the {@link io.micronaut.websocket.annotation.ClientWebSocket} instance
     */
    default  Publisher connect(
        Class clientEndpointType,
        String uri
    ) {
        return connect(clientEndpointType, URI.create(uri));
    }

    /**
     * Connect the given client endpoint type to the URI over WebSocket.
     *
     * @param clientEndpointType The endpoint type. Should be a class annotated with {@link io.micronaut.websocket.annotation.ClientWebSocket}
     * @param uri The URI to connect over
     * @param  The generic type
     * @return A {@link Publisher} that emits the {@link io.micronaut.websocket.annotation.ClientWebSocket} instance
     */
    default  Publisher connect(
        Class clientEndpointType,
        URI uri
    ) {
        return connect(clientEndpointType, HttpRequest.GET(uri));
    }

    /**
     * Create a new {@link WebSocketClient}.
     * Note that this method should only be used outside the context of a Micronaut application.
     * The returned {@link WebSocketClient} 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
     * @deprecated Use {@link #create(URI)} instead
     */
    @Deprecated
    @NonNull
    static WebSocketClient create(@Nullable URL url) {
        return WebSocketClientFactoryResolver.getFactory().createWebSocketClient(url);
    }

    /**
     * Create a new {@link WebSocketClient} with the specified configuration. Note that this method should only be used
     * outside 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.2.0
     * @deprecated Use {@link #create(URI, HttpClientConfiguration)} instead
     */
    @Deprecated
    @NonNull
    static WebSocketClient create(@Nullable URL url, HttpClientConfiguration configuration) {
        return WebSocketClientFactoryResolver.getFactory().createWebSocketClient(url, configuration);
    }

    /**
     * Create a new {@link WebSocketClient}.
     * Note that this method should only be used outside the context of a Micronaut application.
     * The returned {@link WebSocketClient} 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 uri The base URI
     * @return The client
     * @since 3.2.0
     */
    @NonNull
    static WebSocketClient create(@Nullable URI uri) {
        return WebSocketClientFactoryResolver.getFactory().createWebSocketClient(uri);
    }

    /**
     * Create a new {@link WebSocketClient} with the specified configuration. Note that this method should only be used
     * outside the context of an application. Within Micronaut use {@link jakarta.inject.Inject} to inject a client instead
     *
     * @param uri The base URI
     * @param configuration the client configuration
     * @return The client
     * @since 3.2.0
     */
    @NonNull
    static WebSocketClient create(@Nullable URI uri, HttpClientConfiguration configuration) {
        return WebSocketClientFactoryResolver.getFactory().createWebSocketClient(uri, configuration);
    }

}