ConnectionSources (GORM 7.3.4)

java.lang.AutoCloseable

All Superinterfaces:

java.lang.AutoCloseable

Models multiple connection sources
Parameters:
- The underlying native type of the ConnectionSource, for example a SQL javax.sql.DataSource
Authors:
Graeme Rocher
Since:
6.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`ConnectionSource<T, S>`	`addConnectionSource(java.lang.String name, org.springframework.core.env.PropertyResolver configuration)` Adds a new ConnectionSource
	`ConnectionSource<T, S>`	`addConnectionSource(java.lang.String name, java.util.Map<java.lang.String, java.lang.Object> configuration)` Adds a new ConnectionSource
	`ConnectionSources<T, S>`	`addListener(ConnectionSourcesListener<T, S> listener)` Adds a listener
	`java.lang.Iterable<ConnectionSource<T, S>>`	`getAllConnectionSources()` @return An iterable containing all ConnectionSource instances
	`org.springframework.core.env.PropertyResolver`	`getBaseConfiguration()` @return Obtains the base configuration
	`ConnectionSource<T, S>`	`getConnectionSource(java.lang.String name)` Obtain a ConnectionSource by name
	`ConnectionSource<T, S>`	`getDefaultConnectionSource()` Obtains the default ConnectionSource
	`ConnectionSourceFactory<T, S>`	`getFactory()` @return The factory used to create new connections

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface java.lang.Iterable`	`java.lang.Iterable#iterator(), java.lang.Iterable#spliterator(), java.lang.Iterable#forEach(java.util.function.Consumer)`
`interface java.io.Closeable`	`java.io.Closeable#close()`

- Method Detail
  - public ConnectionSource<T, S> addConnectionSource(java.lang.String name, org.springframework.core.env.PropertyResolver configuration)
    
    Adds a new ConnectionSource
    throws:
    org.grails.datastore.mapping.core.exceptions.ConfigurationException if the configuration is invalid
    
    Returns:
    The ConnectionSource
    Parameters:
    name - The name of the connection source
    configuration - The configuration
  - public ConnectionSource<T, S> addConnectionSource(java.lang.String name, java.util.Map<java.lang.String, java.lang.Object> configuration)
    
    Adds a new ConnectionSource
    throws:
    org.grails.datastore.mapping.core.exceptions.ConfigurationException if the configuration is invalid
    
    Returns:
    The ConnectionSource
    Parameters:
    name - The name of the connection source
    configuration - The configuration
  - public ConnectionSources<T, S> addListener(ConnectionSourcesListener<T, S> listener)
    
    Adds a listener
    Returns:
    This connection sources
    Parameters:
    listener - The listener
  - public java.lang.Iterable<ConnectionSource<T, S>> getAllConnectionSources()
    
    Returns:
    An iterable containing all ConnectionSource instances
  - public org.springframework.core.env.PropertyResolver getBaseConfiguration()
    
    Returns:
    Obtains the base configuration
  - public ConnectionSource<T, S> getConnectionSource(java.lang.String name)
    
    Obtain a ConnectionSource by name
    Returns:
    A ConnectionSource or null if it doesn't exist
    Parameters:
    name - The name of the source
  - public ConnectionSource<T, S> getDefaultConnectionSource()
    
    Obtains the default ConnectionSource
    Returns:
    The default ConnectionSource
  - public ConnectionSourceFactory<T, S> getFactory()
    
    Returns:
    The factory used to create new connections

Summary:
Method

| Detail:
Method

[Java] Interface ConnectionSources<T, S extends ConnectionSourceSettings>

Methods Summary

Inherited Methods Summary

Method Detail

public ConnectionSource<T, S> addConnectionSource(java.lang.String name, org.springframework.core.env.PropertyResolver configuration)

public ConnectionSource<T, S> addConnectionSource(java.lang.String name, java.util.Map<java.lang.String, java.lang.Object> configuration)

public ConnectionSources<T, S> addListener(ConnectionSourcesListener<T, S> listener)

public java.lang.Iterable<ConnectionSource<T, S>> getAllConnectionSources()

public org.springframework.core.env.PropertyResolver getBaseConfiguration()

public ConnectionSource<T, S> getConnectionSource(java.lang.String name)

public ConnectionSource<T, S> getDefaultConnectionSource()

public ConnectionSourceFactory<T, S> getFactory()