Package ch.ivyteam.ivy.application

Interface IExternalDatabaseConfiguration

All Known Subinterfaces:

IExternalDatabaseDefaultConfiguration

public interface IExternalDatabaseConfiguration

Configuration of an external database

Since:

31.08.2006

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
default EnumSet<ExternalDatabaseConfigurationAccessFlag>	getAccessFlags()	Deprecated.
IApplication	getApplication()	Gets the application this external database configuration belongs to
DatabaseConnectionConfiguration	getDatabaseConnectionConfiguration()	Gets the database connection configuration
long	getId()	Gets the identifier of the external database configuration
int	getMaxConnections()	Gets the maximum number of connections that should be opened to this external database
String	getUserFriendlyName()	Gets the name of this configuration
default void	setAccessFlags(EnumSet<ExternalDatabaseConfigurationAccessFlag> accessFlags)	Deprecated.
void	setDatabaseConnectionConfiguration(DatabaseConnectionConfiguration configuration)	Sets a new database connection configuration
void	setMaxConnections(int maxConnections)	Sets the maximum number of connections that should be opened to this external database
void	setUserFriendlyName(String userFriendlyName)	Sets the user friendly name of this configuration

Method Detail

getApplication

IApplication getApplication()

Gets the application this external database configuration belongs to

Returns:

the application

Throws:

PersistencyException - if persistency access fails

API:

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

getMaxConnections

int getMaxConnections()

Gets the maximum number of connections that should be opened to this external database

Returns:

maximum number of connections

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS ExternalDatabaseConfigurationReadMaxConnections PERMISSION OR OWNS ExternalDatabaseConfigurationReadMaxConnections@SYSTEM PERMISSION

setMaxConnections

void setMaxConnections(int maxConnections)

Sets the maximum number of connections that should be opened to this external database

Parameters:

maxConnections - the maximal number of connetions to open

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS ExternalDatabaseConfigurationWriteMaxConnections PERMISSION OR OWNS ExternalDatabaseConfigurationWriteMaxConnections@SYSTEM PERMISSION

getAccessFlags

@Deprecated
default EnumSet<ExternalDatabaseConfigurationAccessFlag> getAccessFlags()

Deprecated.

access flags are not supported any longer

API:

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

setAccessFlags

@Deprecated
default void setAccessFlags(EnumSet<ExternalDatabaseConfigurationAccessFlag> accessFlags)

Deprecated.

access flags are not supported any longer

API:

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

getDatabaseConnectionConfiguration

DatabaseConnectionConfiguration getDatabaseConnectionConfiguration()

Gets the database connection configuration

Returns:

database connection configuration

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS ExternalDatabaseConfigurationReadDatabaseConnectionConfiguration PERMISSION OR OWNS ExternalDatabaseConfigurationReadDatabaseConnectionConfiguration@SYSTEM PERMISSION

getUserFriendlyName

String getUserFriendlyName()

Gets the name of this configuration

Returns:

the name of this configuration

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS ExternalDatabaseConfigurationReadUserFriendlyName PERMISSION OR OWNS ExternalDatabaseConfigurationReadUserFriendlyName@SYSTEM PERMISSION

setUserFriendlyName

void setUserFriendlyName(String userFriendlyName)

Sets the user friendly name of this configuration

Warning: Chaning the name of an external database that is already used by some processes will probably break those processes.

Parameters:

userFriendlyName - The user friendly name

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS ExternalDatabaseConfigurationWriteUserFriendlyName PERMISSION OR OWNS ExternalDatabaseConfigurationWriteUserFriendlyName@SYSTEM PERMISSION

setDatabaseConnectionConfiguration

void setDatabaseConnectionConfiguration(DatabaseConnectionConfiguration configuration)

Sets a new database connection configuration

Parameters:

configuration - the new database connection configuration

Throws:

PersistencyException - if persistency access fails

API:

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

Security:

SESSION OWNS ExternalDatabaseConfigurationWriteDatabaseConnectionConfiguration PERMISSION OR OWNS ExternalDatabaseConfigurationWriteDatabaseConnectionConfiguration@SYSTEM PERMISSION

getId

long getId()

Gets the identifier of the external database configuration

Returns:

identifier

API:

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