org.glassfish.jersey.media.sse.InboundEventReader Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-media-sse Show documentation
Show all versions of jersey-media-sse Show documentation
Jersey Server Sent Events entity providers support module.
/*
* Copyright (c) 2012, 2023 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.jersey.media.sse;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.logging.Level;
import java.util.logging.Logger;
import jakarta.ws.rs.ConstrainedTo;
import jakarta.ws.rs.RuntimeType;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.ext.MessageBodyReader;
import jakarta.inject.Inject;
import jakarta.inject.Provider;
import org.glassfish.jersey.message.MessageBodyWorkers;
import org.glassfish.jersey.message.MessageUtils;
/**
* Client-side single inbound Server-Sent Event reader.
*
* @author Marek Potociar
*/
@ConstrainedTo(RuntimeType.CLIENT)
class InboundEventReader implements MessageBodyReader {
private static final Logger LOGGER = Logger.getLogger(InboundEventReader.class.getName());
private static final byte[] EOL_DATA = new byte[] {'\n'};
private final Provider messageBodyWorkers;
@Inject
InboundEventReader(Provider messageBodyWorkers) {
this.messageBodyWorkers = messageBodyWorkers;
}
private enum State {
SKIPPING_PREPENDED_EMPTY_EVENTS,
NEW_LINE,
COMMENT,
FIELD,
}
@Override
public boolean isReadable(final Class type, final Type genericType, final Annotation[] annotations,
final MediaType mediaType) {
return InboundEvent.class.equals(type) && SseFeature.SERVER_SENT_EVENTS_TYPE.isCompatible(mediaType);
}
@Override
public InboundEvent readFrom(final Class type,
final Type genericType,
final Annotation[] annotations,
final MediaType mediaType,
final MultivaluedMap headers,
final InputStream entityStream) throws IOException, WebApplicationException {
/**
* SSE Event parsing based on:
*
* http://dev.w3.org/html5/eventsource/
* last editors draft from 13 March 2012
*/
final ByteArrayOutputStream tokenData = new ByteArrayOutputStream();
final String charsetName = MessageUtils.getCharset(mediaType).name();
final InboundEvent.Builder eventBuilder =
new InboundEvent.Builder(messageBodyWorkers.get(), annotations, mediaType, headers);
int b = -1;
State currentState = State.SKIPPING_PREPENDED_EMPTY_EVENTS;
loop:
do {
switch (currentState) {
/* There is a problem with the SSE event parsing, because Jersey uses ChunkedInput to separate events.
The problem is that ChunkedInput uses fixed character string as a separator, which is \r\n\r\n when it
parses SSE.
The problem is that SSE events are separated only by \r\n and \r\n also works as an end of a field inside
the event, so the fixed separator \r\n\r\n only works if the server does not send empty events.
For example:
event: e1\r\n
data: d1\r\n
\r\n
\r\n
event: e2\r\n
data: d2\r\n
\r\n
is a stream of
Unfortunately the ChunkedInput parser will parse it only into 2 events and and will have
\r\n (an empty event) prepended at the beginning. This is not fixable on the ChunkedInput parser level,
which is not SSE aware, so this InboundEventReader must be aware of this and skip any prepended empty events.
Also as a result Jersey will not deliver empty events to the user. */
case SKIPPING_PREPENDED_EMPTY_EVENTS:
case NEW_LINE:
if (b == '\r') {
// read next byte in case of CRLF delimiter
b = entityStream.read();
b = b == '\n' ? entityStream.read() : b;
} else {
b = entityStream.read();
}
if (b == '\n' || b == '\r' || b == -1) {
if (currentState == State.SKIPPING_PREPENDED_EMPTY_EVENTS) {
break;
}
break loop;
}
if (b == ':') {
currentState = State.COMMENT;
} else {
tokenData.write(b);
currentState = State.FIELD;
}
break;
case COMMENT:
// skipping comment data
b = readLineUntil(entityStream, '\n', tokenData);
final String commentLine = tokenData.toString(charsetName);
tokenData.reset();
eventBuilder.commentLine(commentLine.trim());
currentState = State.NEW_LINE;
break;
case FIELD:
// read field name
b = readLineUntil(entityStream, ':', tokenData);
final String fieldName = tokenData.toString(charsetName);
tokenData.reset();
if (b == ':') {
do {
b = entityStream.read();
} while (b == ' ');
if (b != '\n' && b != '\r' && b != -1) {
tokenData.write(b);
b = readLineUntil(entityStream, '\n', tokenData);
}
}
processField(eventBuilder, fieldName, mediaType, tokenData.toByteArray());
tokenData.reset();
currentState = State.NEW_LINE;
break;
}
} while (b != -1);
return eventBuilder.build();
}
/**
* Read input stream until a delimiter or {@code EOL ('\n')} or {@code EOF} is reached
* and write the read data to the supplied output stream if not {@code null}, or discard
* the data if the output stream is {@code null}.
*
* @param in input stream to be read.
* @param delimiter delimiter to break the read (apart from {@code EOL ('\n', '\r')} or {@code EOF}).
* @param out output stream to write the read data to. May be {@code null}, in which case the
* read data are silently discarded.
* @return value of the last byte read.
* @throws IOException in case the reading or writing of the data failed.
*/
private int readLineUntil(final InputStream in, final int delimiter, final OutputStream out) throws IOException {
int b;
while ((b = in.read()) != -1) {
if (b == delimiter || b == '\n' || b == '\r') {
break;
} else if (out != null) {
out.write(b);
}
}
return b;
}
private void processField(final InboundEvent.Builder inboundEventBuilder, final String name,
final MediaType mediaType, final byte[] value) {
final String valueString = new String(value, MessageUtils.getCharset(mediaType));
if ("event".equals(name)) {
inboundEventBuilder.name(valueString);
} else if ("data".equals(name)) {
inboundEventBuilder.write(value);
inboundEventBuilder.write(EOL_DATA);
} else if ("id".equals(name)) {
inboundEventBuilder.id(valueString);
} else if ("retry".equals(name)) {
try {
inboundEventBuilder.reconnectDelay(Long.parseLong(valueString));
} catch (final NumberFormatException ex) {
LOGGER.log(Level.FINE, LocalizationMessages.IN_EVENT_RETRY_PARSE_ERROR(valueString), ex);
}
} else {
LOGGER.fine(LocalizationMessages.IN_EVENT_FIELD_NOT_RECOGNIZED(name, valueString));
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy