io.inverno.mod.web.compiler.spi.WebSocketRouteInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inverno-web-compiler Show documentation

Inverno web compiler module providing an Inverno compiler plugin to aggregate module's web routes and web router configurers into a single web router configurer

There is a newer version: 1.11.0

Show newest version

/*
 * Copyright 2022 Jeremy KUHN
 *
 * 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 io.inverno.mod.web.compiler.spi;

import io.inverno.mod.http.base.Method;
import io.inverno.mod.http.base.ws.WebSocketMessage;
import java.util.Optional;

/**
 * 
 * Describes a WebSocket route.
 * 
 * 
 * 
 * A WebSocket route is a {@link WebRouteInfo} with hardcoded {@code GET} method, no {@code consumes}, no {@code produces} and no {@code responseBody}. It specifies a WebSocket message type, a list of
 * supported subprotocols and an optional outbound publisher.
 * 
 *
 * @author Jeremy Kuhn
 * @since 1.5
 */
public interface WebSocketRouteInfo extends WebRouteInfo {

	@Override
	public default Method[] getMethods() {
		return new Method[] { Method.GET };
	}

	@Override
	public default String[] getConsumes() {
		return new String[0];
	}

	@Override
	public default String[] getProduces() {
		return new String[0];
	}

	@Override
	public default WebResponseBodyInfo getResponseBody() {
		return null;
	}
	
	/**
	 * 
	 * Returns the WebSocket message type specified in the route.
	 * 
	 * 
	 * 
	 * This is only relevant when the route is defined with inbound and outbound publishers.
	 * 
	 * 
	 * @return the kind of WebSocket message
	 */
	WebSocketMessage.Kind getMessageType();
	
	/**
	 * 
	 * Returns the list of WebSocket subprotocols supported in the route.
	 * 
	 * 
	 * @return an array of WebSocket subprotocols
	 */
	String[] getSubprotocols();
	
	/**
	 * 
	 * Returns the outbound publisher specified in the route if any.
	 * 
	 * 
	 * @return an optional returning an outbound publisher info or an empty optional if the route was not defined with an outbound publisher
	 */
	Optional getOutboundPublisher();
}