org.hibernate.boot.registry

Class StandardServiceRegistryBuilder

java.lang.Object

org.hibernate.boot.registry.StandardServiceRegistryBuilder

public class StandardServiceRegistryBuilder
extends Object

Builder for standard ServiceRegistry instances.

Author:

Steve Ebersole

See Also:

StandardServiceRegistryImpl, BootstrapServiceRegistryBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CFG_RESOURCE_NAME The default resource name for a hibernate configuration xml file.

Constructor Summary

Constructors

Constructor and Description
StandardServiceRegistryBuilder() Create a default builder.
StandardServiceRegistryBuilder(BootstrapServiceRegistry bootstrapServiceRegistry) Create a builder with the specified bootstrap services.
StandardServiceRegistryBuilder(BootstrapServiceRegistry bootstrapServiceRegistry, LoadedConfig loadedConfigBaseline) Create a builder with the specified bootstrap services.

Method Summary

Modifier and Type	Method and Description
StandardServiceRegistryBuilder	addInitiator(StandardServiceInitiator initiator) Adds a service initiator.
StandardServiceRegistryBuilder	addService(Class serviceRole, Service service) Adds a user-provided service.
StandardServiceRegistryBuilder	applySetting(String settingName, Object value) Apply a setting value.
StandardServiceRegistryBuilder	applySettings(Map settings) Apply a groups of setting values.
StandardServiceRegistry	build() Build the StandardServiceRegistry.
void	clearSettings()
StandardServiceRegistryBuilder	configure() Read setting information from an XML file using the standard resource location.
StandardServiceRegistryBuilder	configure(File configurationFile)
StandardServiceRegistryBuilder	configure(LoadedConfig loadedConfig)
StandardServiceRegistryBuilder	configure(String resourceName) Read setting information from an XML file using the named resource location.
StandardServiceRegistryBuilder	configure(URL url)
static void	destroy(ServiceRegistry serviceRegistry) Destroy a service registry.
StandardServiceRegistryBuilder	disableAutoClose() By default, when a ServiceRegistry is no longer referenced by any other registries as a parent it will be closed.
StandardServiceRegistryBuilder	enableAutoClose() See the discussion on disableAutoClose().
LoadedConfig	getAggregatedCfgXml() Intended for internal testing use only!!
BootstrapServiceRegistry	getBootstrapServiceRegistry()
Map	getSettings() Deprecated. Temporarily exposed since Configuration is still around and much code still uses Configuration. This allows code to configure the builder and access that to configure Configuration object.
StandardServiceRegistryBuilder	loadProperties(File file) Read settings from a Properties file by File reference
StandardServiceRegistryBuilder	loadProperties(String resourceName) Read settings from a Properties file by resource name.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CFG_RESOURCE_NAME

public static final String DEFAULT_CFG_RESOURCE_NAME

The default resource name for a hibernate configuration xml file.

See Also:

Constant Field Values

Constructor Detail

StandardServiceRegistryBuilder

public StandardServiceRegistryBuilder()

Create a default builder.

StandardServiceRegistryBuilder

public StandardServiceRegistryBuilder(BootstrapServiceRegistry bootstrapServiceRegistry)

Create a builder with the specified bootstrap services.

Parameters:

bootstrapServiceRegistry - Provided bootstrap registry to use.

StandardServiceRegistryBuilder

public StandardServiceRegistryBuilder(BootstrapServiceRegistry bootstrapServiceRegistry,
                                      LoadedConfig loadedConfigBaseline)

Create a builder with the specified bootstrap services.

Parameters:

bootstrapServiceRegistry - Provided bootstrap registry to use.

Method Detail

getAggregatedCfgXml

public LoadedConfig getAggregatedCfgXml()

Intended for internal testing use only!!

getBootstrapServiceRegistry

public BootstrapServiceRegistry getBootstrapServiceRegistry()

loadProperties

public StandardServiceRegistryBuilder loadProperties(String resourceName)

Read settings from a Properties file by resource name.

Differs from configure() and configure(String) in that here we expect to read a Properties file while for configure() we read the XML variant.

Parameters:

resourceName - The name by which to perform a resource look up for the properties file.

Returns:

this, for method chaining

See Also:

configure(), configure(String)

loadProperties

public StandardServiceRegistryBuilder loadProperties(File file)

Read settings from a Properties file by File reference

Differs from configure() and configure(String) in that here we expect to read a Properties file while for configure() we read the XML variant.

Parameters:

file - The properties File reference

Returns:

this, for method chaining

See Also:

configure(), configure(String)

configure

public StandardServiceRegistryBuilder configure()

Read setting information from an XML file using the standard resource location.

Returns:

this, for method chaining

See Also:

DEFAULT_CFG_RESOURCE_NAME, configure(String), loadProperties(String)

configure

public StandardServiceRegistryBuilder configure(String resourceName)

Read setting information from an XML file using the named resource location.

Parameters:

resourceName - The named resource

Returns:

this, for method chaining

configure

public StandardServiceRegistryBuilder configure(File configurationFile)

configure

public StandardServiceRegistryBuilder configure(URL url)

configure

public StandardServiceRegistryBuilder configure(LoadedConfig loadedConfig)

applySetting

public StandardServiceRegistryBuilder applySetting(String settingName,
                                                   Object value)

Apply a setting value.

Parameters:

settingName - The name of the setting

value - The value to use.

Returns:

this, for method chaining

applySettings

public StandardServiceRegistryBuilder applySettings(Map settings)

Apply a groups of setting values.

Parameters:

settings - The incoming settings to apply

Returns:

this, for method chaining

clearSettings

public void clearSettings()

addInitiator

public StandardServiceRegistryBuilder addInitiator(StandardServiceInitiator initiator)

Adds a service initiator.

Parameters:

initiator - The initiator to be added

Returns:

this, for method chaining

addService

public StandardServiceRegistryBuilder addService(Class serviceRole,
                                                 Service service)

Adds a user-provided service.

Parameters:

serviceRole - The role of the service being added

service - The service implementation

Returns:

this, for method chaining

disableAutoClose

public StandardServiceRegistryBuilder disableAutoClose()

By default, when a ServiceRegistry is no longer referenced by any other registries as a parent it will be closed.

Some applications that explicitly build "shared registries" may want to circumvent that behavior.

This method indicates that the registry being built should not be automatically closed. The caller agrees to take responsibility to close it themselves.

Returns:

this, for method chaining

enableAutoClose

public StandardServiceRegistryBuilder enableAutoClose()

See the discussion on disableAutoClose(). This method enables the auto-closing.

Returns:

this, for method chaining

build

public StandardServiceRegistry build()

Build the StandardServiceRegistry.

Returns:

The StandardServiceRegistry.

getSettings

@Deprecated
public Map getSettings()

Deprecated. Temporarily exposed since Configuration is still around and much code still uses Configuration. This allows code to configure the builder and access that to configure Configuration object.

Temporarily exposed since Configuration is still around and much code still uses Configuration. This allows code to configure the builder and access that to configure Configuration object (used from HEM atm).

Returns:

The settings map.

destroy

public static void destroy(ServiceRegistry serviceRegistry)

Destroy a service registry. Applications should only destroy registries they have explicitly created.

Parameters:

serviceRegistry - The registry to be closed.