org.hibernate.ogm.cfg.spi

Class DocumentStoreConfiguration

java.lang.Object

org.hibernate.ogm.cfg.spi.DocumentStoreConfiguration

public abstract class DocumentStoreConfiguration
extends Object

Provides access to properties common to different document datastores.

Author:

Gunnar Morling

Constructor Summary

Constructors

Constructor and Description
DocumentStoreConfiguration(ConfigurationPropertyReader propertyReader, int defaultPort)

Method Summary

Modifier and Type	Method and Description
String	getDatabaseName()
Hosts	getHosts()
String	getNativeClientResource()
String	getPassword()
String	getUsername()
boolean	isCreateDatabase()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentStoreConfiguration

public DocumentStoreConfiguration(ConfigurationPropertyReader propertyReader,
                                  int defaultPort)

Method Detail

getHosts

public Hosts getHosts()

Returns:

The host name of the data store instance

See Also:

OgmProperties.HOST, OgmProperties.PORT

getDatabaseName

public String getDatabaseName()

Returns:

the name of the database to connect to

See Also:

OgmProperties.DATABASE

getUsername

public String getUsername()

Returns:

The user name to be used for connecting with the data store

See Also:

OgmProperties.USERNAME

getPassword

public String getPassword()

Returns:

The password to be used for connecting with the data store

See Also:

OgmProperties.PASSWORD

isCreateDatabase

public boolean isCreateDatabase()

Returns:

whether to create the database to connect to if not existent or not

See Also:

OgmProperties.CREATE_DATABASE

getNativeClientResource

public String getNativeClientResource()

Returns:

Optional JNDI resource string to fetch a native document store client, null if it is not present

See Also:

OgmProperties.NATIVE_CLIENT_RESOURCE