PersistenceUtil (jBPM :: Test Util 7.52.0-SNAPSHOT API)

java.lang.Object
- org.jbpm.test.persistence.util.PersistenceUtil

public class PersistenceUtil
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOW_LOCAL_TXS`
`static String`	`DATABASE_NAME`
`static String`	`DATASOURCE`
`static String`	`DATASOURCE_CLASS_NAME`
`protected static String`	`DATASOURCE_PROPERTIES`
`static String`	`DRIVER_CLASS_NAME`
`static String`	`DROOLS_LOCAL_PERSISTENCE_UNIT_NAME`
`static String`	`DROOLS_PERSISTENCE_UNIT_NAME`
`static String`	`JBPM_LOCAL_PERSISTENCE_UNIT_NAME`
`static String`	`JBPM_PERSISTENCE_UNIT_NAME`
`static String`	`JDBC_URL`
`static String`	`MAX_POOL_SIZE`
`static String`	`PASSWORD`
`static String`	`SERVER_NAME`
`static String`	`SERVER_PORT`
`static String`	`USER`

Constructor Summary

Constructors
Constructor and Description

PersistenceUtil()

Constructors
Constructor and Description
`PersistenceUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`cleanUp(Map<String,Object> context)` This method should be called in the @After method of a test to clean up the persistence unit and datasource.
`static org.kie.api.runtime.Environment`	`createEnvironment(Map<String,Object> context)`
`static org.kie.api.runtime.KieSession`	`createKieSessionFromKBase(org.kie.api.KieBase kbase, Map<String,Object> context)`
`static Properties`	`getDatasourceProperties()` This reads in the (maven filtered) datasource properties from the test resource directory.
`static org.kie.test.util.db.PoolingDataSourceWrapper`	`setupPoolingDataSource(Properties dsProps)` This method uses the "jdbc/testDS1" datasource, which is the default.
`static org.kie.test.util.db.PoolingDataSourceWrapper`	`setupPoolingDataSource(Properties dsProps, String datasourceName)` This sets up a PoolingDataSourceWrapper.
`static HashMap<String,Object>`	`setupWithPoolingDataSource(String persistenceUnitName)`
`static HashMap<String,Object>`	`setupWithPoolingDataSource(String persistenceUnitName, String dataSourceName)` This method does all of the setup for the test and returns a HashMap containing the persistence objects that the test might need.
`static void`	`startH2TcpServer(Properties datasourceProperties)` This method starts H2 database server (tcp).
`static void`	`stopH2TcpServer()` This method stops H2 database server (tcp).
`static boolean`	`useTransactions()` This method returns whether or not transactions should be used when dealing with the SessionInfo object (or any other persisted entity that contains @Lob's )

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

- Field Detail
  - DROOLS_PERSISTENCE_UNIT_NAME
```
public static final String DROOLS_PERSISTENCE_UNIT_NAME
```
    See Also:
    
    Constant Field Values
  - DROOLS_LOCAL_PERSISTENCE_UNIT_NAME
```
public static final String DROOLS_LOCAL_PERSISTENCE_UNIT_NAME
```
    See Also:
    
    Constant Field Values
  - JBPM_PERSISTENCE_UNIT_NAME
```
public static final String JBPM_PERSISTENCE_UNIT_NAME
```
    See Also:
    
    Constant Field Values
  - JBPM_LOCAL_PERSISTENCE_UNIT_NAME
```
public static final String JBPM_LOCAL_PERSISTENCE_UNIT_NAME
```
    See Also:
    
    Constant Field Values
  - DATASOURCE_PROPERTIES
```
protected static final String DATASOURCE_PROPERTIES
```
    See Also:
    
    Constant Field Values
  - MAX_POOL_SIZE
```
public static final String MAX_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - ALLOW_LOCAL_TXS
```
public static final String ALLOW_LOCAL_TXS
```
    See Also:
    
    Constant Field Values
  - SERVER_NAME
```
public static final String SERVER_NAME
```
    See Also:
    
    Constant Field Values
  - SERVER_PORT
```
public static final String SERVER_PORT
```
    See Also:
    
    Constant Field Values
  - DATABASE_NAME
```
public static final String DATABASE_NAME
```
    See Also:
    
    Constant Field Values
  - DATASOURCE_CLASS_NAME
```
public static final String DATASOURCE_CLASS_NAME
```
    See Also:
    
    Constant Field Values
  - DRIVER_CLASS_NAME
```
public static final String DRIVER_CLASS_NAME
```
    See Also:
    
    Constant Field Values
  - USER
```
public static final String USER
```
    See Also:
    
    Constant Field Values
  - PASSWORD
```
public static final String PASSWORD
```
    See Also:
    
    Constant Field Values
  - JDBC_URL
```
public static final String JDBC_URL
```
    See Also:
    
    Constant Field Values
  - DATASOURCE
```
public static final String DATASOURCE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PersistenceUtil
```
public PersistenceUtil()
```
- Method Detail
  - setupWithPoolingDataSource
```
public static HashMap<String,Object> setupWithPoolingDataSource(String persistenceUnitName)
```
    Parameters:
    
    persistenceUnitName - The name of the persistence unit to be used.
    
    Returns:
    
    test context
    
    See Also:
    
    setupWithPoolingDataSource(String, String)
  - setupWithPoolingDataSource
```
public static HashMap<String,Object> setupWithPoolingDataSource(String persistenceUnitName,
                                                                String dataSourceName)
```
    This method does all of the setup for the test and returns a HashMap containing the persistence objects that the test might need.
    
    Parameters:
    
    persistenceUnitName - The name of the persistence unit used by the test.
    
    Returns:
    
    HashMap with persistence objects, such as the EntityManagerFactory and DataSource
  - startH2TcpServer
```
public static void startH2TcpServer(Properties datasourceProperties)
```
    This method starts H2 database server (tcp).
    
    Parameters:
    
    datasourceProperties - The properties used to setup the data source.
  - stopH2TcpServer
```
public static void stopH2TcpServer()
```
    This method stops H2 database server (tcp).
  - cleanUp
```
public static void cleanUp(Map<String,Object> context)
```
    This method should be called in the @After method of a test to clean up the persistence unit and datasource.
    
    Parameters:
    
    context - A HashMap generated by setupWithPoolingDataSource(String)
  - setupPoolingDataSource
```
public static org.kie.test.util.db.PoolingDataSourceWrapper setupPoolingDataSource(Properties dsProps)
```
    This method uses the "jdbc/testDS1" datasource, which is the default.
    
    Parameters:
    
    dsProps - The properties used to setup the data source.
    
    Returns:
    
    a PoolingDataSourceWrapper
  - setupPoolingDataSource
```
public static org.kie.test.util.db.PoolingDataSourceWrapper setupPoolingDataSource(Properties dsProps,
                                                                                   String datasourceName)
```
    This sets up a PoolingDataSourceWrapper.
    
    Returns:
    
    PoolingDataSourceWrapper that has been set up but _not_ initialized.
  - getDatasourceProperties
```
public static Properties getDatasourceProperties()
```
    This reads in the (maven filtered) datasource properties from the test resource directory.
    
    Returns:
    
    Properties containing the datasource properties.
  - useTransactions
```
public static boolean useTransactions()
```
    This method returns whether or not transactions should be used when dealing with the SessionInfo object (or any other persisted entity that contains @Lob's )
    
    Returns:
    
    boolean Whether or not to use transactions
  - createEnvironment
```
public static org.kie.api.runtime.Environment createEnvironment(Map<String,Object> context)
```
  - createKieSessionFromKBase
```
public static org.kie.api.runtime.KieSession createKieSessionFromKBase(org.kie.api.KieBase kbase,
                                                                       Map<String,Object> context)
```

Class PersistenceUtil

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DROOLS_PERSISTENCE_UNIT_NAME

DROOLS_LOCAL_PERSISTENCE_UNIT_NAME

JBPM_PERSISTENCE_UNIT_NAME

JBPM_LOCAL_PERSISTENCE_UNIT_NAME

DATASOURCE_PROPERTIES

MAX_POOL_SIZE

ALLOW_LOCAL_TXS

SERVER_NAME

SERVER_PORT

DATABASE_NAME

DATASOURCE_CLASS_NAME

DRIVER_CLASS_NAME

USER

PASSWORD

JDBC_URL

DATASOURCE

Constructor Detail

PersistenceUtil

Method Detail

setupWithPoolingDataSource

setupWithPoolingDataSource

startH2TcpServer

stopH2TcpServer

cleanUp

setupPoolingDataSource

setupPoolingDataSource

getDatasourceProperties

useTransactions

createEnvironment

createKieSessionFromKBase