Package com.hazelcast.dataconnection

Class HazelcastDataConnection

java.lang.Object
com.hazelcast.dataconnection.DataConnectionBase
com.hazelcast.dataconnection.HazelcastDataConnection
All Implemented Interfaces:
DataConnection
public class HazelcastDataConnection extends DataConnectionBase
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 Details

    • CLIENT_XML

      public static final String CLIENT_XML
      The constant to be used as property key for XML string for connecting to remote cluster
      See Also:

    • CLIENT_YML

      public static final String CLIENT_YML
      The constant to be used as property key for YAML string for connecting to remote cluster
      See Also:

    • CLIENT_XML_PATH

      public static final String CLIENT_XML_PATH
      The constant to be used as property key for XML file path for connecting to remote cluster
      See Also:

    • CLIENT_YML_PATH

      public static final String CLIENT_YML_PATH
      The constant to be used as property key for YAML file path for connecting to remote cluster
      See Also:

    • OBJECT_TYPE_IMAP_JOURNAL

      public static final String OBJECT_TYPE_IMAP_JOURNAL
      IMap Journal resource type name
      See Also:

  • Constructor Details

    • HazelcastDataConnection

      public HazelcastDataConnection(@Nonnull DataConnectionConfig dataConnectionConfig)

  • Method Details

    • resourceTypes

      @Nonnull public Collection<String> resourceTypes()
      Description copied from interface: DataConnection
      Returns the list of possible values for DataConnectionResource.type(), that will be returned when DataConnection.listResources() is called. Returned values are case-insensitive, e.g. DataConnectionResource.type() may return MY_RES and this method my_res.

    • listResources

      @Nonnull public Collection<DataConnectionResource> listResources()
      Description copied from interface: DataConnection
      Returns list of DataConnectionResources accessible via this DataConnection.

      It is not strictly required that the data connection 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.

    • getClient

      @Nonnull public HazelcastInstance getClient()
      Return a client HazelcastInstance based on this data connection configuration.

      Depending on the DataConnectionConfig.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 DataConnection 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: DataConnection
      Called by the member when shutting down. Should unconditionally close all connections and release resources.