de.xima.fc.plugin.models.retval.entities

Class PluginEntitiesConnectionRetVal

java.lang.Object

de.xima.fc.plugin.models.retval.entities.PluginEntitiesConnectionRetVal

All Implemented Interfaces:

IPluginEntitiesConnectionRetVal, Serializable

public class PluginEntitiesConnectionRetVal
extends Object
implements IPluginEntitiesConnectionRetVal

A simple implementation of IPluginEntitiesConnectionRetVal you may use in a plugin.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PluginEntitiesConnectionRetVal(boolean useSystemDatabase, EDatenbankTyp databaseType, DataSource dataSource, Map<String,Object> additionalProperties)

Method Summary

Modifier and Type	Method and Description
static IPluginEntitiesConnectionRetVal	forSystemDbWithAdditionalProperties(Map<String,Object> additionalProperties) Creates a new connection details object for a connection to the FORMCYCLE database.
Map<String,Object>	getAdditionalProperties() This method lets you pass additional properties to the persistence provider (which is currently Hibernate).
EDatenbankTyp	getDatabaseType() Different database management systems behave slightly differently, so we need to know about which type of database we are connecting to.
DataSource	getDataSource() This method returns a custom data source for connecting to the database where you would like to save the plugin entities.
boolean	isUseSystemDatabase() You may want to save you entities in the same database that is used by FORMCYCLE.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginEntitiesConnectionRetVal

public PluginEntitiesConnectionRetVal(boolean useSystemDatabase,
                                      EDatenbankTyp databaseType,
                                      DataSource dataSource,
                                      Map<String,Object> additionalProperties)

Method Detail

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Description copied from interface: IPluginEntitiesConnectionRetVal

This method lets you pass additional properties to the persistence provider (which is currently Hibernate). These properties override any settings made by FORMCYCLE. Property keys you can use include, but are not limited to, the options found in Environment.

Specified by:

getAdditionalProperties in interface IPluginEntitiesConnectionRetVal

Returns:

Additional properties for use by the persistence provider. If null or empty, no additional properties are set.

getDatabaseType

public EDatenbankTyp getDatabaseType()

Description copied from interface: IPluginEntitiesConnectionRetVal

Different database management systems behave slightly differently, so we need to know about which type of database we are connecting to. If you do not specify a type explicitly, the system will try to guess the type, but note that this may fail for some types of database management systems.

Specified by:

getDatabaseType in interface IPluginEntitiesConnectionRetVal

Returns:

The database type to which we are connecting, or null to guess the type.

getDataSource

public DataSource getDataSource()

Description copied from interface: IPluginEntitiesConnectionRetVal

This method returns a custom data source for connecting to the database where you would like to save the plugin entities. Ignored if IPluginEntitiesConnectionRetVal.isUseSystemDatabase() returns true.

This method may create a new data source (which is potentially a costly operation): the system will call this method only once when the plugin is initialized.

Specified by:

getDataSource in interface IPluginEntitiesConnectionRetVal

Returns:

The data source used to connect to the database that will store the plugin entities. If IPluginEntitiesConnectionRetVal.isUseSystemDatabase() returns false, this must not return null, or an exception will be thrown when the plugin is initialized. If IPluginEntitiesConnectionRetVal.isUseSystemDatabase() returns true, the returned value is ignored.

isUseSystemDatabase

public boolean isUseSystemDatabase()

Description copied from interface: IPluginEntitiesConnectionRetVal

You may want to save you entities in the same database that is used by FORMCYCLE. To do so, have this method return true. If you do, the IPluginEntitiesConnectionRetVal.getDataSource() will be ignored, but you can still use IPluginEntitiesConnectionRetVal.getAdditionalProperties() or IPluginEntitiesConnectionRetVal.getDataSource() to customize the database connection. Also, make sure you use unique names for the tables of your entities that do not conflict with existing FORMCYCLE table names. For example, consider prepending a prefix to all table names.

On the other hand, if you return false here, you need to specify a IPluginEntitiesConnectionRetVal.getDataSource().

Specified by:

isUseSystemDatabase in interface IPluginEntitiesConnectionRetVal

Returns:

true to use the FORMCYCLE system database, or false otherwise.

forSystemDbWithAdditionalProperties

public static IPluginEntitiesConnectionRetVal forSystemDbWithAdditionalProperties(Map<String,Object> additionalProperties)

Creates a new connection details object for a connection to the FORMCYCLE database. You may also pass additional settings, such as AvailableSettings.HBM2DDL_AUTO.

Parameters:

additionalProperties - Additional properties that are passed to the JPA provider.

Returns:

The connection details for a connection to the system database.