io.inverno.mod.web.compiler.internal.ProvidedWebSocketRouteInfo 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.internal;

import io.inverno.core.compiler.spi.ReporterInfo;
import io.inverno.mod.http.base.Method;
import io.inverno.mod.http.base.ws.WebSocketMessage;
import io.inverno.mod.web.server.annotation.WebRoutes;
import io.inverno.mod.web.compiler.spi.WebRouteQualifiedName;
import io.inverno.mod.web.compiler.spi.WebSocketOutboundPublisherInfo;
import io.inverno.mod.web.compiler.spi.WebSocketRouteInfo;
import java.util.Optional;
import java.util.Set;

/**
 * 
 * Provided {@link WebSocketRouteInfo} implementation used to describes WebSocket routes specified in a {@link WebRoutes} annotation on a web routes configurer or a web router.
 * 
 *
 * @author Jeremy Kuhn
 * @since 1.5
 */
public class ProvidedWebSocketRouteInfo extends ProvidedWebRouteInfo implements WebSocketRouteInfo {
	
	private final WebSocketMessage.Kind messageType;
	
	private final String[] subprotocols;

	/**
	 * 
	 * Creates a provided WebSocket route info.
	 * 
	 * 
	 * @param name               the route qualified name
	 * @param reporter           the route reporter
	 * @param paths              the route paths
	 * @param matchTrailingSlash true to match trailing slash, false otherwise
	 * @param languages          the route produced languages
	 * @param subprotocols       the route WebSocket subprotocols
	 * @param messageType        the route WebSocket message type
	 */
	public ProvidedWebSocketRouteInfo(WebRouteQualifiedName name, ReporterInfo reporter, Set paths, boolean matchTrailingSlash, Set languages, Set subprotocols, WebSocketMessage.Kind messageType) {
		super(name, reporter, paths, matchTrailingSlash, Set.of(Method.GET), Set.of(), Set.of(), languages);
		this.subprotocols = subprotocols.stream().sorted().toArray(String[]::new);
		this.messageType = messageType;
	}

	@Override
	public WebSocketMessage.Kind getMessageType() {
		return this.messageType;
	}

	@Override
	public String[] getSubprotocols() {
		return this.subprotocols;
	}

	@Override
	public Optional getOutboundPublisher() {
		return Optional.empty();
	}
}