com.hazelcast.datalink

Class HazelcastDataLink

java.lang.Object

com.hazelcast.datalink.DataLinkBase

com.hazelcast.datalink.HazelcastDataLink

All Implemented Interfaces:

DataLink

@Beta
public class HazelcastDataLink
extends DataLinkBase
implements DataLink

Creates a HazelcastInstance that is shared to connect to a remote cluster.

Set the client XML as property using CLIENT_XML as property key or Set the client YAML as property using CLIENT_YML as property key

Since:

5.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_XML The constant to be used as property key for XML
static String	CLIENT_YML The constant to be used as property key for YAML

Constructor Summary

Constructors

Constructor and Description
HazelcastDataLink(DataLinkConfig dataLinkConfig)

Method Summary

Modifier and Type	Method and Description
void	destroy() Called by the member when shutting down.
HazelcastInstance	getClient() Return a client HazelcastInstance based on this DataLink configuration.
Collection<DataLinkResource>	listResources() Returns list of DataLinkResources accessible via this DataLink.

Methods inherited from class com.hazelcast.datalink.DataLinkBase

getConfig, getName, release, retain

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

getConfig, getName, options, release, retain

Field Detail

CLIENT_XML

public static final String CLIENT_XML

The constant to be used as property key for XML

See Also:

Constant Field Values

CLIENT_YML

public static final String CLIENT_YML

The constant to be used as property key for YAML

See Also:

Constant Field Values

Constructor Detail

HazelcastDataLink

public HazelcastDataLink(@Nonnull
                         DataLinkConfig dataLinkConfig)

Method Detail

listResources

@Nonnull
public Collection<DataLinkResource> listResources()

Description copied from interface: DataLink

Returns list of DataLinkResources accessible via this DataLink.

It is not strictly required that the data link lists all resources; a resource can be used even if it is not listed. For example, the list of resources in Oracle database might not include tables available through a database link. In fact, it might list no resources at all, perhaps if the security in the target system prevents reading of such a list.

The returned list contains up-to-date list of resources. Any changes (added or removed resources) must be reflected in subsequent calls to this method.

Specified by:

listResources in interface DataLink

getClient

@Nonnull
public HazelcastInstance getClient()

Return a client HazelcastInstance based on this DataLink configuration.

Depending on the DataLinkConfig.isShared() config the HazelcastInstance is - shared=true -> a single instance is created - shared=false -> a new instance is created each time the method is called

The caller must call `shutdown` on the instance when finished to allow correct release of the underlying resources. In case of a shared instance, the instance is shut down when all users call the shutdown method and this DataLink is released. In case of a non-shared instance, the instance is shutdown immediately when the shutdown method is called.

destroy

public void destroy()

Description copied from interface: DataLink

Called by the member when shutting down. Should unconditionally close all connections and release resources.

Specified by:

destroy in interface DataLink