com.hazelcast.config

Class ExternalDataStoreConfig

java.lang.Object

com.hazelcast.config.ExternalDataStoreConfig

All Implemented Interfaces:

NamedConfig, DataSerializable, IdentifiedDataSerializable

@Beta
public class ExternalDataStoreConfig
extends Object
implements IdentifiedDataSerializable, NamedConfig

Contains configuration of an external data store that can be used as a

• BatchSource and Sink in Jet JDBC connector.
• Datastore for MapStore and MapLoader

Since:

5.2

Constructor Summary

Constructors

Constructor and Description
ExternalDataStoreConfig()
ExternalDataStoreConfig(ExternalDataStoreConfig config)
ExternalDataStoreConfig(String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getClassId() Returns type identifier for this class.
String	getClassName() Returns the name of the ExternalDataStoreFactory implementation class
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
String	getName() Returns the name of this external data store.
Properties	getProperties() Returns all the properties of a datastore
String	getProperty(String key) Returns a single property of a datastore
int	hashCode()
boolean	isShared() true if an instance of the external data store will be reused.
void	readData(ObjectDataInput in) Reads fields from the input stream
ExternalDataStoreConfig	setClassName(String className) Sets the name for the ExternalDataStoreFactory implementation class
ExternalDataStoreConfig	setName(String name) Sets the name of this external data store, the name must be unique.
ExternalDataStoreConfig	setProperties(Properties properties) Sets the properties of a datastore.
ExternalDataStoreConfig	setProperty(String key, String value) Sets a single property.
ExternalDataStoreConfig	setShared(boolean shared) true if an instance of the external data store will be reused.
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExternalDataStoreConfig

public ExternalDataStoreConfig()

ExternalDataStoreConfig

public ExternalDataStoreConfig(ExternalDataStoreConfig config)

ExternalDataStoreConfig

public ExternalDataStoreConfig(String name)

Method Detail

setName

public ExternalDataStoreConfig setName(String name)

Sets the name of this external data store, the name must be unique.

Specified by:

setName in interface NamedConfig

Returns:

this ExternalDataStoreConfig

getName

public String getName()

Returns the name of this external data store.

Specified by:

getName in interface NamedConfig

Returns:

the name of this external data store

getClassName

public String getClassName()

Returns the name of the ExternalDataStoreFactory implementation class

Returns:

the name of the ExternalDataStoreFactory implementation class

setClassName

public ExternalDataStoreConfig setClassName(@Nonnull
                                            String className)

Sets the name for the ExternalDataStoreFactory implementation class

Parameters:

className - the name to set for the ExternalDataStoreFactory implementation class

isShared

public boolean isShared()

true if an instance of the external data store will be reused. false when on each usage the data store instance should be created. The default is true

Returns:

if the data store instance should be reused

setShared

public ExternalDataStoreConfig setShared(boolean shared)

true if an instance of the external data store will be reused. false when on each usage the data store instance should be created

Parameters:

shared - if the data store instance should be reused

Returns:

this ExternalDataStoreConfig

getProperties

public Properties getProperties()

Returns all the properties of a datastore

Returns:

all the properties of a datastore

getProperty

@Nullable
public String getProperty(String key)

Returns a single property of a datastore

Parameters:

key - the property key of a datastore

Returns:

property value or null if the given key doesn't exist

setProperty

public ExternalDataStoreConfig setProperty(String key,
                                           String value)

Sets a single property. See setProperties(Properties)

Parameters:

key - the property key

value - the property value

Returns:

this ExternalDataStoreConfig

setProperties

public ExternalDataStoreConfig setProperties(Properties properties)

Sets the properties of a datastore. See implementations of ExternalDataStoreFactory for supported values

Parameters:

properties - the properties to be set

Returns:

this ExternalDataStoreConfig

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Returns:

factory ID

getClassId

public int getClassId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Specified by:

getClassId in interface IdentifiedDataSerializable

Returns:

type ID