Class HazelcastDataConnection
- All Implemented Interfaces:
DataConnection
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
Modifier and TypeFieldDescriptionstatic final String
The constant to be used as property key for XML string for connecting to remote clusterstatic final String
The constant to be used as property key for XML file path for connecting to remote clusterstatic final String
The constant to be used as property key for YAML string for connecting to remote clusterstatic final String
The constant to be used as property key for YAML file path for connecting to remote clusterstatic final String
IMap Journal resource type name -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
Called by the member when shutting down.Return a clientHazelcastInstance
based on this data connection configuration.Returns list ofDataConnectionResource
s accessible via this DataConnection.Returns the list of possible values forDataConnectionResource.type()
, that will be returned whenDataConnection.listResources()
is called.Methods inherited from class com.hazelcast.dataconnection.DataConnectionBase
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.dataconnection.DataConnection
options
-
Field Details
-
CLIENT_XML
The constant to be used as property key for XML string for connecting to remote cluster- See Also:
-
CLIENT_YML
The constant to be used as property key for YAML string for connecting to remote cluster- See Also:
-
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
The constant to be used as property key for YAML file path for connecting to remote cluster- See Also:
-
OBJECT_TYPE_IMAP_JOURNAL
IMap Journal resource type name- See Also:
-
-
Constructor Details
-
HazelcastDataConnection
-
-
Method Details
-
resourceTypes
Description copied from interface:DataConnection
Returns the list of possible values forDataConnectionResource.type()
, that will be returned whenDataConnection.listResources()
is called. Returned values are case-insensitive, e.g.DataConnectionResource.type()
may returnMY_RES
and this methodmy_res
. -
listResources
Description copied from interface:DataConnection
Returns list ofDataConnectionResource
s 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
Return a clientHazelcastInstance
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 calledThe 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.
-