org.glassfish.sse.api.ServerSentEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of web-sse Show documentation

Server-Sent Events specification (http://dev.w3.org/html5/eventsource) defines an JavaScript API for clients for receiving push notifications from a server on a HTTP connection. This module has an API and implementation for server components to send such event notifications.

The newest version!

/*
 * Copyright (c) 2021 Contributors to Eclipse Foundation.
 * Copyright (c) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.sse.api;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * {@code ServerSentEvent} indicates a server component that pushes notifications to clients via a HTTP connection.
 * Browser applications typically use EventSource API to connect to
 * this source of server-sent events.
 *
 * 
 * Server component class needs to have {@code ServerSentEvent} annotation and provides the implementation of
 * {@code ServerSentEventHandler}. For example:
 *
 * 
 * 
 *     @ServerSentEvent("/foo")
 *     public class FooHandler extends ServerSentEventHandler {
 *         ...
 *     }
 * 
 * 
 *
 * @author Jitendra Kotamraju
 * @author [email protected]
 */
@Target(TYPE)
@Retention(RUNTIME)
public @interface ServerSentEvent {

    /**
     * The URL pattern of the source of server-sent events
     */
    public String value();

}