Package org.apache.pulsar.client.internal

Interface PulsarClientImplementationBinding

public interface PulsarClientImplementationBinding

Helper class for class instantiations and it also contains methods to work with schemas. This interface allows you to not depend on the Implementation classes directly. The actual implementation of this class is loaded from DefaultImplementation.

Method Summary

Modifier and Type	Method	Description
byte[]	convertKeyValueDataStringToSchemaInfoSchema(byte[] keyValueSchemaInfoDataJsonBytes)	Convert the key/value schema info data json bytes to key/value schema info data bytes.
String	convertKeyValueSchemaInfoDataToString(KeyValue<SchemaInfo,SchemaInfo> kvSchemaInfo)	Convert the key/value schema data.
Authentication	createAuthentication(String authPluginClassName, String authParamsString)
Authentication	createAuthentication(String authPluginClassName, Map<String,String> authParams)
KeyValueEncodingType	decodeKeyValueEncodingType(SchemaInfo schemaInfo)	Decode the kv encoding type from the schema info.
KeyValue<SchemaInfo,SchemaInfo>	decodeKeyValueSchemaInfo(SchemaInfo schemaInfo)	Decode the key/value schema info to get key schema info and value schema info.
<K, V> SchemaInfo	encodeKeyValueSchemaInfo(String schemaName, Schema<K> keySchema, Schema<V> valueSchema, KeyValueEncodingType keyValueEncodingType)	Encode key & value into schema into a KeyValue schema.
<K, V> SchemaInfo	encodeKeyValueSchemaInfo(Schema<K> keySchema, Schema<V> valueSchema, KeyValueEncodingType keyValueEncodingType)	Encode key & value into schema into a KeyValue schema.
static byte[]	getBytes(ByteBuffer byteBuffer)	Retrieves ByteBuffer data into byte[].
GenericSchema<GenericRecord>	getGenericSchema(SchemaInfo schemaInfo)
Schema<?>	getSchema(SchemaInfo schemaInfo)
String	jsonifyKeyValueSchemaInfo(KeyValue<SchemaInfo,SchemaInfo> kvSchemaInfo)	Jsonify the key/value schema info.
String	jsonifySchemaInfo(SchemaInfo schemaInfo)	Jsonify the schema info.
String	jsonifySchemaInfoWithVersion(SchemaInfoWithVersion schemaInfoWithVersion)	Jsonify the schema info with version.
Authentication	newAuthenticationTLS(String certFilePath, String keyFilePath)
Authentication	newAuthenticationToken(String token)
Authentication	newAuthenticationToken(Supplier<String> supplier)
Schema<GenericRecord>	newAutoConsumeSchema()
Schema<byte[]>	newAutoProduceSchema()
Schema<byte[]>	newAutoProduceSchema(Schema<?> schema)
Schema<byte[]>	newAutoProduceValidatedAvroSchema(Object schema)
<T> Schema<T>	newAvroSchema(SchemaDefinition schemaDefinition)
Schema<Boolean>	newBooleanSchema()
Schema<ByteBuffer>	newByteBufferSchema()
Schema<Byte>	newByteSchema()
Schema<byte[]>	newBytesSchema()
ClientBuilder	newClientBuilder()
Schema<Date>	newDateSchema()
BatcherBuilder	newDefaultBatcherBuilder()
MessagePayloadFactory	newDefaultMessagePayloadFactory()
Schema<Double>	newDoubleSchema()
Schema<Float>	newFloatSchema()
Schema<Instant>	newInstantSchema()
Schema<Integer>	newIntSchema()
<T> Schema<T>	newJSONSchema(SchemaDefinition schemaDefinition)
BatcherBuilder	newKeyBasedBatcherBuilder()
Schema<KeyValue<byte[],byte[]>>	newKeyValueBytesSchema()
<K, V> Schema<KeyValue<K,V>>	newKeyValueSchema(Class<K> key, Class<V> value, SchemaType type)
<K, V> Schema<KeyValue<K,V>>	newKeyValueSchema(Schema<K> keySchema, Schema<V> valueSchema)
<K, V> Schema<KeyValue<K,V>>	newKeyValueSchema(Schema<K> keySchema, Schema<V> valueSchema, KeyValueEncodingType keyValueEncodingType)
Schema<LocalDate>	newLocalDateSchema()
Schema<LocalDateTime>	newLocalDateTimeSchema()
Schema<LocalTime>	newLocalTimeSchema()
Schema<Long>	newLongSchema()
MessageId	newMessageId(long ledgerId, long entryId, int partitionIndex)
MessageId	newMessageIdFromByteArray(byte[] data)
MessageId	newMessageIdFromByteArrayWithTopic(byte[] data, String topicName)
<T extends com.google.protobuf.GeneratedMessageV3> Schema<T>	newProtobufNativeSchema(SchemaDefinition schemaDefinition)
<T extends com.google.protobuf.GeneratedMessageV3> Schema<T>	newProtobufSchema(SchemaDefinition schemaDefinition)
RecordSchemaBuilder	newRecordSchemaBuilder(String name)
<T> SchemaDefinitionBuilder<T>	newSchemaDefinitionBuilder()
SchemaInfo	newSchemaInfoImpl(String name, byte[] schema, SchemaType type, long timestamp, Map<String,String> propertiesValue)
Schema<Short>	newShortSchema()
Schema<String>	newStringSchema()
Schema<String>	newStringSchema(Charset charset)
Schema<Time>	newTimeSchema()
Schema<Timestamp>	newTimestampSchema()

Method Details

newSchemaDefinitionBuilder

<T> SchemaDefinitionBuilder<T> newSchemaDefinitionBuilder()

newClientBuilder

ClientBuilder newClientBuilder()

newMessageId

MessageId newMessageId(long ledgerId,
 long entryId,
 int partitionIndex)

newMessageIdFromByteArray

MessageId newMessageIdFromByteArray(byte[] data)
                             throws IOException

Throws:

IOException

newMessageIdFromByteArrayWithTopic

MessageId newMessageIdFromByteArrayWithTopic(byte[] data,
 String topicName)
                                      throws IOException

Throws:

IOException

newAuthenticationToken

Authentication newAuthenticationToken(String token)

newAuthenticationToken

Authentication newAuthenticationToken(Supplier<String> supplier)

newAuthenticationTLS

Authentication newAuthenticationTLS(String certFilePath,
 String keyFilePath)

createAuthentication

Authentication createAuthentication(String authPluginClassName,
 String authParamsString)
                             throws PulsarClientException.UnsupportedAuthenticationException

Throws:

PulsarClientException.UnsupportedAuthenticationException

createAuthentication

Authentication createAuthentication(String authPluginClassName,
 Map<String,String> authParams)
                             throws PulsarClientException.UnsupportedAuthenticationException

Throws:

PulsarClientException.UnsupportedAuthenticationException

newBytesSchema

Schema<byte[]> newBytesSchema()

newStringSchema

Schema<String> newStringSchema()

newStringSchema

Schema<String> newStringSchema(Charset charset)

newByteSchema

Schema<Byte> newByteSchema()

newShortSchema

Schema<Short> newShortSchema()

newIntSchema

Schema<Integer> newIntSchema()

newLongSchema

Schema<Long> newLongSchema()

newBooleanSchema

Schema<Boolean> newBooleanSchema()

newByteBufferSchema

Schema<ByteBuffer> newByteBufferSchema()

newFloatSchema

Schema<Float> newFloatSchema()

newDoubleSchema

Schema<Double> newDoubleSchema()

newDateSchema

Schema<Date> newDateSchema()

newTimeSchema

Schema<Time> newTimeSchema()

newTimestampSchema

Schema<Timestamp> newTimestampSchema()

newInstantSchema

Schema<Instant> newInstantSchema()

newLocalDateSchema

Schema<LocalDate> newLocalDateSchema()

newLocalTimeSchema

Schema<LocalTime> newLocalTimeSchema()

newLocalDateTimeSchema

Schema<LocalDateTime> newLocalDateTimeSchema()

newAvroSchema

<T> Schema<T> newAvroSchema(SchemaDefinition schemaDefinition)

newProtobufSchema

<T extends com.google.protobuf.GeneratedMessageV3>
Schema<T> newProtobufSchema(SchemaDefinition schemaDefinition)

newProtobufNativeSchema

<T extends com.google.protobuf.GeneratedMessageV3>
Schema<T> newProtobufNativeSchema(SchemaDefinition schemaDefinition)

newJSONSchema

<T> Schema<T> newJSONSchema(SchemaDefinition schemaDefinition)

newAutoConsumeSchema

Schema<GenericRecord> newAutoConsumeSchema()

newAutoProduceSchema

Schema<byte[]> newAutoProduceSchema()

newAutoProduceSchema

Schema<byte[]> newAutoProduceSchema(Schema<?> schema)

newAutoProduceValidatedAvroSchema

Schema<byte[]> newAutoProduceValidatedAvroSchema(Object schema)

newKeyValueBytesSchema

Schema<KeyValue<byte[],byte[]>> newKeyValueBytesSchema()

newKeyValueSchema

<K,
V> Schema<KeyValue<K,V>> newKeyValueSchema(Schema<K> keySchema,
 Schema<V> valueSchema)

newKeyValueSchema

<K,
V> Schema<KeyValue<K,V>> newKeyValueSchema(Schema<K> keySchema,
 Schema<V> valueSchema,
 KeyValueEncodingType keyValueEncodingType)

newKeyValueSchema

<K,
V> Schema<KeyValue<K,V>> newKeyValueSchema(Class<K> key,
 Class<V> value,
 SchemaType type)

getSchema

Schema<?> getSchema(SchemaInfo schemaInfo)

getGenericSchema

GenericSchema<GenericRecord> getGenericSchema(SchemaInfo schemaInfo)

newRecordSchemaBuilder

RecordSchemaBuilder newRecordSchemaBuilder(String name)

decodeKeyValueEncodingType

KeyValueEncodingType decodeKeyValueEncodingType(SchemaInfo schemaInfo)

Decode the kv encoding type from the schema info.

Parameters:

schemaInfo - the schema info

Returns:

the kv encoding type

encodeKeyValueSchemaInfo

<K,
V> SchemaInfo encodeKeyValueSchemaInfo(Schema<K> keySchema,
 Schema<V> valueSchema,
 KeyValueEncodingType keyValueEncodingType)

Encode key & value into schema into a KeyValue schema.

Parameters:

keySchema - the key schema

valueSchema - the value schema

keyValueEncodingType - the encoding type to encode and decode key value pair

Returns:

the final schema info

encodeKeyValueSchemaInfo

<K,
V> SchemaInfo encodeKeyValueSchemaInfo(String schemaName,
 Schema<K> keySchema,
 Schema<V> valueSchema,
 KeyValueEncodingType keyValueEncodingType)

Encode key & value into schema into a KeyValue schema.

Parameters:

schemaName - the final schema name

keySchema - the key schema

valueSchema - the value schema

keyValueEncodingType - the encoding type to encode and decode key value pair

Returns:

the final schema info

decodeKeyValueSchemaInfo

KeyValue<SchemaInfo,SchemaInfo> decodeKeyValueSchemaInfo(SchemaInfo schemaInfo)

Decode the key/value schema info to get key schema info and value schema info.

Parameters:

schemaInfo - key/value schema info.

Returns:

the pair of key schema info and value schema info

jsonifySchemaInfo

String jsonifySchemaInfo(SchemaInfo schemaInfo)

Jsonify the schema info.

Parameters:

schemaInfo - the schema info

Returns:

the jsonified schema info

jsonifySchemaInfoWithVersion

String jsonifySchemaInfoWithVersion(SchemaInfoWithVersion schemaInfoWithVersion)

Jsonify the schema info with version.

Parameters:

schemaInfoWithVersion - the schema info with version

Returns:

the jsonified schema info with version

jsonifyKeyValueSchemaInfo

String jsonifyKeyValueSchemaInfo(KeyValue<SchemaInfo,SchemaInfo> kvSchemaInfo)

Jsonify the key/value schema info.

Parameters:

kvSchemaInfo - the key/value schema info

Returns:

the jsonified schema info

convertKeyValueSchemaInfoDataToString

String convertKeyValueSchemaInfoDataToString(KeyValue<SchemaInfo,SchemaInfo> kvSchemaInfo)
                                      throws IOException

Convert the key/value schema data.

Parameters:

kvSchemaInfo - the key/value schema info

Returns:

the convert key/value schema data string

Throws:

IOException

convertKeyValueDataStringToSchemaInfoSchema

byte[] convertKeyValueDataStringToSchemaInfoSchema(byte[] keyValueSchemaInfoDataJsonBytes)
                                            throws IOException

Convert the key/value schema info data json bytes to key/value schema info data bytes.

Parameters:

keyValueSchemaInfoDataJsonBytes - the key/value schema info data json bytes

Returns:

the key/value schema info data bytes

Throws:

IOException

newDefaultBatcherBuilder

BatcherBuilder newDefaultBatcherBuilder()

newKeyBasedBatcherBuilder

BatcherBuilder newKeyBasedBatcherBuilder()

newDefaultMessagePayloadFactory

MessagePayloadFactory newDefaultMessagePayloadFactory()

getBytes

static byte[] getBytes(ByteBuffer byteBuffer)

Retrieves ByteBuffer data into byte[].

Parameters:

byteBuffer -

Returns:

newSchemaInfoImpl

SchemaInfo newSchemaInfoImpl(String name,
 byte[] schema,
 SchemaType type,
 long timestamp,
 Map<String,String> propertiesValue)