Package com.linecorp.armeria.common.thrift

Class ThriftProtocolFactories

java.lang.Object

com.linecorp.armeria.common.thrift.ThriftProtocolFactories

public final class ThriftProtocolFactories
extends Object

Provides a set of well-known TProtocolFactorys.

Field Summary

Fields

Modifier and Type	Field	Description
static final TProtocolFactory	BINARY	Deprecated. Use binary(int, int) instead.
static final TProtocolFactory	COMPACT	Deprecated. Use compact(int, int).
static final TProtocolFactory	JSON	Deprecated. Use json().
static final TProtocolFactory	TEXT	Deprecated. Use text().
static final TProtocolFactory	TEXT_NAMED_ENUM	Deprecated. Use textNamedEnum().

Method Summary

Modifier and Type	Method	Description
static TProtocolFactory	binary(int maxStringLength, int maxContainerLength)	Returns a TProtocolFactory for Thrift TBinary protocol.
static TProtocolFactory	compact(int maxStringLength, int maxContainerLength)	Returns a TProtocolFactory for Thrift TCompact protocol.
static TProtocolFactory	get(SerializationFormat serializationFormat)	Deprecated. Use ThriftSerializationFormats.protocolFactory(SerializationFormat).
static TProtocolFactory	json()	Returns a TProtocolFactory for the Thrift TJSON protocol.
static TProtocolFactory	text()	Returns a TProtocolFactory for the Thrift TText protocol.
static TProtocolFactory	textNamedEnum()	Returns a TProtocolFactory for the Thrift TText protocol with named enums.
static SerializationFormat	toSerializationFormat(TProtocolFactory protoFactory)	Deprecated. This method has been deprecated without a replacement since it cannot reliably work with custom protocol factories.

Methods inherited from class java.lang.Object

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

Field Details

BINARY

@Deprecated
public static final TProtocolFactory BINARY

Deprecated.

Use binary(int, int) instead.

TProtocolFactory for Thrift TBinary protocol.

Note that this Thrift TBinary protocol does not limit the maximum number of bytes to read from the transport. Therefore, it is recommended NOT to use this factory in a public network. If an attacker sends a header with a large message size, an `OutOfMemoryError` may occur. Related: Add string/collection length limit checks (from C++) to java protocol readers

COMPACT

@Deprecated
public static final TProtocolFactory COMPACT

Deprecated.

Use compact(int, int).

TProtocolFactory for Thrift TCompact protocol.

Note that this Thrift TCompact protocol does not limit the maximum number of bytes to read from the transport. Therefore, it is recommended to NOT use this factory in a public network. If an attacker sends a header with a large message size, an `OutOfMemoryError` may occur. Related: Add string/collection length limit checks (from C++) to java protocol readers

JSON

@Deprecated
public static final TProtocolFactory JSON

Deprecated.

Use json().

TProtocolFactory for the Thrift TJSON protocol.

TEXT

@Deprecated
public static final TProtocolFactory TEXT

Deprecated.

Use text().

TProtocolFactory for the Thrift TText protocol.

TEXT_NAMED_ENUM

@Deprecated
public static final TProtocolFactory TEXT_NAMED_ENUM

Deprecated.

Use textNamedEnum().

TProtocolFactory for the Thrift TText protocol with named enums.

Method Details

get

@Deprecated
public static TProtocolFactory get(SerializationFormat serializationFormat)

Deprecated.

Use ThriftSerializationFormats.protocolFactory(SerializationFormat).

Alias for ThriftSerializationFormats.protocolFactory(SerializationFormat).

Parameters:

serializationFormat - a known serialization format

Returns:

the protocol factory linked to the input serializationFormat

binary

public static TProtocolFactory binary(int maxStringLength,
 int maxContainerLength)

Returns a TProtocolFactory for Thrift TBinary protocol.

Parameters:

maxStringLength - the maximum allowed number of bytes to read from the transport for variable-length fields (such as strings or binary). 0 means unlimited.

maxContainerLength - the maximum allowed number of containers to read from the transport for maps, sets and lists. 0 means unlimited.

compact

public static TProtocolFactory compact(int maxStringLength,
 int maxContainerLength)

Returns a TProtocolFactory for Thrift TCompact protocol.

Parameters:

maxStringLength - the maximum allowed number of bytes to read from the transport for variable-length fields (such as strings or binary). 0 means unlimited.

maxContainerLength - the maximum allowed number of containers to read from the transport for maps, sets and lists. 0 means unlimited.

json

public static TProtocolFactory json()

Returns a TProtocolFactory for the Thrift TJSON protocol.

text

public static TProtocolFactory text()

Returns a TProtocolFactory for the Thrift TText protocol.

textNamedEnum

public static TProtocolFactory textNamedEnum()

Returns a TProtocolFactory for the Thrift TText protocol with named enums.

toSerializationFormat

@Deprecated
public static SerializationFormat toSerializationFormat(TProtocolFactory protoFactory)

Deprecated.

This method has been deprecated without a replacement since it cannot reliably work with custom protocol factories.

Returns the SerializationFormat for the specified TProtocolFactory, as if it were registered by DefaultThriftProtocolFactoryProvider. Consider having your own TProtocolFactory to SerializationFormat mapping if necessary.

Throws:

IllegalArgumentException - if the specified TProtocolFactory did not match anything