org.apache.samza.table.remote.couchbase

Class BaseCouchbaseTableFunction<V>

java.lang.Object

org.apache.samza.table.remote.BaseTableFunction

org.apache.samza.table.remote.couchbase.BaseCouchbaseTableFunction<V>

Type Parameters:

V - Type of values to read from / write to couchbase

All Implemented Interfaces:

java.io.Serializable, org.apache.samza.operators.functions.ClosableFunction, org.apache.samza.table.remote.TableFunction, org.apache.samza.table.remote.TablePart

Direct Known Subclasses:

CouchbaseTableReadFunction, CouchbaseTableWriteFunction

public abstract class BaseCouchbaseTableFunction<V>
extends org.apache.samza.table.remote.BaseTableFunction

Base class for CouchbaseTableReadFunction and CouchbaseTableWriteFunction

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected com.couchbase.client.java.Bucket	bucket
protected java.lang.String	bucketName
protected java.util.List<java.lang.String>	clusterNodes
protected org.apache.samza.table.remote.couchbase.CouchbaseEnvironmentConfigs	environmentConfigs
protected java.time.Duration	timeout
protected java.time.Duration	ttl
protected org.apache.samza.serializers.Serde<V>	valueSerde

Fields inherited from class org.apache.samza.table.remote.BaseTableFunction

table

Constructor Summary

Constructors

Constructor and Description
BaseCouchbaseTableFunction(java.lang.String bucketName, java.lang.Class<V> valueClass, java.lang.String... clusterNodes) Constructor for BaseCouchbaseTableFunction.

Method Summary

Modifier and Type	Method and Description
void	close()
void	init(org.apache.samza.context.Context context, org.apache.samza.table.AsyncReadWriteTable table)
boolean	isRetriable(java.lang.Throwable exception) Check whether the exception is caused by one of the temporary failure exceptions, which are likely to be retriable.
<T extends BaseCouchbaseTableFunction<V>> T	withBootstrapCarrierDirectPort(int bootstrapCarrierDirectPort) If carrier publication bootstrap is enabled and not SSL, sets the port to use.
<T extends BaseCouchbaseTableFunction<V>> T	withBootstrapCarrierSslPort(int bootstrapCarrierSslPort) If carrier publication bootstrap and SSL are enabled, sets the port to use.
<T extends BaseCouchbaseTableFunction<V>> T	withBootstrapHttpDirectPort(int bootstrapHttpDirectPort) If Http bootstrap is enabled and not SSL, sets the port to use.
<T extends BaseCouchbaseTableFunction<V>> T	withBootstrapHttpSslPort(int bootstrapHttpSslPort) If Http bootstrap and SSL are enabled, sets the port to use.
<T extends BaseCouchbaseTableFunction<V>> T	withSerde(org.apache.samza.serializers.Serde<V> valueSerde) Serde is used to serialize and deserialize values to/from byte array.
<T extends BaseCouchbaseTableFunction<V>> T	withSslEnabledAndCertAuthEnabled(boolean certAuthEnabled) Enable certificate-based authentication and set sslEnabled to be true.
<T extends BaseCouchbaseTableFunction<V>> T	withSslKeystoreFileAndPassword(java.lang.String sslKeystoreFile, java.lang.String sslKeystorePassword) Defines the location and password of the SSL Keystore file (default value null).
<T extends BaseCouchbaseTableFunction<V>> T	withSslTruststoreFileAndPassword(java.lang.String sslTruststoreFile, java.lang.String sslTruststorePassword) Defines the location and password of the SSL TrustStore keystore file (default value null).
<T extends BaseCouchbaseTableFunction<V>> T	withTimeout(java.time.Duration timeout) Set the timeout limit on the read / write operations.
<T extends BaseCouchbaseTableFunction<V>> T	withTtl(java.time.Duration ttl) Set the TTL for the data writen to Couchbase.
<T extends BaseCouchbaseTableFunction<V>> T	withUsernameAndPassword(java.lang.String username, java.lang.String password) Enable role-based authentication with username and password.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.samza.table.remote.TablePart

toConfig

Field Detail

bucket

protected transient com.couchbase.client.java.Bucket bucket

valueSerde

protected org.apache.samza.serializers.Serde<V> valueSerde

timeout

protected java.time.Duration timeout

ttl

protected java.time.Duration ttl

clusterNodes

protected final java.util.List<java.lang.String> clusterNodes

bucketName

protected final java.lang.String bucketName

environmentConfigs

protected final org.apache.samza.table.remote.couchbase.CouchbaseEnvironmentConfigs environmentConfigs

Constructor Detail

BaseCouchbaseTableFunction

public BaseCouchbaseTableFunction(java.lang.String bucketName,
                                  java.lang.Class<V> valueClass,
                                  java.lang.String... clusterNodes)

Constructor for BaseCouchbaseTableFunction. This constructor abstracts the shareable logic of the read and write functions. It is not intended to be called directly.

Parameters:

bucketName - Name of the Couchbase bucket

valueClass - type of values

clusterNodes - Some Hosts of the Couchbase cluster. Recommended to provide more than one nodes so that if the first node could not be connected, other nodes can be tried.

Method Detail

init

public void init(org.apache.samza.context.Context context,
                 org.apache.samza.table.AsyncReadWriteTable table)

Specified by:

init in interface org.apache.samza.table.remote.TableFunction

Overrides:

init in class org.apache.samza.table.remote.BaseTableFunction

close

public void close()

isRetriable

public boolean isRetriable(java.lang.Throwable exception)

Check whether the exception is caused by one of the temporary failure exceptions, which are likely to be retriable.

Parameters:

exception - exception thrown by the table provider

Returns:

true if we should retry, otherwise false

withTimeout

public <T extends BaseCouchbaseTableFunction<V>> T withTimeout(java.time.Duration timeout)

Set the timeout limit on the read / write operations. Default value is Duration.ZERO, which means no timeout. See .

Type Parameters:

T - type of this instance

Parameters:

timeout - Timeout duration

Returns:

Self

withTtl

public <T extends BaseCouchbaseTableFunction<V>> T withTtl(java.time.Duration ttl)

Set the TTL for the data writen to Couchbase. Default value Duration.ZERO means no TTL, data will be stored forever. See .

Type Parameters:

T - type of this instance

Parameters:

ttl - TTL duration

Returns:

Self

withSerde

public <T extends BaseCouchbaseTableFunction<V>> T withSerde(org.apache.samza.serializers.Serde<V> valueSerde)

Serde is used to serialize and deserialize values to/from byte array. If value type is not JsonObject, a Serde must be provided.

Type Parameters:

T - type of this instance

Parameters:

valueSerde - value serde

Returns:

Self

withUsernameAndPassword

public <T extends BaseCouchbaseTableFunction<V>> T withUsernameAndPassword(java.lang.String username,
                                                                           java.lang.String password)

Enable role-based authentication with username and password. Note that role-based and certificate-based authentications can not be used together.

Type Parameters:

T - type of this instance

Parameters:

username - username

password - password

Returns:

Self

withSslEnabledAndCertAuthEnabled

public <T extends BaseCouchbaseTableFunction<V>> T withSslEnabledAndCertAuthEnabled(boolean certAuthEnabled)

Enable certificate-based authentication and set sslEnabled to be true. If certAuthEnabled is false, only server side certificate checking is enabled. If certAuthEnabled is true, both client and server certificate checking are enabled. SslKeystore or sslTrustStore should also be provided accordingly.

Type Parameters:

T - type of this instance

Parameters:

certAuthEnabled - allows to enable X.509 client certificate authentication

Returns:

Self

withSslKeystoreFileAndPassword

public <T extends BaseCouchbaseTableFunction<V>> T withSslKeystoreFileAndPassword(java.lang.String sslKeystoreFile,
                                                                                  java.lang.String sslKeystorePassword)

Defines the location and password of the SSL Keystore file (default value null). If this method is used without also specifying withSslTruststoreFileAndPassword(java.lang.String, java.lang.String) this keystore will be used to initialize both the key factory as well as the trust factory with java SSL. This needs to be the case for backwards compatibility, but if you do not need X.509 client cert authentication you might as well just use withSslTruststoreFileAndPassword(java.lang.String, java.lang.String) alone.

Type Parameters:

T - type of this instance

Parameters:

sslKeystoreFile - path of ssl keystore file

sslKeystorePassword - password of ssl keystore

Returns:

Self

withSslTruststoreFileAndPassword

public <T extends BaseCouchbaseTableFunction<V>> T withSslTruststoreFileAndPassword(java.lang.String sslTruststoreFile,
                                                                                    java.lang.String sslTruststorePassword)

Defines the location and password of the SSL TrustStore keystore file (default value null). If this method is used without also specifying withSslKeystoreFileAndPassword(java.lang.String, java.lang.String) this keystore will be used to initialize both the key factory as well as the trust factory with java SSL. Prefer this method over the withSslKeystoreFileAndPassword(java.lang.String, java.lang.String) if you do not need X.509 client auth and just need server side certificate checking.

Type Parameters:

T - type of this instance

Parameters:

sslTruststoreFile - path of truststore file

sslTruststorePassword - password of truststore

Returns:

Self

withBootstrapCarrierDirectPort

public <T extends BaseCouchbaseTableFunction<V>> T withBootstrapCarrierDirectPort(int bootstrapCarrierDirectPort)

If carrier publication bootstrap is enabled and not SSL, sets the port to use. Default value see .

Type Parameters:

T - type of this instance

Parameters:

bootstrapCarrierDirectPort - bootstrap carrier direct port

Returns:

Self

withBootstrapCarrierSslPort

public <T extends BaseCouchbaseTableFunction<V>> T withBootstrapCarrierSslPort(int bootstrapCarrierSslPort)

If carrier publication bootstrap and SSL are enabled, sets the port to use. Default value see .

Type Parameters:

T - type of this instance

Parameters:

bootstrapCarrierSslPort - bootstrap carrier ssl port

Returns:

Self

withBootstrapHttpDirectPort

public <T extends BaseCouchbaseTableFunction<V>> T withBootstrapHttpDirectPort(int bootstrapHttpDirectPort)

If Http bootstrap is enabled and not SSL, sets the port to use. Default value see .

Type Parameters:

T - type of this instance

Parameters:

bootstrapHttpDirectPort - bootstrap http direct port

Returns:

Self

withBootstrapHttpSslPort

public <T extends BaseCouchbaseTableFunction<V>> T withBootstrapHttpSslPort(int bootstrapHttpSslPort)

If Http bootstrap and SSL are enabled, sets the port to use. Default value see .

Type Parameters:

T - type of this instance

Parameters:

bootstrapHttpSslPort - bootstrap http ssl port

Returns:

Self