act.ws.WsEndpoint Maven / Gradle / Ivy
package act.ws;
/*-
* #%L
* ACT Framework
* %%
* Copyright (C) 2014 - 2017 ActFramework
* %%
* 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.
* #L%
*/
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Mark a class as websocket connection endpoint.
*
* Note it does not require this class to have any specific method or
* implement any interface. This annotation is purely a tag that
* tells framework to setup a websocket connection endpoint.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface WsEndpoint {
String PSEUDO_METHOD = "__ws_endpoint__";
/**
* Specify the endpoint URL paths
* @return the URL paths
*/
String[] value() default {};
}