Package ch.ivyteam.ivy.application

Interface IExternalDatabaseDefaultConfiguration

All Superinterfaces:

IExternalDatabaseConfiguration

public interface IExternalDatabaseDefaultConfiguration
extends IExternalDatabaseConfiguration

Interface for any default database configuration. Each database configuration can contain zero or more environment configurations. This interface provides methods to organize environment confirations for the default database configuration

Since:

04.05.2009

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
IExternalDatabaseConfiguration	createEnvironmentConfiguration(String environment, DatabaseConnectionConfiguration connectionConfiguration, int maxConnections)	Create an additional environment configuration for the default database configuration
default IExternalDatabaseConfiguration	createEnvironmentConfiguration(String environment, DatabaseConnectionConfiguration connectionConfiguration, EnumSet<ExternalDatabaseConfigurationAccessFlag> accessFlags, int maxConnections)	Deprecated. use createEnvironmentConfiguration(String, DatabaseConnectionConfiguration, int)
void	deleteEnvironmentConfiguration(IExternalDatabaseConfiguration externalDatabaseConfiguration)	Remove an environment configuration for the external database configuration
IExternalDatabaseConfiguration	findEnvironmentConfiguration(String environment)	Returns the database configuration for the given environment.
Map<String,IExternalDatabaseConfiguration>	getEnvironmentConfigurations()	Gets all environment configurations of the external database configuration.

Methods inherited from interface ch.ivyteam.ivy.application.IExternalDatabaseConfiguration

getAccessFlags, getApplication, getDatabaseConnectionConfiguration, getId, getMaxConnections, getUserFriendlyName, setAccessFlags, setDatabaseConnectionConfiguration, setMaxConnections, setUserFriendlyName

Method Detail

createEnvironmentConfiguration

IExternalDatabaseConfiguration createEnvironmentConfiguration(String environment,
                                                              DatabaseConnectionConfiguration connectionConfiguration,
                                                              int maxConnections)

Create an additional environment configuration for the default database configuration

Parameters:

environment - name of the environment configuration

connectionConfiguration - configuration of the connection to the external database that external database

maxConnections - The max number of connection that should be established to the external database

Returns:

new external database configuration

Throws:

PersistencyException - if persistency access fails

NoSuchElementException

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

findEnvironmentConfiguration

IExternalDatabaseConfiguration findEnvironmentConfiguration(String environment)

Returns the database configuration for the given environment. If there isn't a config for the given environment config, then null is returned.

Parameters:

environment - name of the environment. If null is given then the default environment configuration is returned

Returns:

an IExternalDatabaseConfiguration instance or null

Throws:

PersistencyException

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

deleteEnvironmentConfiguration

void deleteEnvironmentConfiguration(IExternalDatabaseConfiguration externalDatabaseConfiguration)

Remove an environment configuration for the external database configuration

Parameters:

externalDatabaseConfiguration - the db configuration

Throws:

PersistencyException

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

getEnvironmentConfigurations

Map<String,IExternalDatabaseConfiguration> getEnvironmentConfigurations()

Gets all environment configurations of the external database configuration. The key of the map is the environment name.

Returns:

map of external database configuration

Throws:

PersistencyException

API:

This public API is available in IvyScript and Java. It has the visibility ADVANCED.

createEnvironmentConfiguration

@Deprecated
default IExternalDatabaseConfiguration createEnvironmentConfiguration(String environment,
                                                                      DatabaseConnectionConfiguration connectionConfiguration,
                                                                      EnumSet<ExternalDatabaseConfigurationAccessFlag> accessFlags,
                                                                      int maxConnections)

Deprecated.

use createEnvironmentConfiguration(String, DatabaseConnectionConfiguration, int)

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.