org.glassfish.jersey.message.internal.AbstractMessageReaderWriterProvider Maven / Gradle / Ivy
Show all versions of jaxrs-ri Show documentation
/*
* Copyright (c) 2010, 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.message.internal;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.Writer;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.ext.MessageBodyReader;
import jakarta.ws.rs.ext.MessageBodyWriter;
/**
* Abstract entity provider (reader and writer) base class.
*
* @param Java type supported by the provider
* @author Paul Sandoz
* @author Marek Potociar
*/
public abstract class AbstractMessageReaderWriterProvider implements MessageBodyReader, MessageBodyWriter {
// TODO: refactor away all constants & static wrappers of ReaderWriter methods and constants - those can be used directly.
/**
* The UTF-8 Charset.
*
* @deprecated use {@code StandardCharsets.UTF_8} instead.
*/
@Deprecated
public static final Charset UTF8 = StandardCharsets.UTF_8;
/**
* Reader bytes from an input stream and write then to an output stream.
*
* @param in the input stream to read from.
* @param out the output stream to write to.
* @throws IOException if there is an error reading or writing bytes.
*
* @deprecated use {@code ReaderWriter.writeTo(in, out)} instead.
*/
@Deprecated
public static void writeTo(InputStream in, OutputStream out) throws IOException {
ReaderWriter.writeTo(in, out);
}
/**
* Reader characters from an input stream and write then to an output stream.
*
* @param in the reader to read from.
* @param out the writer to write to.
* @throws IOException if there is an error reading or writing characters.
*
* @deprecated use {@code ReaderWriter.writeTo(in, out)} instead.
*/
@Deprecated
public static void writeTo(Reader in, Writer out) throws IOException {
ReaderWriter.writeTo(in, out);
}
/**
* Get the character set from a media type.
*
* The character set is obtained from the media type parameter "charset".
* If the parameter is not present the {@link StandardCharsets#UTF_8} charset is utilized.
*
* @param m the media type.
* @return the character set.
*
* @deprecated use {@code ReaderWriter.getCharset(m)} instead
*/
@Deprecated
public static Charset getCharset(MediaType m) {
return ReaderWriter.getCharset(m);
}
/**
* Read the bytes of an input stream and convert to a string.
*
* @param in the input stream to read from.
* @param type the media type that determines the character set defining
* how to decode bytes to characters.
* @return the string.
*
* @throws IOException if there is an error reading from the input stream.
*
* @deprecated use {@code ReaderWriter.readFromAsString(in, type)} instead
*/
@Deprecated
public static String readFromAsString(InputStream in, MediaType type) throws IOException {
return ReaderWriter.readFromAsString(in, type);
}
/**
* Convert a string to bytes and write those bytes to an output stream.
*
* @param s the string to convert to bytes.
* @param out the output stream to write to.
* @param type the media type that determines the character set defining
* how to decode bytes to characters.
* @throws IOException in case of a write failure.
*
* @deprecated use {@code ReaderWriter.writeToAsString(s, out, type)} instead
*/
@Deprecated
public static void writeToAsString(String s, OutputStream out, MediaType type) throws IOException {
ReaderWriter.writeToAsString(s, out, type);
}
// MessageBodyWriter
@Override
public long getSize(T t, Class type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return -1;
}
}