org.drools.persistence.jpa.JPAKnowledgeService Maven / Gradle / Ivy
Show all versions of knowledge-api Show documentation
/*
* Copyright 2010 JBoss Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.drools.persistence.jpa;
import org.drools.KnowledgeBase;
import org.drools.KnowledgeBaseFactoryService;
import org.drools.runtime.Environment;
import org.drools.runtime.KnowledgeSessionConfiguration;
import org.drools.runtime.StatefulKnowledgeSession;
import org.drools.util.ServiceRegistryImpl;
/**
*
* Long term out of the box persistence of runtime state with JPA is possible with Drools & jBPM.
* You will need to configure a JPA entity manager (e.g. using hibernate) and have a JTA transaction
* manager (for development/testing purposes we recommend Bitronix as it's simple to setup and works
* embedded, but for production the use of JBoss Transactions is recommended).
*
*
*
* Environment env = KnowledgeBaseFactory.newEnvironment();
* env.set( EnvironmentName.ENTITY_MANAGER_FACTORY, Persistence.createEntityManagerFactory( "emf-name" ) );
* env.set( EnvironmentName.TRANSACTION_MANAGER, TransactionManagerServices.getTransactionManager() );
*
* StatefulKnowledgeSession ksession = JPAKnowledgeService.newStatefulKnowledgeSession( kbase, null, env ); // KnowledgeSessionConfiguration may be null, and a default will be used
* int sessionId = ksession.getId();
*
* ksession.insert( data1 );
* ksession.insert( data2 );
* ksession.startProcess( "process1" );
*
*
*
* To use a JPA the Environment must be set with both the EntityManagerFactory and the TransactionManager. If rollback occurs the ksession state is also rolled back, so you
* can continue to use it after a rollback. To load a previous persisted StatefulKnowledgeSession you'll need the id, as shown below:
*
*
*
* StatefulKnowledgeSession ksession = JPAKnowledgeService.loadStatefulKnowledgeSession( sessionId, kbase, null, env );
*
*
*
* If you do not define any transaction boundaries, each command (i.e. each invocation of a method of
* the session) will be executed inside its own transaction. You can define the transaction boundaries
* yourself using a JTA UserTransaction.
*
*
*
* UserTransaction ut = (UserTransaction) new InitialContext().lookup( "java:comp/UserTransaction" );
* ut.begin();
* ksession.insert( data1 );
* ksession.insert( data2 );
* ksession.startProcess( "process1" );
* ut.commit();
*
*
*
* To enable persistence the following classes must be added to your persistence.xml, as in the example below:
*
*
*
* <persistence-unit name="org.jbpm.persistence.jpa" transaction-type="JTA">
* <provider>org.hibernate.ejb.HibernatePersistence</provider>
* <jta-data-source>jdbc/BitronixJTADataSource</jta-data-source>
* <class>org.jbpm.persistence.processinstance.ProcessInstanceInfo</class>
* <class>org.drools.persistence.info.ProcessInstanceInfo</class>
* <class>org.drools.persistence.info.WorkItemInfo</class>
* <properties>
* <property name="hibernate.dialect" value="org.hibernate.dialect.H2Dialect"/>
* <property name="hibernate.max_fetch_depth" value="3"/>
* <property name="hibernate.hbm2ddl.auto" value="update" />
* <property name="hibernate.show_sql" value="true" />
* <property name="hibernate.transaction.manager_lookup_class" value="org.hibernate.transaction.BTMTransactionManagerLookup" />
* </properties>
* </persistence-unit>
*
*
*
* The jdbc JTA data source would need to be previously bound, Bitronix provides a number of ways of doing this and it's docs shoud be contacted for more details, however
* for quick start help here is the programmatic approach:
*
*
* PoolingDataSource ds = new PoolingDataSource();
* ds.setUniqueName( "jdbc/BitronixJTADataSource" );
* ds.setClassName( "org.h2.jdbcx.JdbcDataSource" );
* ds.setMaxPoolSize( 3 );
* ds.setAllowLocalTransactions( true );
* ds.getDriverProperties().put( "user", "sa" );
* ds.getDriverProperties().put( "password", "sasa" );
* ds.getDriverProperties().put( "URL", "jdbc:h2:mem:mydb" );
* ds.init();
*
*
*
* Bitronix also provides a simple embedded JNDI service, ideal for testing, to use it add a jndi.properties file at the root of your classpath and add the following line to it:
*
*
*
* java.naming.factory.initial=bitronix.tm.jndi.BitronixInitialContextFactory
*
*/
public class JPAKnowledgeService {
private static KnowledgeStoreService provider;
public static StatefulKnowledgeSession newStatefulKnowledgeSession(KnowledgeBase kbase,
KnowledgeSessionConfiguration configuration,
Environment environment) {
return getJPAKnowledgeServiceProvider().newStatefulKnowledgeSession( kbase,
configuration,
environment );
}
@Deprecated
public static StatefulKnowledgeSession loadStatefulKnowledgeSession(int id,
KnowledgeBase kbase,
KnowledgeSessionConfiguration configuration,
Environment environment) {
return getJPAKnowledgeServiceProvider().loadStatefulKnowledgeSession( id,
kbase,
configuration,
environment );
}
public static StatefulKnowledgeSession loadStatefulKnowledgeSession(Long id,
KnowledgeBase kbase,
KnowledgeSessionConfiguration configuration,
Environment environment) {
return getJPAKnowledgeServiceProvider().loadStatefulKnowledgeSession( id,
kbase,
configuration,
environment );
}
private static synchronized void setJPAKnowledgeServiceProvider(KnowledgeStoreService provider) {
JPAKnowledgeService.provider = provider;
}
private static synchronized KnowledgeStoreService getJPAKnowledgeServiceProvider() {
if ( provider == null ) {
loadProvider();
}
return provider;
}
@SuppressWarnings("unchecked")
private static void loadProvider() {
try {
// we didn't find anything in properties so lets try and us reflection
Class cls = (Class) Class.forName( "org.drools.impl.KnowledgeStoreServiceImpl" );
setJPAKnowledgeServiceProvider( cls.newInstance() );
} catch ( Exception e ) {
throw new RuntimeException( "Provider org.drools.impl.KnowledgeStoreServiceImpl could not be set.",
e );
}
}
}