org.apache.camel.websocket.jsr356.ServerEndpointDeploymentStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camel-websocket-jsr356 Show documentation

Camel WebSocket using JSR356 (javax)

There is a newer version: 3.22.3

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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 org.apache.camel.websocket.jsr356;

import javax.websocket.DeploymentException;
import javax.websocket.server.ServerContainer;
import javax.websocket.server.ServerEndpointConfig.Builder;

/**
 * A strategy to customize the configuration and deployment of WebSocket server endpoints.
 */
public interface ServerEndpointDeploymentStrategy {

    /**
     * Provides the capability to customize how the WebSocket server endpoint is configured and deployed.
     * 
     * @param  container           The {@link ServerContainer} instance on which the endpoint will be deployed.
     * @param  configBuilder       The {@link Builder} object to customize the endpoint configuration.
     * @throws DeploymentException
     */
    void deploy(ServerContainer container, Builder configBuilder) throws DeploymentException;
}