import java.io.Reader;
import java.util.ArrayList;
import java.util.HashMap;
+import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Properties;
+import java.util.Set;
+import java.util.TreeSet;
import java.util.concurrent.Executor;
import javax.jcr.Credentials;
import org.apache.jackrabbit.jcr2dav.Jcr2davRepositoryFactory;
import org.argeo.ArgeoException;
import org.argeo.jcr.JcrUtils;
-import org.springframework.beans.factory.DisposableBean;
-import org.springframework.beans.factory.InitializingBean;
import org.springframework.context.ResourceLoaderAware;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
* Wrapper around a Jackrabbit repository which allows to configure it in Spring
* and expose it as a {@link Repository}.
*/
-public class JackrabbitContainer implements InitializingBean, DisposableBean,
- Repository, ResourceLoaderAware {
+public class JackrabbitContainer implements Repository, ResourceLoaderAware {
private Log log = LogFactory.getLog(JackrabbitContainer.class);
private Resource configuration;
- private File homeDirectory;
+ private String homeDirectory;
private Resource variables;
+ /** cache home */
+ private File home;
private Boolean inMemory = false;
private String uri = null;
/** Node type definitions in CND format */
private List<String> cndFiles = new ArrayList<String>();
+ /** Migrations to execute (if not already done) */
+ private Set<JackrabbitDataModelMigration> dataModelMigrations = new HashSet<JackrabbitDataModelMigration>();
+
/** Namespaces to register: key is prefix, value namespace */
private Map<String, String> namespaces = new HashMap<String, String>();
private Boolean autocreateWorkspaces = false;
private Executor systemExecutor;
- private Credentials adminCredentials;
-
- // transition from legacy spring approach
- private Boolean alreadyInitialized = false;
- private Boolean alreadyDisposed = false;
-
- /** @deprecated explicitly declare {@link #init()} as init-method instead. */
- public void afterPropertiesSet() throws Exception {
- if (!alreadyInitialized) {
- log.warn("## If not already done,"
- + " declare init-method=\"init\".");
- initImpl();
- }
- }
public void init() throws Exception {
- initImpl();
- alreadyInitialized = true;
- }
-
- protected void initImpl() throws Exception {
if (repository != null) {
// we are just wrapping another repository
importNodeTypeDefinitions(repository);
return;
}
- // remote repository
- if (uri != null && !uri.trim().equals("")) {
- Map<String, String> params = new HashMap<String, String>();
- params.put(org.apache.jackrabbit.commons.JcrUtils.REPOSITORY_URI,
- uri);
- repository = new Jcr2davRepositoryFactory().getRepository(params);
- if (repository == null)
- throw new ArgeoException("Remote Davex repository " + uri
- + " not found");
- log.info("Initialized Jackrabbit repository " + repository
- + " from URI " + uri);
- // do not perform further initialization since we assume that the
- // remote repository has been properly configured
- return;
- }
+ repository = createJackrabbitRepository();
- // local repository
- if (inMemory && homeDirectory.exists()) {
- FileUtils.deleteDirectory(homeDirectory);
- log.warn("Deleted Jackrabbit home directory " + homeDirectory);
- }
+ // migrate if needed
+ migrate();
+
+ // apply new CND files after migration
+ if (cndFiles != null && cndFiles.size() > 0)
+ importNodeTypeDefinitions(repository);
+ }
- RepositoryConfig config;
- Properties vars = getConfigurationProperties();
- InputStream in = configuration.getInputStream();
+ /** Actually creates a new repository. */
+ protected JackrabbitRepository createJackrabbitRepository() {
+ JackrabbitRepository repository;
try {
- vars.put(RepositoryConfigurationParser.REPOSITORY_HOME_VARIABLE,
- homeDirectory.getCanonicalPath());
- config = RepositoryConfig.create(new InputSource(in), vars);
+ // remote repository
+ if (uri != null && !uri.trim().equals("")) {
+ Map<String, String> params = new HashMap<String, String>();
+ params.put(
+ org.apache.jackrabbit.commons.JcrUtils.REPOSITORY_URI,
+ uri);
+ repository = (JackrabbitRepository) new Jcr2davRepositoryFactory()
+ .getRepository(params);
+ if (repository == null)
+ throw new ArgeoException("Remote Davex repository " + uri
+ + " not found");
+ log.info("Initialized Jackrabbit repository " + repository
+ + " from URI " + uri);
+ // do not perform further initialization since we assume that
+ // the
+ // remote repository has been properly configured
+ return repository;
+ }
+
+ // local repository
+ if (inMemory && getHome().exists()) {
+ FileUtils.deleteDirectory(getHome());
+ log.warn("Deleted Jackrabbit home directory " + getHome());
+ }
+
+ RepositoryConfig config;
+ Properties vars = getConfigurationProperties();
+ InputStream in = configuration.getInputStream();
+ try {
+ vars.put(
+ RepositoryConfigurationParser.REPOSITORY_HOME_VARIABLE,
+ getHome().getCanonicalPath());
+ config = RepositoryConfig.create(new InputSource(in), vars);
+ } catch (Exception e) {
+ throw new RuntimeException("Cannot read configuration", e);
+ } finally {
+ IOUtils.closeQuietly(in);
+ }
+
+ if (inMemory)
+ repository = new TransientRepository(config);
+ else
+ repository = RepositoryImpl.create(config);
+
+ log.info("Initialized Jackrabbit repository " + repository + " in "
+ + getHome() + " with config " + configuration);
+
+ return repository;
} catch (Exception e) {
- throw new RuntimeException("Cannot read configuration", e);
- } finally {
- IOUtils.closeQuietly(in);
+ throw new ArgeoException("Cannot create Jackrabbit repository "
+ + getHome(), e);
}
+ }
- if (inMemory)
- repository = new TransientRepository(config);
- else
- repository = RepositoryImpl.create(config);
+ /** Executes migrations, if needed. */
+ protected void migrate() {
+ Boolean restartAndClearCaches = false;
- if (cndFiles != null && cndFiles.size() > 0)
- importNodeTypeDefinitions(repository);
+ // migrate data
+ Session session = null;
+ try {
+ session = login();
+ for (JackrabbitDataModelMigration dataModelMigration : new TreeSet<JackrabbitDataModelMigration>(
+ dataModelMigrations)) {
+ if (dataModelMigration.migrate(session)) {
+ restartAndClearCaches = true;
+ }
+ }
+ } catch (ArgeoException e) {
+ throw e;
+ } catch (Exception e) {
+ throw new ArgeoException("Cannot migrate", e);
+ } finally {
+ JcrUtils.logoutQuietly(session);
+ }
- log.info("Initialized Jackrabbit repository " + repository + " in "
- + homeDirectory + " with config " + configuration);
+ // restart repository
+ if (restartAndClearCaches) {
+ ((JackrabbitRepository) repository).shutdown();
+ JackrabbitDataModelMigration.clearRepositoryCaches(getHome());
+ repository = createJackrabbitRepository();
+ }
}
- /**
- * @deprecated explicitly declare {@link #dispose()} as destroy-method
- * instead.
- */
- public void destroy() throws Exception {
- if (!alreadyDisposed) {
- log.warn("## If not already done,"
- + " declare destroy-method=\"dispose\".");
- disposeImpl();
+ /** Lazy init. */
+ protected File getHome() {
+ if (home != null)
+ return home;
+
+ try {
+ String osgiData = System.getProperty("osgi.instance.area");
+ if (osgiData != null)
+ osgiData = osgiData.substring("file:".length());
+ String path;
+ if (homeDirectory == null)
+ path = "./jackrabbit";
+ else
+ path = homeDirectory;
+ if (path.startsWith(".") && osgiData != null) {
+ home = new File(osgiData + '/' + path).getCanonicalFile();
+ } else
+ home = new File(path).getCanonicalFile();
+ return home;
+ } catch (Exception e) {
+ throw new ArgeoException("Cannot define Jackrabbit home based on "
+ + homeDirectory, e);
}
}
public void dispose() throws Exception {
- disposeImpl();
- alreadyDisposed = true;
- }
-
- protected void disposeImpl() throws Exception {
if (repository != null) {
if (repository instanceof JackrabbitRepository)
((JackrabbitRepository) repository).shutdown();
}
if (inMemory)
- if (homeDirectory.exists()) {
- FileUtils.deleteDirectory(homeDirectory);
+ if (getHome().exists()) {
+ FileUtils.deleteDirectory(getHome());
if (log.isDebugEnabled())
- log.debug("Deleted Jackrabbit home directory "
- + homeDirectory);
+ log.debug("Deleted Jackrabbit home directory " + getHome());
}
if (uri != null && !uri.trim().equals(""))
log.info("Destroyed Jackrabbit repository with uri " + uri);
else
log.info("Destroyed Jackrabbit repository " + repository + " in "
- + homeDirectory + " with config " + configuration);
+ + getHome() + " with config " + configuration);
+ }
+
+ /**
+ * @deprecated explicitly declare {@link #dispose()} as destroy-method
+ * instead.
+ */
+ public void destroy() throws Exception {
+ log.error("## Declare destroy-method=\"dispose\". in the Jackrabbit container bean");
+ }
+
+ /** @deprecated explicitly declare {@link #init()} as init-method instead. */
+ public void afterPropertiesSet() throws Exception {
+ log.error("## Declare init-method=\"init\". in the Jackrabbit container bean");
}
protected Properties getConfigurationProperties() {
* will be thrown.
*/
protected void importNodeTypeDefinitions(final Repository repository) {
- final Credentials credentialsToUse = null;
- // if (systemExecutor == null) {
- // if (adminCredentials == null) {
- // log.error("No system executor or admin credentials found,"
- // + " cannot import node types");
- // return;
- // }
- // credentialsToUse = adminCredentials;
- // } else {
- // credentialsToUse = null;
- // }
-
Runnable action = new Runnable() {
public void run() {
Reader reader = null;
Session session = null;
try {
- session = repository.login(credentialsToUse);
+ session = repository.login();
processNewSession(session);
// Load cnds as resources
for (String resUrl : cndFiles) {
}
// BEANS METHODS
- public void setHomeDirectory(File homeDirectory) {
+ public void setHomeDirectory(String homeDirectory) {
this.homeDirectory = homeDirectory;
}
this.systemExecutor = systemExecutor;
}
- public void setAdminCredentials(Credentials adminCredentials) {
- this.adminCredentials = adminCredentials;
- }
-
public void setRepository(Repository repository) {
this.repository = repository;
}
+ public void setDataModelMigrations(
+ Set<JackrabbitDataModelMigration> dataModelMigrations) {
+ this.dataModelMigrations = dataModelMigrations;
+ }
+
}
--- /dev/null
+package org.argeo.jackrabbit;
+
+import java.io.File;
+import java.io.InputStreamReader;
+import java.io.Reader;
+
+import javax.jcr.Node;
+import javax.jcr.Session;
+
+import org.apache.commons.io.IOUtils;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.jackrabbit.commons.cnd.CndImporter;
+import org.argeo.ArgeoException;
+import org.argeo.jcr.ArgeoNames;
+import org.argeo.jcr.JcrCallback;
+import org.argeo.jcr.JcrUtils;
+import org.springframework.core.io.Resource;
+
+/** Migrate the data in a Jackrabbit repository. */
+public class JackrabbitDataModelMigration implements
+ Comparable<JackrabbitDataModelMigration> {
+ private final static Log log = LogFactory
+ .getLog(JackrabbitDataModelMigration.class);
+
+ private String dataModelNodePath;
+ private String targetVersion;
+ private Resource migrationCnd;
+ private JcrCallback dataModification;
+
+ /**
+ * Expects an already started repository with the old data model to migrate.
+ * Expects to be run with admin rights (Repository.login() will be used).
+ *
+ * @return true if a migration was performed and the repository needs to be
+ * restarted and its caches cleared.
+ */
+ public Boolean migrate(Session adminSession) {
+ long begin = System.currentTimeMillis();
+ Reader reader = null;
+ try {
+ // check if already migrated
+ if (!adminSession.itemExists(dataModelNodePath)) {
+ log.warn("Node " + dataModelNodePath
+ + " does not exist: nothing to migrate.");
+ return false;
+ }
+ Node dataModelNode = adminSession.getNode(dataModelNodePath);
+ if (dataModelNode.hasProperty(ArgeoNames.ARGEO_DATA_MODEL_VERSION)) {
+ String currentVersion = dataModelNode.getProperty(
+ ArgeoNames.ARGEO_DATA_MODEL_VERSION).getString();
+ if (compareVersions(currentVersion, targetVersion) >= 0) {
+ log.info("Data model at version " + currentVersion
+ + ", no need to migrate.");
+ return false;
+ }
+ }
+
+ // apply transitional CND
+ reader = new InputStreamReader(migrationCnd.getInputStream());
+ CndImporter.registerNodeTypes(reader, adminSession, true);
+
+ // modify data
+ dataModification.execute(adminSession);
+
+ // set data model version
+ dataModelNode.setProperty(ArgeoNames.ARGEO_DATA_MODEL_VERSION,
+ targetVersion);
+
+ // apply changes
+ adminSession.save();
+
+ long duration = System.currentTimeMillis() - begin;
+ log.info("Migration of data model " + dataModelNodePath + " to "
+ + targetVersion + " performed in " + duration + "ms");
+ return true;
+ } catch (Exception e) {
+ JcrUtils.discardQuietly(adminSession);
+ throw new ArgeoException("Migration of data model "
+ + dataModelNodePath + " to " + targetVersion + " failed.",
+ e);
+ } finally {
+ JcrUtils.logoutQuietly(adminSession);
+ IOUtils.closeQuietly(reader);
+ }
+ }
+
+ protected static int compareVersions(String version1, String version2) {
+ // TODO do a proper version analysis and comparison
+ return version1.compareTo(version2);
+ }
+
+ /** To be called on a stopped repository. */
+ public static void clearRepositoryCaches(File home) {
+ File customNodeTypes = new File(home.getPath()
+ + "/repository/nodetypes/custom_nodetypes.xml");
+ if (customNodeTypes.exists()) {
+ customNodeTypes.delete();
+ if (log.isDebugEnabled())
+ log.debug("Cleared " + customNodeTypes);
+ } else {
+ log.warn("File " + customNodeTypes + " not found.");
+ }
+ }
+
+ /*
+ * FOR USE IN (SORTED) SETS
+ */
+
+ public int compareTo(JackrabbitDataModelMigration dataModelMigration) {
+ // TODO make ordering smarter
+ if (dataModelNodePath.equals(dataModelMigration.dataModelNodePath))
+ return compareVersions(targetVersion,
+ dataModelMigration.targetVersion);
+ else
+ return dataModelNodePath
+ .compareTo(dataModelMigration.dataModelNodePath);
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ if (!(obj instanceof JackrabbitDataModelMigration))
+ return false;
+ JackrabbitDataModelMigration dataModelMigration = (JackrabbitDataModelMigration) obj;
+ return dataModelNodePath.equals(dataModelMigration.dataModelNodePath)
+ && targetVersion.equals(dataModelMigration.targetVersion);
+ }
+
+ @Override
+ public int hashCode() {
+ return targetVersion.hashCode();
+ }
+
+ public void setDataModelNodePath(String dataModelNodePath) {
+ this.dataModelNodePath = dataModelNodePath;
+ }
+
+ public void setTargetVersion(String targetVersion) {
+ this.targetVersion = targetVersion;
+ }
+
+ public void setMigrationCnd(Resource migrationCnd) {
+ this.migrationCnd = migrationCnd;
+ }
+
+ public void setDataModification(JcrCallback dataModification) {
+ this.dataModification = dataModification;
+ }
+
+}
projects / lgpl / argeo-commons.git / commitdiff