Class SseEventProvider

java.lang.Object

org.jboss.resteasy.plugins.providers.sse.SseEventProvider

All Implemented Interfaces:

jakarta.ws.rs.ext.MessageBodyReader<SseEventInputImpl>, jakarta.ws.rs.ext.MessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent>, AsyncMessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent>

@Provider
@Produces({"text/event-stream","application/x-stream-general"})
@Consumes({"text/event-stream","application/x-stream-general"})
public class SseEventProvider
extends Object
implements AsyncMessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent>, jakarta.ws.rs.ext.MessageBodyReader<SseEventInputImpl>

Field Summary

Fields

Modifier and Type	Field	Description
static final jakarta.ws.rs.core.MediaType	GENERAL_STREAM_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
	SseEventProvider()
protected	SseEventProvider(jakarta.ws.rs.ext.Providers providers)

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	asyncWriteTo(jakarta.ws.rs.sse.OutboundSseEvent event, Class<?> type, Type genericType, Annotation[] annotations, jakarta.ws.rs.core.MediaType mediaType, jakarta.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, AsyncOutputStream entityStream)	Write a type to an HTTP message using async IO.
long	getSize(jakarta.ws.rs.sse.OutboundSseEvent t, Class<?> type, Type genericType, Annotation[] annotations, jakarta.ws.rs.core.MediaType mediaType)
boolean	isReadable(Class<?> cls, Type type, Annotation[] annotations, jakarta.ws.rs.core.MediaType mediaType)
boolean	isWriteable(Class<?> type, Type genericType, Annotation[] annotations, jakarta.ws.rs.core.MediaType mediaType)
SseEventInputImpl	readFrom(Class<SseEventInputImpl> cls, Type type, Annotation[] annotations, jakarta.ws.rs.core.MediaType mediaType, jakarta.ws.rs.core.MultivaluedMap<String,String> httpHeaders, InputStream entityStream)
void	writeTo(jakarta.ws.rs.sse.OutboundSseEvent event, Class<?> type, Type genericType, Annotation[] annotations, jakarta.ws.rs.core.MediaType mediaType, jakarta.ws.rs.core.MultivaluedMap<String,Object> httpHeaders, OutputStream entityStream)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

GENERAL_STREAM_TYPE

public static final jakarta.ws.rs.core.MediaType GENERAL_STREAM_TYPE

Constructor Details

SseEventProvider

public SseEventProvider()

SseEventProvider

protected SseEventProvider(jakarta.ws.rs.ext.Providers providers)

Method Details

isWriteable

public boolean isWriteable(Class<?> type,
 Type genericType,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType mediaType)

Specified by:

isWriteable in interface jakarta.ws.rs.ext.MessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent>

getSize

public long getSize(jakarta.ws.rs.sse.OutboundSseEvent t,
 Class<?> type,
 Type genericType,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType mediaType)

Specified by:

getSize in interface jakarta.ws.rs.ext.MessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent>

writeTo

public void writeTo(jakarta.ws.rs.sse.OutboundSseEvent event,
 Class<?> type,
 Type genericType,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType mediaType,
 jakarta.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
 OutputStream entityStream)
             throws IOException,
jakarta.ws.rs.WebApplicationException

Specified by:

writeTo in interface jakarta.ws.rs.ext.MessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent>

Throws:

IOException

jakarta.ws.rs.WebApplicationException

isReadable

public boolean isReadable(Class<?> cls,
 Type type,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType mediaType)

Specified by:

isReadable in interface jakarta.ws.rs.ext.MessageBodyReader<SseEventInputImpl>

readFrom

public SseEventInputImpl readFrom(Class<SseEventInputImpl> cls,
 Type type,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType mediaType,
 jakarta.ws.rs.core.MultivaluedMap<String,String> httpHeaders,
 InputStream entityStream)
                           throws IOException,
jakarta.ws.rs.WebApplicationException

Specified by:

readFrom in interface jakarta.ws.rs.ext.MessageBodyReader<SseEventInputImpl>

Throws:

IOException

jakarta.ws.rs.WebApplicationException

asyncWriteTo

public CompletionStage<Void> asyncWriteTo(jakarta.ws.rs.sse.OutboundSseEvent event,
 Class<?> type,
 Type genericType,
 Annotation[] annotations,
 jakarta.ws.rs.core.MediaType mediaType,
 jakarta.ws.rs.core.MultivaluedMap<String,Object> httpHeaders,
 AsyncOutputStream entityStream)

Description copied from interface: AsyncMessageBodyWriter

Write a type to an HTTP message using async IO. The message header map is mutable but any changes must be made before writing to the async output stream since the headers will be flushed prior to writing the message body.

Specified by:

asyncWriteTo in interface AsyncMessageBodyWriter<jakarta.ws.rs.sse.OutboundSseEvent>

Parameters:

event - the instance to write.

type - the class of instance that is to be written.

genericType - the type of instance to be written. GenericEntity provides a way to specify this information at runtime.

annotations - an array of the annotations attached to the message entity instance.

mediaType - the media type of the HTTP entity.

httpHeaders - a mutable map of the HTTP message headers.

entityStream - the AsyncOutputStream for the HTTP entity. The implementation should not close the output stream.

Returns:

a CompletionStage indicating completion