athenz.shade.zts.javax.ws.rs.sse.InboundSseEvent Maven / Gradle / Ivy
/*
* Copyright (c) 2012, 2017 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 athenz.shade.zts.athenz.shade.zts.javax.ws.rs.sse;
import athenz.shade.zts.athenz.shade.zts.javax.ws.rs.core.GenericType;
import athenz.shade.zts.athenz.shade.zts.javax.ws.rs.core.MediaType;
/**
* Inbound Server-sent event.
*
* Used on the client side, when accepting incoming Server-sent events.
*
* @author Marek Potociar
* @since 2.1
*/
public interface InboundSseEvent extends SseEvent {
/**
* Check if the event is empty (i.e. does not contain any data).
*
* @return {@code true} if current instance does not contain any data, {@code false} otherwise.
*/
boolean isEmpty();
/**
* Get the original event data as {@link String}.
*
* @return event data de-serialized into a string.
* @throws athenz.shade.zts.athenz.shade.zts.javax.ws.rs.ProcessingException when provided type can't be read. The thrown exception wraps the original cause.
*/
String readData();
/**
* Read event data as a given Java type.
*
* @param type Java type to be used for event data de-serialization.
* @return event data de-serialized as an instance of a given type.
* @throws athenz.shade.zts.athenz.shade.zts.javax.ws.rs.ProcessingException when provided type can't be read. The thrown exception wraps the original cause.
*/
T readData(Class type);
/**
* Read event data as a given generic type.
*
* @param type generic type to be used for event data de-serialization.
* @return event data de-serialized as an instance of a given type.
* @throws athenz.shade.zts.athenz.shade.zts.javax.ws.rs.ProcessingException when provided type can't be read. The thrown exception wraps the original cause.
*/
T readData(GenericType type);
/**
* Read event data as a given Java type.
*
* @param messageType Java type to be used for event data de-serialization.
* @param mediaType {@link MediaType media type} to be used for event data de-serialization.
* @return event data de-serialized as an instance of a given type.
* @throws athenz.shade.zts.athenz.shade.zts.javax.ws.rs.ProcessingException when provided type can't be read. The thrown exception wraps the original cause.
*/
T readData(Class messageType, MediaType mediaType);
/**
* Read event data as a given generic type.
*
* @param type generic type to be used for event data de-serialization.
* @param mediaType {@link MediaType media type} to be used for event data de-serialization.
* @return event data de-serialized as an instance of a given type.
* @throws athenz.shade.zts.athenz.shade.zts.javax.ws.rs.ProcessingException when provided type can't be read. The thrown exception wraps the original cause.
*/
T readData(GenericType type, MediaType mediaType);
}