Persistence (TSL2 JEE Direct Access 2.1.2 API)

java.lang.Object
- de.tsl2.nano.persistence.Persistence

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

Replication
```
public class Persistence
extends Object
implements Serializable, Cloneable
```
bean class to define the content of a persistence.xml and jdbc-connection.properties

Version:

$Revision$

Author:

Thomas Schneider, Thomas Schneider

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`connectionDriverClass`
`protected String`	`connectionPassword`
`protected String`	`connectionUrl`
`protected String`	`connectionUserName`
`protected String`	`database`
`protected String`	`datasourceClass`
`static String`	`DEFAULT_CATALOG`
`static String`	`DEFAULT_SCHEMA`
`protected String`	`defaultSchema`
`static String`	`DERBY_DATABASE_DRIVER`
`static String`	`DERBY_DATABASE_URL`
`static String`	`FILE_JDBC_PROP_FILE` jdbc connection properties - used by ejb creator
`static String`	`FILE_PERSISTENCE_BEAN` xml serialization of Persistence object
`static String`	`FILE_PERSISTENCE_NOREP_TML`
`static String`	`FILE_PERSISTENCE_TML` persistence template file name
`static String`	`FILE_PERSISTENCE_XML` standard ejb path to load persistence unit
`static String`	`FIX_PATH`
`static String`	`GEN_HIBERNATE`
`static String`	`GEN_OPENJPA`
`static String`	`H2_DATABASE_DRIVER`
`static String`	`H2_DATABASE_URL`
`protected String`	`hibernateDialect`
`static String`	`HSQLDB_DATABASE_DRIVER`
`static String`	`HSQLDB_DATABASE_URL`
`protected String`	`jarFile`
`protected String`	`jtaDataSource`
`protected String`	`persistenceUnit`
`protected String`	`port`
`protected String`	`provider`
`static String`	`STD_LOCAL_DATABASE_DRIVER`
`static String[]`	`STD_LOCAL_DATABASE_DRIVERS`
`static String`	`STD_LOCAL_DATABASE_URL`
`protected String`	`transactionType`

Constructor Summary

Constructors
Constructor and Description

Persistence()
constructor

Persistence(String jarFile)
constructor

Constructors
Constructor and Description
`Persistence()` constructor
`Persistence(String jarFile)` constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addPersistenceProperties(Persistence parent, Map<String,Object> prop)` addPersistenceProperties
`boolean`	`autoDllIsCreateDrop()` autoDllIsCreateDrop
`boolean`	`change(String beanjar)` change
`Persistence`	`clone()`
`static Persistence`	`current()` loads an existing one or creates a new one.
`static boolean`	`delete()` delete
`boolean`	`equals(Object obj)`
`static boolean`	`exists()` exists
`String`	`getAuth()` getAuth
`String`	`getAutoddl()`
`static String`	`getBackupPath(String file)`
`protected String`	`getBeanFileName()`
`String`	`getConnectionDriverClass()`
`String`	`getConnectionPassword()`
`String`	`getConnectionUrl()`
`String`	`getConnectionUserName()`
`String`	`getDatabase()`
`String`	`getDatasourceClass()`
`String`	`getDefaultSchema()`
`String`	`getGenerator()`
`String`	`getHibernateDialect()`
`String`	`getJarFile()`
`Properties`	`getJdbcProperties()`
`Properties`	`getJdbcProperties(boolean viewOnly)` getJdbcProperties
`String`	`getJtaDataSource()`
`static String`	`getPath(String file)` returns the full workspace path for the given file
`String`	`getPersistenceUnit()`
`String`	`getPort()`
`String`	`getPort(String url)` extracts the port of the given database url
`String`	`getProvider()`
`Persistence`	`getReplication()`
`String`	`getTransactionType()`
`boolean`	`isEmbeddedDatabase()` see `isEmbeddedDatabase(String)`
`static boolean`	`isEmbeddedDatabase(String urlOrDriver)` isEmbeddedDatabase
`String`	`jarFileInEnvironment()` the bean-jar must be in the class-path: this has to be inside the environment directory. jarFileInEnvironment
`String`	`jarURL()`
`protected <S> void`	`put(Map<S,Object> prop, S key, String value)`
`String`	`save()` save serialization, persistence.xml and jdbc property file
`protected void`	`saveJdbcProperties()` saveJdbcProperties
`protected String`	`savePersistenceXml()`
`void`	`setAuth(String auth)`
`void`	`setAutoddl(String autoddl)`
`void`	`setConnectionDriverClass(String connectionDriverClass)`
`void`	`setConnectionPassword(String connectionPassword)`
`void`	`setConnectionUrl(String connectionUrl)`
`void`	`setConnectionUserName(String connectionUserName)`
`void`	`setDatabase(String database)`
`void`	`setDatasourceClass(String datasourceClass)`
`void`	`setDefaultSchema(String defaultSchema)`
`void`	`setGenerator(String generator)`
`void`	`setHibernateDialect(String hibernateDialect)`
`void`	`setJarFile(String jarFile)`
`void`	`setJtaDataSource(String jtaDataSource)`
`void`	`setPersistenceUnit(String persistenceUnit)`
`void`	`setPort(String port)`
`void`	`setProvider(String provider)`
`void`	`setReplication(Persistence replication)`
`void`	`setTransactionType(String transactionType)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FIX_PATH
```
public static final String FIX_PATH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SCHEMA
```
public static final String DEFAULT_SCHEMA
```
    See Also:
    
    Constant Field Values
  - DEFAULT_CATALOG
```
public static final String DEFAULT_CATALOG
```
    See Also:
    
    Constant Field Values
  - persistenceUnit
```
protected String persistenceUnit
```
  - transactionType
```
protected String transactionType
```
  - provider
```
protected String provider
```
  - jtaDataSource
```
protected String jtaDataSource
```
  - jarFile
```
protected String jarFile
```
  - connectionDriverClass
```
protected String connectionDriverClass
```
  - connectionUrl
```
protected String connectionUrl
```
  - connectionUserName
```
protected String connectionUserName
```
  - connectionPassword
```
protected String connectionPassword
```
  - hibernateDialect
```
protected String hibernateDialect
```
  - defaultSchema
```
protected String defaultSchema
```
  - datasourceClass
```
protected String datasourceClass
```
  - port
```
protected String port
```
  - database
```
protected String database
```
  - FILE_JDBC_PROP_FILE
```
public static final String FILE_JDBC_PROP_FILE
```
    jdbc connection properties - used by ejb creator
    
    See Also:
    
    Constant Field Values
  - FILE_PERSISTENCE_BEAN
```
public static final String FILE_PERSISTENCE_BEAN
```
    xml serialization of Persistence object
    
    See Also:
    
    Constant Field Values
  - FILE_PERSISTENCE_TML
```
public static final String FILE_PERSISTENCE_TML
```
    persistence template file name
    
    See Also:
    
    Constant Field Values
  - FILE_PERSISTENCE_NOREP_TML
```
public static final String FILE_PERSISTENCE_NOREP_TML
```
    See Also:
    
    Constant Field Values
  - FILE_PERSISTENCE_XML
```
public static final String FILE_PERSISTENCE_XML
```
    standard ejb path to load persistence unit
    
    See Also:
    
    Constant Field Values
  - GEN_HIBERNATE
```
public static final String GEN_HIBERNATE
```
    See Also:
    
    Constant Field Values
  - GEN_OPENJPA
```
public static final String GEN_OPENJPA
```
    See Also:
    
    Constant Field Values
  - HSQLDB_DATABASE_DRIVER
```
public static final String HSQLDB_DATABASE_DRIVER
```
    See Also:
    
    Constant Field Values
  - HSQLDB_DATABASE_URL
```
public static final String HSQLDB_DATABASE_URL
```
    See Also:
    
    Constant Field Values
  - H2_DATABASE_DRIVER
```
public static final String H2_DATABASE_DRIVER
```
    See Also:
    
    Constant Field Values
  - H2_DATABASE_URL
```
public static final String H2_DATABASE_URL
```
    See Also:
    
    Constant Field Values
  - DERBY_DATABASE_DRIVER
```
public static final String DERBY_DATABASE_DRIVER
```
    See Also:
    
    Constant Field Values
  - DERBY_DATABASE_URL
```
public static final String DERBY_DATABASE_URL
```
    See Also:
    
    Constant Field Values
  - STD_LOCAL_DATABASE_DRIVER
```
public static final String STD_LOCAL_DATABASE_DRIVER
```
    See Also:
    
    Constant Field Values
  - STD_LOCAL_DATABASE_URL
```
public static final String STD_LOCAL_DATABASE_URL
```
    See Also:
    
    Constant Field Values
  - STD_LOCAL_DATABASE_DRIVERS
```
public static final String[] STD_LOCAL_DATABASE_DRIVERS
```
- Constructor Detail
  - Persistence
```
public Persistence()
```
    constructor
  - Persistence
```
public Persistence(String jarFile)
```
    constructor
- Method Detail
  - getPersistenceUnit
```
public String getPersistenceUnit()
```
    Returns:
    
    Returns the persistenceUnit.
  - setPersistenceUnit
```
public void setPersistenceUnit(String persistenceUnit)
```
    Parameters:
    
    persistenceUnit - The persistenceUnit to set.
  - getJtaDataSource
```
public String getJtaDataSource()
```
    Returns:
    
    Returns the jtaDataSource.
  - setJtaDataSource
```
public void setJtaDataSource(String jtaDataSource)
```
    Parameters:
    
    jtaDataSource - The jtaDataSource to set.
  - getJarFile
```
public String getJarFile()
```
    Returns:
    
    Returns the jarFile.
  - setJarFile
```
public void setJarFile(String jarFile)
```
    Parameters:
    
    jarFile - The jarFile to set.
  - getConnectionDriverClass
```
public String getConnectionDriverClass()
```
    Returns:
    
    Returns the connectionDriverClass.
  - setConnectionDriverClass
```
public void setConnectionDriverClass(String connectionDriverClass)
```
    Parameters:
    
    connectionDriverClass - The connectionDriverClass to set.
  - getConnectionUrl
```
public String getConnectionUrl()
```
    Returns:
    
    Returns the connectionUrl.
  - setConnectionUrl
```
public void setConnectionUrl(String connectionUrl)
```
    Parameters:
    
    connectionUrl - The connectionUrl to set.
  - getConnectionUserName
```
public String getConnectionUserName()
```
    Returns:
    
    Returns the connectionUserName.
  - setConnectionUserName
```
public void setConnectionUserName(String connectionUserName)
```
    Parameters:
    
    connectionUserName - The connectionUserName to set.
  - getConnectionPassword
```
public String getConnectionPassword()
```
    Returns:
    
    Returns the connectionPassword.
  - setConnectionPassword
```
public void setConnectionPassword(String connectionPassword)
```
    Parameters:
    
    connectionPassword - The connectionPassword to set.
  - getHibernateDialect
```
public String getHibernateDialect()
```
    Returns:
    
    Returns the hibernateDialect.
  - setHibernateDialect
```
public void setHibernateDialect(String hibernateDialect)
```
    Parameters:
    
    hibernateDialect - The hibernateDialect to set.
  - getTransactionType
```
public String getTransactionType()
```
    Returns:
    
    Returns the transactionType.
  - setTransactionType
```
public void setTransactionType(String transactionType)
```
    Parameters:
    
    transactionType - The transactionType to set.
  - getProvider
```
public String getProvider()
```
    Returns:
    
    Returns the provider.
  - setProvider
```
public void setProvider(String provider)
```
    Parameters:
    
    provider - The provider to set.
  - getDefaultSchema
```
public String getDefaultSchema()
```
    Returns:
    
    Returns the defaultSchema.
  - setDefaultSchema
```
public void setDefaultSchema(String defaultSchema)
```
    Parameters:
    
    defaultSchema - The defaultSchema to set.
  - getDatasourceClass
```
public String getDatasourceClass()
```
    Returns:
    
    Returns the datasourceClass.
  - setDatasourceClass
```
public void setDatasourceClass(String datasourceClass)
```
    Parameters:
    
    datasourceClass - The datasourceClass to set.
  - getPort
```
public String getPort()
```
    Returns:
    
    Returns the port.
  - setPort
```
public void setPort(String port)
```
    Parameters:
    
    port - The port to set.
  - getDatabase
```
public String getDatabase()
```
    Returns:
    
    Returns the database.
  - setDatabase
```
public void setDatabase(String database)
```
    Parameters:
    
    database - The database to set.
  - save
```
public String save()
            throws IOException
```
    save serialization, persistence.xml and jdbc property file
    
    Returns:
    
    persistenc.xml content
    
    Throws:
    
    IOException
  - getBeanFileName
```
protected String getBeanFileName()
```
  - saveJdbcProperties
```
protected void saveJdbcProperties()
                           throws IOException
```
    saveJdbcProperties
    
    Throws:
    
    IOException
  - getJdbcProperties
```
public Properties getJdbcProperties()
```
  - getJdbcProperties
```
public Properties getJdbcProperties(boolean viewOnly)
```
    getJdbcProperties
    
    Parameters:
    
    viewOnly - if true, not all properties (like passwd) are filled
    
    Returns:
    
    jdbc-properties
  - put
```
protected <S> void put(Map<S,Object> prop,
                       S key,
                       String value)
```
  - savePersistenceXml
```
protected String savePersistenceXml()
                             throws IOException
```
    Throws:
    
    IOException
  - addPersistenceProperties
```
protected void addPersistenceProperties(Persistence parent,
                                        Map<String,Object> prop)
```
    addPersistenceProperties
    
    Parameters:
    
    prop -
  - jarURL
```
public String jarURL()
```
  - jarFileInEnvironment
```
public String jarFileInEnvironment()
```
    the bean-jar must be in the class-path: this has to be inside the environment directory. jarFileInEnvironment
    
    Returns:
  - exists
```
public static final boolean exists()
```
    exists
    
    Returns:
    
    true, if already defined and saved
  - delete
```
public static final boolean delete()
```
    delete
  - change
```
public final boolean change(String beanjar)
```
    change
    
    Parameters:
    
    beanjar -
    
    Returns:
  - getReplication
```
public Persistence getReplication()
```
  - setReplication
```
public void setReplication(Persistence replication)
```
  - getGenerator
```
public String getGenerator()
```
    Returns:
    
    Returns the generator.
  - setGenerator
```
public void setGenerator(String generator)
```
    Parameters:
    
    generator - The generator to set. One of 'hbm2java' or 'openjpa-reverse-eng'
  - getAutoddl
```
public String getAutoddl()
```
    Returns:
    
    Returns the autoddl.
  - autoDllIsCreateDrop
```
public boolean autoDllIsCreateDrop()
```
    autoDllIsCreateDrop
    
    Returns:
    
    true, if autoddl equals 'create-drop'
  - setAutoddl
```
public void setAutoddl(String autoddl)
```
    Parameters:
    
    autoddl - The autoddl to set.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPath
```
public static String getPath(String file)
```
    returns the full workspace path for the given file
    
    Parameters:
    
    file - file name
    
    Returns:
    
    path
  - getBackupPath
```
public static String getBackupPath(String file)
```
  - current
```
public static Persistence current()
```
    loads an existing one or creates a new one.
    
    Returns:
    
    loaded or created instance
  - getPort
```
public String getPort(String url)
```
    extracts the port of the given database url
    
    Parameters:
    
    url - database url
    
    Returns:
    
    port or null
  - isEmbeddedDatabase
```
public boolean isEmbeddedDatabase()
```
    see isEmbeddedDatabase(String)
  - isEmbeddedDatabase
```
public static boolean isEmbeddedDatabase(String urlOrDriver)
```
    isEmbeddedDatabase
    
    Parameters:
    
    urlOrDriver -
    
    Returns:
    
    true, if it contains hsqldb or h2
  - clone
```
public Persistence clone()
                  throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - getAuth
```
public String getAuth()
```
    getAuth
    
    Returns:
    
    user authentication/authorization name
  - setAuth
```
public void setAuth(String auth)
```

Class Persistence

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIX_PATH

DEFAULT_SCHEMA

DEFAULT_CATALOG

persistenceUnit

transactionType

provider

jtaDataSource

jarFile

connectionDriverClass

connectionUrl

connectionUserName

connectionPassword

hibernateDialect

defaultSchema

datasourceClass

port

database

FILE_JDBC_PROP_FILE

FILE_PERSISTENCE_BEAN

FILE_PERSISTENCE_TML

FILE_PERSISTENCE_NOREP_TML

FILE_PERSISTENCE_XML

GEN_HIBERNATE

GEN_OPENJPA

HSQLDB_DATABASE_DRIVER

HSQLDB_DATABASE_URL

H2_DATABASE_DRIVER

H2_DATABASE_URL

DERBY_DATABASE_DRIVER

DERBY_DATABASE_URL

STD_LOCAL_DATABASE_DRIVER

STD_LOCAL_DATABASE_URL

STD_LOCAL_DATABASE_DRIVERS

Constructor Detail

Persistence

Persistence

Method Detail

getPersistenceUnit

setPersistenceUnit

getJtaDataSource

setJtaDataSource

getJarFile

setJarFile

getConnectionDriverClass

setConnectionDriverClass

getConnectionUrl

setConnectionUrl

getConnectionUserName

setConnectionUserName

getConnectionPassword

setConnectionPassword

getHibernateDialect

setHibernateDialect

getTransactionType

setTransactionType

getProvider

setProvider

getDefaultSchema

setDefaultSchema

getDatasourceClass

setDatasourceClass

getPort

setPort

getDatabase

setDatabase

save

getBeanFileName

saveJdbcProperties

getJdbcProperties

getJdbcProperties

put

savePersistenceXml

addPersistenceProperties

jarURL