com.hazelcast.datalink

Class DataLinkBase

java.lang.Object

com.hazelcast.datalink.DataLinkBase

All Implemented Interfaces:

DataLink

Direct Known Subclasses:

HazelcastDataLink, JdbcDataLink, KafkaDataLink, MongoDataLink

@Beta
public abstract class DataLinkBase
extends Object
implements DataLink

Base class for DataLink implementations. Provides a ReferenceCounter. When the ref count gets to 0, calls the DataLink.destroy() method.

Since:

5.3

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataLinkBase(DataLinkConfig config)

Method Summary

Modifier and Type	Method and Description
DataLinkConfig	getConfig() Returns the configuration of this DataLink.
String	getName() Returns the name of this DataLink as specified in the DataLinkConfig or the CREATE DATA LINK command.
void	release() Release a retained data link.
void	retain() Prevents the data link from being closed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.datalink.DataLink

destroy, listResources, options

Constructor Detail

DataLinkBase

protected DataLinkBase(@Nonnull
                       DataLinkConfig config)

Method Detail

getName

@Nonnull
public final String getName()

Description copied from interface: DataLink

Returns the name of this DataLink as specified in the DataLinkConfig or the CREATE DATA LINK command.

Specified by:

getName in interface DataLink

Returns:

the name of this DataLink

retain

public final void retain()

Description copied from interface: DataLink

Prevents the data link from being closed. It is useful when the processor wants to avoid the data link from being closed while it is obtaining connections from it. Multiple threads can retain the same DataLink concurrently.

Note that the DataLink also isn't closed until all shared connections obtained from it are returned. This feature, together with the lock allows the processor to avoid concurrent close while it is using the connection.

Specified by:

retain in interface DataLink

release

public final void release()

Description copied from interface: DataLink

Release a retained data link. Must be called after every DataLink.retain() call, otherwise the data link will leak.

Specified by:

release in interface DataLink

getConfig

@Nonnull
public final DataLinkConfig getConfig()

Description copied from interface: DataLink

Returns the configuration of this DataLink.

Specified by:

getConfig in interface DataLink