xref: /unit/src/java/javax/websocket/server/ServerEndpoint.java (revision 1157:7ae152bda303)
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.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23 
24 import javax.websocket.Decoder;
25 import javax.websocket.Encoder;
26 
27 @Retention(RetentionPolicy.RUNTIME)
28 @Target(ElementType.TYPE)
29 public @interface ServerEndpoint {
30 
31     /**
32      * URI or URI-template that the annotated class should be mapped to.
33      * @return The URI or URI-template that the annotated class should be mapped
34      *         to.
35      */
value()36     String value();
37 
subprotocols()38     String[] subprotocols() default {};
39 
decoders()40     Class<? extends Decoder>[] decoders() default {};
41 
encoders()42     Class<? extends Encoder>[] encoders() default {};
43 
configurator()44     public Class<? extends ServerEndpointConfig.Configurator> configurator()
45             default ServerEndpointConfig.Configurator.class;
46 }
47