PushEndpoint.java

/*
 * Copyright 2009-2014 PrimeTek.
 *
 * 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 org.primefaces.push.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * An Endpoint for Push operation executed from by {@link org.primefaces.push.RemoteEndpoint} or using an {@link org.primefaces.push.EventBus}.
 * A class annotated with this annotation must at least have one method annotated with {@link OnOpen}, {@link OnClose} or {@link OnMessage}.
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PushEndpoint {
    /**
     * The path that will be used to map incoming request to a PushEndpoint
     * @return the path, or "/" by default.
     */
    String value() default "/";

}