/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.apache.isis.objectstore.jdo.datanucleus;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import javax.jdo.PersistenceManagerFactory;
import com.google.common.collect.Sets;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.isis.applib.DomainObjectContainer;
import org.apache.isis.core.commons.components.Installer;
import org.apache.isis.core.commons.config.IsisConfiguration;
import org.apache.isis.core.metamodel.adapter.ObjectAdapterFactory;
import org.apache.isis.core.metamodel.progmodel.ProgrammingModel;
import org.apache.isis.core.metamodel.spec.ObjectSpecification;
import org.apache.isis.core.metamodel.spec.SpecificationLoaderSpi;
import org.apache.isis.core.metamodel.specloader.classsubstitutor.ClassSubstitutor;
import org.apache.isis.core.metamodel.specloader.validator.MetaModelValidatorComposite;
import org.apache.isis.core.runtime.bytecode.dflt.ObjectFactoryBasic;
import org.apache.isis.core.runtime.installerregistry.installerapi.PersistenceMechanismInstallerAbstract;
import org.apache.isis.core.runtime.persistence.objectstore.ObjectStoreSpi;
import org.apache.isis.core.runtime.persistence.objectstore.algorithm.PersistAlgorithm;
import org.apache.isis.core.runtime.system.context.IsisContext;
import org.apache.isis.core.runtime.system.persistence.AdapterManagerSpi;
import org.apache.isis.core.runtime.system.persistence.IdentifierGenerator;
import org.apache.isis.core.runtime.system.persistence.ObjectFactory;
import org.apache.isis.objectstore.jdo.datanucleus.bytecode.DataNucleusTypesClassSubstitutor;
import org.apache.isis.objectstore.jdo.datanucleus.persistence.adaptermanager.DataNucleusPojoRecreator;
import org.apache.isis.objectstore.jdo.datanucleus.persistence.spi.DataNucleusIdentifierGenerator;
import org.apache.isis.objectstore.jdo.datanucleus.persistence.spi.DataNucleusSimplePersistAlgorithm;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.auditable.AuditableAnnotationInJdoApplibFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.auditable.AuditableMarkerInterfaceInJdoApplibFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.datastoreidentity.JdoDatastoreIdentityAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.discriminator.JdoDiscriminatorAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.embeddedonly.JdoEmbeddedOnlyAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.embeddedonly.JdoEmbeddedOnlyFacet;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.persistencecapable.JdoPersistenceCapableAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.persistencecapable.JdoPersistenceCapableFacet;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.query.JdoQueryAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.object.version.JdoVersionAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.prop.column.BigDecimalDerivedFromJdoColumnAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.prop.column.MandatoryFromJdoColumnAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.prop.column.MaxLengthDerivedFromJdoColumnAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.prop.notpersistent.JdoNotPersistentAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.facets.prop.primarykey.JdoPrimaryKeyAnnotationFacetFactory;
import org.apache.isis.objectstore.jdo.metamodel.specloader.validator.JdoMetaModelValidator;
import org.apache.isis.objectstore.jdo.service.RegisterEntities;
/**
* Configuration files are read in the usual fashion (as per {@link Installer#getConfigurationResources()}, ie will consult all of:
* <ul>
* <li><tt>persistor_datanucleus.properties</tt>
* <li><tt>persistor.properties</tt>
* <li><tt>isis.properties</tt>
* </ul>
*
* <p>
* With respect to configuration, all properties under {@value #ISIS_CONFIG_PREFIX} prefix are passed
* through verbatim to the DataNucleus runtime. For example:
* <table>
* <tr><th>Isis Property</th><th>DataNucleus Property</th></tr>
* <tr><td><tt>isis.persistor.datanucleus.impl.datanucleus.foo.Bar</tt></td><td><tt>datanucleus.foo.Bar</tt></td></tr>
* </table>
*
*/
public class DataNucleusPersistenceMechanismInstaller extends PersistenceMechanismInstallerAbstract {
private static final Logger LOG = LoggerFactory.getLogger(DataNucleusPersistenceMechanismInstaller.class);
public static final String NAME = "datanucleus";
private static final String ISIS_CONFIG_PREFIX = "isis.persistor.datanucleus.impl";
private DataNucleusApplicationComponents applicationComponents = null;
public DataNucleusPersistenceMechanismInstaller() {
super(NAME);
}
////////////////////////////////////////////////////////////////////////
// createObjectStore
////////////////////////////////////////////////////////////////////////
@Override
protected ObjectStoreSpi createObjectStore(IsisConfiguration configuration, ObjectAdapterFactory adapterFactory, AdapterManagerSpi adapterManager) {
createDataNucleusApplicationComponentsIfRequired(configuration);
return new DataNucleusObjectStore(adapterFactory, applicationComponents);
}
private void createDataNucleusApplicationComponentsIfRequired(IsisConfiguration configuration) {
// this is, perhaps doing more work than necessary...
// maybe retain the applicationComponents and just tell it to discard its PMF?
// (doubt will make much different in terms of the amount of time to process, though)
if(applicationComponents != null && !applicationComponents.isStale()) {
return;
}
final IsisConfiguration dataNucleusConfig = configuration.createSubset(ISIS_CONFIG_PREFIX);
final Map<String, String> props = dataNucleusConfig.asMap();
addDataNucleusPropertiesIfRequired(props);
final Set<String> classesToBePersisted = catalogClassesToBePersisted(configuration, getSpecificationLoader().allSpecifications());
applicationComponents = new DataNucleusApplicationComponents(props, classesToBePersisted);
}
private static Set<String> catalogClassesToBePersisted(final IsisConfiguration configuration, Collection<ObjectSpecification> objectSpecs) {
final RegisterEntities registerEntities = new RegisterEntities();
registerEntities.init(configuration.asMap());
Set<String> classNames = Sets.newTreeSet();
for (final ObjectSpecification spec : objectSpecs) {
if(spec.containsFacet(JdoPersistenceCapableFacet.class) || spec.containsFacet(JdoEmbeddedOnlyFacet.class)) {
classNames.add(spec.getFullIdentifier());
}
}
return Collections.unmodifiableSet(classNames);
}
private static void addDataNucleusPropertiesIfRequired(
final Map<String, String> props) {
// new feature in DN 3.2.3; enables dependency injection into entities
putIfNotPresent(props, "datanucleus.objectProvider.className", "org.apache.isis.objectstore.jdo.datanucleus.JDOStateManagerForIsis");
putIfNotPresent(props, "javax.jdo.PersistenceManagerFactoryClass", "org.datanucleus.api.jdo.JDOPersistenceManagerFactory");
putIfNotPresent(props, "datanucleus.autoCreateSchema", "true");
putIfNotPresent(props, "datanucleus.validateSchema", "true");
putIfNotPresent(props, "datanucleus.cache.level2.type", "none");
putIfNotPresent(props, "datanucleus.persistenceUnitLoadClasses", "true");
String connectionFactoryName = props.get("datanucleus.ConnectionFactoryName");
if(connectionFactoryName != null) {
String connectionFactory2Name = props.get("datanucleus.ConnectionFactory2Name");
String transactionType = props.get("javax.jdo.option.TransactionType");
if(transactionType == null) {
LOG.info("found non-JTA JNDI datasource (" + connectionFactoryName + ")");
if(connectionFactory2Name != null) {
LOG.warn("found non-JTA JNDI datasource (" + connectionFactoryName + "); second '-nontx' JNDI datasource configured but will not be used (" + connectionFactory2Name +")");
}
} else
LOG.info("found JTA JNDI datasource (" + connectionFactoryName + ")");
if(connectionFactory2Name == null) {
// JDO/DN itself will (probably) throw an exception
LOG.error("found JTA JNDI datasource (" + connectionFactoryName + ") but second '-nontx' JNDI datasource *not* found");
} else {
LOG.info("... and second '-nontx' JNDI datasource found; " + connectionFactory2Name);
}
// nothing further to do
return;
} else {
// use JDBC connection properties; put if not present
LOG.info("did *not* find JNDI datasource; will use JDBC");
putIfNotPresent(props, "javax.jdo.option.ConnectionDriverName", "org.hsqldb.jdbcDriver");
putIfNotPresent(props, "javax.jdo.option.ConnectionURL", "jdbc:hsqldb:mem:test");
putIfNotPresent(props, "javax.jdo.option.ConnectionUserName", "sa");
putIfNotPresent(props, "javax.jdo.option.ConnectionPassword", "");
}
}
private static void putIfNotPresent(
final Map<String, String> props,
String key,
String value) {
if(!props.containsKey(key)) {
props.put(key, value);
}
}
////////////////////////////////////////////////////////////////////////
// PersistenceSessionFactoryDelegate impl
////////////////////////////////////////////////////////////////////////
@Override
protected PersistAlgorithm createPersistAlgorithm(IsisConfiguration configuration) {
return new DataNucleusSimplePersistAlgorithm();
}
@Override
public IdentifierGenerator createIdentifierGenerator(IsisConfiguration configuration) {
return new DataNucleusIdentifierGenerator();
}
@Override
public ClassSubstitutor createClassSubstitutor(IsisConfiguration configuration) {
return new DataNucleusTypesClassSubstitutor();
}
@Override
public void refineProgrammingModel(ProgrammingModel programmingModel, IsisConfiguration configuration) {
programmingModel.addFactory(JdoPersistenceCapableAnnotationFacetFactory.class);
programmingModel.addFactory(JdoDatastoreIdentityAnnotationFacetFactory.class);
programmingModel.addFactory(JdoEmbeddedOnlyAnnotationFacetFactory.class);
programmingModel.addFactory(JdoPrimaryKeyAnnotationFacetFactory.class);
programmingModel.addFactory(JdoNotPersistentAnnotationFacetFactory.class);
programmingModel.addFactory(JdoDiscriminatorAnnotationFacetFactory.class);
programmingModel.addFactory(JdoVersionAnnotationFacetFactory.class);
programmingModel.addFactory(JdoQueryAnnotationFacetFactory.class);
programmingModel.addFactory(BigDecimalDerivedFromJdoColumnAnnotationFacetFactory.class);
programmingModel.addFactory(MaxLengthDerivedFromJdoColumnAnnotationFacetFactory.class);
// must appear after JdoPrimaryKeyAnnotationFacetFactory (above)
programmingModel.addFactory(MandatoryFromJdoColumnAnnotationFacetFactory.class);
programmingModel.addFactory(AuditableAnnotationInJdoApplibFacetFactory.class);
programmingModel.addFactory(AuditableMarkerInterfaceInJdoApplibFacetFactory.class);
}
@Override
public void refineMetaModelValidator(MetaModelValidatorComposite metaModelValidator, IsisConfiguration configuration) {
metaModelValidator.add(new JdoMetaModelValidator());
}
@Override
public ObjectFactory createObjectFactory(IsisConfiguration configuration) {
return new ObjectFactoryBasic();
}
@Override
public DataNucleusPojoRecreator createPojoRecreator(IsisConfiguration configuration) {
return new DataNucleusPojoRecreator();
}
////////////////////////////////////////////////////////////////////////
public PersistenceManagerFactory getPersistenceManagerFactory() {
return this.applicationComponents.getPersistenceManagerFactory();
}
////////////////////////////////////////////////////////////////////////
// Dependencies
////////////////////////////////////////////////////////////////////////
protected SpecificationLoaderSpi getSpecificationLoader() {
return IsisContext.getSpecificationLoader();
}
}