001/*
002 * Copyright 2022-2026 Revetware LLC.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package com.soklet.annotation;
018
019import org.jspecify.annotations.NonNull;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Repeatable;
023import java.lang.annotation.Retention;
024import java.lang.annotation.RetentionPolicy;
025import java.lang.annotation.Target;
026
027/**
028 * Apply to <em>Resource Methods</em> to make them function as <a href="https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events">Server-Sent Event Sources</a>.
029 * <p>
030 * See <a href="https://www.soklet.com/docs/server-sent-events">https://www.soklet.com/docs/server-sent-events</a> for detailed documentation.
031 *
032 * @author <a href="https://www.revetkn.com">Mark Allen</a>
033 */
034@Target(ElementType.METHOD)
035@Retention(RetentionPolicy.RUNTIME)
036@Repeatable(value = ServerSentEventSources.class)
037public @interface ServerSentEventSource {
038        /**
039         * The Server-Sent Event Source {@code GET} URL that should be handled by this Resource Method.
040         * <p>
041         * The URL must start with a {@code /} character, e.g. {@code /widgets/{widgetId}}.
042         *
043         * @return the Server-Sent Event Source {@code GET} URL that should be handled by this Resource Method
044         */
045        @NonNull
046        String value();
047}