1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements.  See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License.  You may obtain a copy of the License at
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 package javax.websocket.server;
18 
19 import java.util.Set;
20 
21 import javax.websocket.Endpoint;
22 
23 /**
24  * Applications may provide an implementation of this interface to filter the
25  * discovered WebSocket endpoints that are deployed. Implementations of this
26  * class will be discovered via an ServletContainerInitializer scan.
27  */
28 public interface ServerApplicationConfig {
29 
30     /**
31      * Enables applications to filter the discovered implementations of
32      * {@link ServerEndpointConfig}.
33      *
34      * @param scanned   The {@link Endpoint} implementations found in the
35      *                  application
36      * @return  The set of configurations for the endpoint the application
37      *              wishes to deploy
38      */
getEndpointConfigs( Set<Class<? extends Endpoint>> scanned)39     Set<ServerEndpointConfig> getEndpointConfigs(
40             Set<Class<? extends Endpoint>> scanned);
41 
42     /**
43      * Enables applications to filter the discovered classes annotated with
44      * {@link ServerEndpoint}.
45      *
46      * @param scanned   The POJOs annotated with {@link ServerEndpoint} found in
47      *                  the application
48      * @return  The set of POJOs the application wishes to deploy
49      */
getAnnotatedEndpointClasses(Set<Class<?>> scanned)50     Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned);
51 }
52