Class HttpByteArrayCacheEntrySerializer

java.lang.Object

org.apache.hc.client5.http.impl.cache.HttpByteArrayCacheEntrySerializer

All Implemented Interfaces:

HttpCacheEntrySerializer<byte[]>

@Contract(threading=STATELESS)
public class HttpByteArrayCacheEntrySerializer
extends Object
implements HttpCacheEntrySerializer<byte[]>

This class implements the HttpCacheEntrySerializer interface, which defines the contract for HTTP cache entry serialization and deserialization. It also includes a default buffer size of 8192 bytes, which can be overridden by specifying a different buffer size in the constructor.

Since:

5.4

Field Summary

Fields

Modifier and Type	Field	Description
private final int	bufferSize
private static final int	DEFAULT_BUFFER_SIZE	The default buffer size used for I/O operations, set to 8192 bytes.
(package private) static final String	HC_CACHE_KEY
(package private) static final String	HC_CACHE_LENGTH
(package private) static final String	HC_CACHE_VERSION
(package private) static final String	HC_CACHE_VERSION_LINE
(package private) static final String	HC_REQUEST_INSTANT
(package private) static final String	HC_RESPONSE_INSTANT
(package private) static final String	HC_VARIANT
static final HttpByteArrayCacheEntrySerializer	INSTANCE	Default instance of HttpByteArrayCacheEntrySerializer.
private final org.apache.hc.core5.http.message.LineFormatter	lineFormatter
private final org.apache.hc.core5.http.message.LineParser	lineParser
private static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
HttpByteArrayCacheEntrySerializer()	Constructs a new instance of HttpByteArrayCacheEntrySerializer with a default buffer size.
HttpByteArrayCacheEntrySerializer(int bufferSize)	Constructs a HttpByteArrayCacheEntrySerializer with the specified buffer size.

Method Summary

Modifier and Type	Method	Description
private static Instant	asInstant(String value)
private static long	asLong(String value)
private static String	asStr(long value)
private static String	asStr(Instant instant)
private static void	checkReadResult(int n)
HttpCacheStorageEntry	deserialize(byte[] serializedObject)	Deserializes a byte array representation of an HTTP cache storage entry into an instance of HttpCacheStorageEntry.
protected InputStream	makeByteArrayInputStream(byte[] bytes)	Deprecated. Do not use.
protected org.apache.hc.core5.http.impl.io.AbstractMessageParser<org.apache.hc.core5.http.ClassicHttpResponse>	makeHttpResponseParser()	Deprecated. Do not use.
protected org.apache.hc.core5.http.impl.io.AbstractMessageWriter<SimpleHttpResponse>	makeHttpResponseWriter(org.apache.hc.core5.http.io.SessionOutputBuffer outputBuffer)	Deprecated. Do not use.
byte[]	serialize(HttpCacheStorageEntry storageEntry)	Serializes an HttpCacheStorageEntry object into a byte array using an HTTP-like format.

Methods inherited from class Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

DEFAULT_BUFFER_SIZE

private static final int DEFAULT_BUFFER_SIZE

The default buffer size used for I/O operations, set to 8192 bytes.

See Also:

• Constant Field Values

HC_CACHE_VERSION

static final String HC_CACHE_VERSION

See Also:

• Constant Field Values

HC_CACHE_VERSION_LINE

static final String HC_CACHE_VERSION_LINE

See Also:

• Constant Field Values

HC_CACHE_KEY

static final String HC_CACHE_KEY

See Also:

• Constant Field Values

HC_CACHE_LENGTH

static final String HC_CACHE_LENGTH

See Also:

• Constant Field Values

HC_REQUEST_INSTANT

static final String HC_REQUEST_INSTANT

See Also:

• Constant Field Values

HC_RESPONSE_INSTANT

static final String HC_RESPONSE_INSTANT

See Also:

• Constant Field Values

HC_VARIANT

static final String HC_VARIANT

See Also:

• Constant Field Values

INSTANCE

public static final HttpByteArrayCacheEntrySerializer INSTANCE

Default instance of HttpByteArrayCacheEntrySerializer.

lineParser

private final org.apache.hc.core5.http.message.LineParser lineParser

lineFormatter

private final org.apache.hc.core5.http.message.LineFormatter lineFormatter

bufferSize

private final int bufferSize

Constructor Details

HttpByteArrayCacheEntrySerializer

public HttpByteArrayCacheEntrySerializer(int bufferSize)

Constructs a HttpByteArrayCacheEntrySerializer with the specified buffer size.

Parameters:

bufferSize - the buffer size to use for serialization and deserialization.

HttpByteArrayCacheEntrySerializer

public HttpByteArrayCacheEntrySerializer()

Constructs a new instance of HttpByteArrayCacheEntrySerializer with a default buffer size.

See Also:

• DEFAULT_BUFFER_SIZE

Method Details

serialize

public byte[] serialize(HttpCacheStorageEntry storageEntry)
                 throws ResourceIOException

Serializes an HttpCacheStorageEntry object into a byte array using an HTTP-like format.

The metadata is encoded into HTTP pseudo-headers for storage.

Specified by:

serialize in interface HttpCacheEntrySerializer<byte[]>

Parameters:

storageEntry - the HttpCacheStorageEntry to serialize.

Returns:

the byte array containing the serialized HttpCacheStorageEntry.

Throws:

ResourceIOException - if there is an error during serialization.

deserialize

public HttpCacheStorageEntry deserialize(byte[] serializedObject)
                                  throws ResourceIOException

Deserializes a byte array representation of an HTTP cache storage entry into an instance of HttpCacheStorageEntry.

Specified by:

deserialize in interface HttpCacheEntrySerializer<byte[]>

Parameters:

serializedObject - the byte array representation of the HTTP cache storage entry

Returns:

the deserialized HTTP cache storage entry

Throws:

ResourceIOException - if an error occurs during deserialization

asStr

private static String asStr(long value)

asStr

private static String asStr(Instant instant)

asLong

private static long asLong(String value)
                    throws ResourceIOException

Throws:

ResourceIOException

asInstant

private static Instant asInstant(String value)
                          throws ResourceIOException

Throws:

ResourceIOException

checkReadResult

private static void checkReadResult(int n)
                             throws ResourceIOException

Throws:

ResourceIOException

makeByteArrayInputStream

@Deprecated
protected InputStream makeByteArrayInputStream(byte[] bytes)

Deprecated.

Do not use.

Returns:

null

makeHttpResponseParser

@Deprecated
protected org.apache.hc.core5.http.impl.io.AbstractMessageParser<org.apache.hc.core5.http.ClassicHttpResponse> makeHttpResponseParser()

Deprecated.

Do not use.

Returns:

null

makeHttpResponseWriter

@Deprecated
protected org.apache.hc.core5.http.impl.io.AbstractMessageWriter<SimpleHttpResponse> makeHttpResponseWriter(org.apache.hc.core5.http.io.SessionOutputBuffer outputBuffer)

Deprecated.

Do not use.

Returns:

null