javax.ws.rs.sse.OutboundSseEvent Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2012-2017 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.ws.rs.sse;
import java.lang.reflect.Type;
import javax.ws.rs.core.GenericType;
import javax.ws.rs.core.MediaType;
/**
* Representation of a single outbound Server-sent event.
*
* Used on the server side, when creating and sending an event to a client or when broadcasting.
*
* @author Marek Potociar
* @since 2.1
*/
public interface OutboundSseEvent extends SseEvent {
/**
* A builder class used for creating {@link OutboundSseEvent} instances.
*/
interface Builder {
/**
* Set the event id.
*
* Will be send as a value of the SSE {@code "id"} field. This field is optional.
*
* @param id event id.
* @return updated builder instance.
*/
Builder id(String id);
/**
* Set event name.
*
* Will be send as a value of the SSE {@code "event"} field. This field is optional.
*
* @param name event name.
* @return updated builder instance.
*/
public Builder name(String name);
/**
* Set reconnection delay (in milliseconds) that indicates how long the event receiver should wait
* before attempting to reconnect in case a connection to SSE event source is lost.
*
* Will be send as a value of the SSE {@code "retry"} field. This field is optional.
*
* Absence of a value of this field in an {@link OutboundSseEvent} instance
* is indicated by {@link SseEvent#RECONNECT_NOT_SET} value returned from
* {@link #getReconnectDelay()}.
*
* @param milliseconds reconnection delay in milliseconds. Negative values un-set the reconnection delay.
* @return updated builder instance.
*/
Builder reconnectDelay(long milliseconds);
/**
* Set the {@link MediaType media type} of the event data.
*
* This information is mandatory. The default value is {@link MediaType#TEXT_PLAIN}.
*
* @param mediaType {@link MediaType} of event data. Must not be {@code null}.
* @return updated builder instance.
* @throws NullPointerException in case the {@code mediaType} parameter is {@code null}.
*/
Builder mediaType(final MediaType mediaType);
/**
* Set comment string associated with the event.
*
* The comment will be serialized with the event, before event data are serialized. If the event
* does not contain any data, a separate "event" that contains only the comment will be sent.
* This information is optional, provided the event data are set.
*
* Note that multiple invocations of this method result in a previous comment being replaced with a new one.
* To achieve multi-line comments, a multi-line comment string has to be used.
*
* @param comment comment string.
* @return updated builder instance.
*/
Builder comment(String comment);
/**
* Set event data and java type of event data.
*
* Type information will be used for {@link javax.ws.rs.ext.MessageBodyWriter} lookup.
*
* Note that multiple invocations of this method result in previous even data being replaced with new one.
*
* @param type java type of supplied data. Must not be {@code null}.
* @param data event data. Must not be {@code null}.
* @return updated builder instance.
* @throws NullPointerException in case either {@code type} or {@code data} parameter is {@code null}.
*/
Builder data(Class type, Object data);
/**
* Set event data and a generic java type of event data.
*
* Type information will be used for {@link javax.ws.rs.ext.MessageBodyWriter} lookup.
*
* Note that multiple invocations of this method result in previous even data being replaced with new one.
*
* @param type generic type of supplied data. Must not be {@code null}.
* @param data event data. Must not be {@code null}.
* @return updated builder instance.
* @throws NullPointerException in case either {@code type} or {@code data} parameter is {@code null}.
*/
Builder data(GenericType type, Object data);
/**
* Set event data and java type of event data.
*
* This is a convenience method that derives the event data type information from the runtime type of
* the event data. The supplied event data may be represented as {@link javax.ws.rs.core.GenericEntity}.
*
* Note that multiple invocations of this method result in previous even data being replaced with new one.
*
* @param data event data. Must not be {@code null}.
* @return updated builder instance.
* @throws NullPointerException in case the {@code data} parameter is {@code null}.
*/
Builder data(Object data);
/**
* Build {@link OutboundSseEvent}.
*
* There are two valid configurations:
*
* - if a {@link Builder#comment(String) comment} is set, all other parameters are optional.
* If event {@link Builder#data(Class, Object) data} and {@link Builder#mediaType(MediaType) media type} is set,
* event data will be serialized after the comment.
* - if a {@link Builder#comment(String) comment} is not set, at least the event
* {@link Builder#data(Class, Object) data} must be set. All other parameters are optional.
*
*
* @return new {@link OutboundSseEvent} instance.
* @throws IllegalStateException when called with invalid configuration (neither a comment nor event data are set).
*/
OutboundSseEvent build();
}
/**
* Get data type.
*
* This information is used to select a proper {@link javax.ws.rs.ext.MessageBodyWriter} to be used for
* serializing the {@link #getData() event data}.
*
* @return data type. May return {@code null}, if the event does not contain any data.
*/
Class getType();
/**
* Get generic data type.
*
* This information is used to select a proper {@link javax.ws.rs.ext.MessageBodyWriter} to be used for
* serializing the {@link #getData() event data}.
*
* @return generic data type. May return {@code null}, if the event does not contain any data.
*/
Type getGenericType();
/**
* Get {@link MediaType media type} of the event data.
*
* This information is used to a select proper {@link javax.ws.rs.ext.MessageBodyWriter} to be used for
* serializing the {@link #getData() event data}.
*
* @return data {@link MediaType}.
*/
MediaType getMediaType();
/**
* Get event data.
*
* The event data, if specified, are serialized and sent as one or more SSE event {@code "data"} fields
* (depending on the line breaks in the actual serialized data content). The data are serialized
* using an available {@link javax.ws.rs.ext.MessageBodyWriter} that is selected based on the event
* {@link #getType() type}, {@link #getGenericType()} generic type} and {@link #getMediaType()} media type}.
*
* @return event data. May return {@code null}, if the event does not contain any data.
*/
Object getData();
}