X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;ds=inline;f=server%2Fruntime%2Forg.argeo.server.jackrabbit%2Fsrc%2Fmain%2Fjava%2Forg%2Fargeo%2Fjackrabbit%2FJackrabbitContainer.java;h=c8d18698f9c2ddbc546299edf8d1eb473ed25c7c;hb=1d5afdce3e91054f07ddd3c98309c363b4cf1d46;hp=70bc300a1b247af9fdd20c846bba0857ecc0e57f;hpb=0f82096aecc32f674336405cb52f7796ed29d23c;p=lgpl%2Fargeo-commons.git diff --git a/server/runtime/org.argeo.server.jackrabbit/src/main/java/org/argeo/jackrabbit/JackrabbitContainer.java b/server/runtime/org.argeo.server.jackrabbit/src/main/java/org/argeo/jackrabbit/JackrabbitContainer.java index 70bc300a1..c8d18698f 100644 --- a/server/runtime/org.argeo.server.jackrabbit/src/main/java/org/argeo/jackrabbit/JackrabbitContainer.java +++ b/server/runtime/org.argeo.server.jackrabbit/src/main/java/org/argeo/jackrabbit/JackrabbitContainer.java @@ -1,5 +1,5 @@ /* - * Copyright (C) 2010 Mathieu Baudier + * Copyright (C) 2007-2012 Mathieu Baudier * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -13,10 +13,8 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - package org.argeo.jackrabbit; -import java.io.File; import java.io.IOException; import java.io.InputStream; import java.io.InputStreamReader; @@ -27,23 +25,20 @@ 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.UUID; -import java.util.concurrent.Executor; import javax.jcr.Credentials; import javax.jcr.LoginException; import javax.jcr.NoSuchWorkspaceException; import javax.jcr.Node; +import javax.jcr.NodeIterator; import javax.jcr.Repository; import javax.jcr.RepositoryException; import javax.jcr.Session; import javax.jcr.SimpleCredentials; -import javax.jcr.Value; -import org.apache.commons.io.FileUtils; +import org.apache.commons.io.FilenameUtils; import org.apache.commons.io.IOUtils; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; @@ -51,11 +46,10 @@ import org.apache.jackrabbit.api.JackrabbitRepository; import org.apache.jackrabbit.commons.NamespaceHelper; import org.apache.jackrabbit.commons.cnd.CndImporter; import org.apache.jackrabbit.core.RepositoryImpl; -import org.apache.jackrabbit.core.config.RepositoryConfig; -import org.apache.jackrabbit.core.config.RepositoryConfigurationParser; -import org.apache.jackrabbit.jcr2dav.Jcr2davRepositoryFactory; import org.argeo.ArgeoException; +import org.argeo.jcr.ArgeoJcrConstants; import org.argeo.jcr.ArgeoNames; +import org.argeo.jcr.ArgeoTypes; import org.argeo.jcr.JcrUtils; import org.argeo.security.SystemAuthentication; import org.osgi.framework.Bundle; @@ -68,32 +62,29 @@ import org.springframework.security.Authentication; import org.springframework.security.context.SecurityContextHolder; import org.springframework.security.providers.UsernamePasswordAuthenticationToken; import org.springframework.util.SystemPropertyUtils; -import org.xml.sax.InputSource; /** * Wrapper around a Jackrabbit repository which allows to configure it in Spring * and expose it as a {@link Repository}. */ -public class JackrabbitContainer implements Repository { +public class JackrabbitContainer extends JackrabbitWrapper { private Log log = LogFactory.getLog(JackrabbitContainer.class); // remote - private String uri = null; private Credentials remoteSystemCredentials = null; // local private Resource configuration; - private RepositoryConfig repositoryConfig; - private File homeDirectory; private Resource variables; - private Boolean inMemory = false; - - // wrapped repository - private Repository repository; // data model /** Node type definitions in CND format */ private List cndFiles = new ArrayList(); + /** + * Always import CNDs. Useful during development of new data models. In + * production, explicit migration processes should be used. + */ + private Boolean forceCndImport = false; /** Migrations to execute (if not already done) */ private Set dataModelMigrations = new HashSet(); @@ -101,8 +92,6 @@ public class JackrabbitContainer implements Repository { /** Namespaces to register: key is prefix, value namespace */ private Map namespaces = new HashMap(); - private Boolean autocreateWorkspaces = false; - private BundleContext bundleContext; /** @@ -122,15 +111,13 @@ public class JackrabbitContainer implements Repository { init(); } - /** Initializes */ - public void init() { - if (repository != null) { - // we are just wrapping another repository - prepareDataModel(); - return; - } + @Override + protected void postInitWrapped() { + prepareDataModel(); + } - createJackrabbitRepository(); + @Override + protected void postInitNew() { // migrate if needed migrate(); @@ -139,218 +126,10 @@ public class JackrabbitContainer implements Repository { prepareDataModel(); } - /** Actually creates the new repository. */ - protected void createJackrabbitRepository() { - long begin = System.currentTimeMillis(); - InputStream configurationIn = null; - try { - if (uri != null && !uri.trim().equals("")) {// remote - Map params = new HashMap(); - 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); - // we assume that the remote repository has been properly - // configured - } else {// local - // reset uri to null in order to optimize isRemote() - uri = null; - - // temporary - if (inMemory && getHomeDirectory().exists()) { - FileUtils.deleteDirectory(getHomeDirectory()); - log.warn("Deleted Jackrabbit home directory " - + getHomeDirectory()); - } - - // process configuration file - Properties vars = getConfigurationProperties(); - configurationIn = configuration.getInputStream(); - vars.put( - RepositoryConfigurationParser.REPOSITORY_HOME_VARIABLE, - getHomeDirectory().getCanonicalPath()); - repositoryConfig = RepositoryConfig.create(new InputSource( - configurationIn), vars); - - // - // Actual repository creation - // - repository = RepositoryImpl.create(repositoryConfig); - - double duration = ((double) (System.currentTimeMillis() - begin)) / 1000; - log.info("Initialized Jackrabbit repository in " + duration - + " s, home: " + getHomeDirectory() + ", config: " - + configuration); - } - } catch (Exception e) { - throw new ArgeoException("Cannot create Jackrabbit repository " - + getHomeDirectory(), e); - } finally { - IOUtils.closeQuietly(configurationIn); - } - } - - /** Executes migrations, if needed. */ - protected void migrate() { - // Remote migration not supported - if (isRemote()) - return; - - // No migration to perform - if (dataModelMigrations.size() == 0) - return; - - Boolean restartAndClearCaches = false; - - // migrate data - Session session = null; - try { - session = login(); - for (JackrabbitDataModelMigration dataModelMigration : new TreeSet( - 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); - } - - // restart repository - if (restartAndClearCaches) { - JackrabbitDataModelMigration - .clearRepositoryCaches(repositoryConfig); - ((JackrabbitRepository) repository).shutdown(); - createJackrabbitRepository(); - } - - // set data model version - try { - session = login(); - } catch (RepositoryException e) { - throw new ArgeoException("Cannot login to migrated repository", e); - } - - for (JackrabbitDataModelMigration dataModelMigration : new TreeSet( - dataModelMigrations)) { - try { - if (session.itemExists(dataModelMigration - .getDataModelNodePath())) { - Node dataModelNode = session.getNode(dataModelMigration - .getDataModelNodePath()); - dataModelNode.setProperty( - ArgeoNames.ARGEO_DATA_MODEL_VERSION, - dataModelMigration.getTargetVersion()); - session.save(); - } - } catch (Exception e) { - log.error("Cannot set model version", e); - } - } - JcrUtils.logoutQuietly(session); - - } - - /** Lazy init. */ - protected File getHomeDirectory() { - try { - if (homeDirectory == null) { - if (inMemory) { - homeDirectory = new File( - System.getProperty("java.io.tmpdir") - + File.separator - + System.getProperty("user.name") - + File.separator + "jackrabbit-" - + UUID.randomUUID()); - homeDirectory.mkdirs(); - // will it work if directory is not empty?? - homeDirectory.deleteOnExit(); - } - } - - return homeDirectory.getCanonicalFile(); - } catch (IOException e) { - throw new ArgeoException("Cannot get canonical file for " - + homeDirectory, e); - } - } - - /** Shutdown the repository */ - public void destroy() throws Exception { - if (repository != null && repository instanceof RepositoryImpl) { - long begin = System.currentTimeMillis(); - ((RepositoryImpl) repository).shutdown(); - if (inMemory) - if (getHomeDirectory().exists()) { - FileUtils.deleteDirectory(getHomeDirectory()); - if (log.isDebugEnabled()) - log.debug("Deleted Jackrabbit home directory " - + getHomeDirectory()); - } - double duration = ((double) (System.currentTimeMillis() - begin)) / 1000; - log.info("Destroyed Jackrabbit repository in " + duration - + " s, home: " + getHomeDirectory() + ", config " - + configuration); - } - } - - /** - * @deprecated explicitly declare {@link #destroy()} as destroy-method - * instead. - */ - public void dispose() throws Exception { - log.error("## Declare destroy-method=\"destroy\". in the Jackrabbit container bean"); - destroy(); - } - /* - * UTILITIES + * DATA MODEL */ - /** Generates the properties to use in the configuration. */ - protected Properties getConfigurationProperties() { - InputStream propsIn = null; - Properties vars; - try { - vars = new Properties(); - if (variables != null) { - propsIn = variables.getInputStream(); - vars.load(propsIn); - } - // resolve system properties - for (Object key : vars.keySet()) { - // TODO: implement a smarter mechanism to resolve nested ${} - String newValue = SystemPropertyUtils.resolvePlaceholders(vars - .getProperty(key.toString())); - vars.put(key, newValue); - } - // override with system properties - vars.putAll(System.getProperties()); - - if (log.isTraceEnabled()) { - log.trace("Jackrabbit config variables:"); - for (Object key : new TreeSet(vars.keySet())) - log.trace(key + "=" + vars.getProperty(key.toString())); - } - - } catch (IOException e) { - throw new ArgeoException("Cannot read configuration properties", e); - } finally { - IOUtils.closeQuietly(propsIn); - } - return vars; - } - /** * Import declared node type definitions and register namespaces. Tries to * update the node definitions if they have changed. In case of failures an @@ -372,20 +151,7 @@ public class JackrabbitContainer implements Repository { // load CND files from classpath or as URL for (String resUrl : cndFiles) { boolean classpath; - // if (resUrl.startsWith("classpath:")) { - // // resUrl = resUrl.substring("classpath:".length()); - // classpath = true; - // } else if (resUrl.indexOf(':') < 0) { - // if (!resUrl.startsWith("/")) { - // resUrl = "/" + resUrl; - // log.warn("Classpath should start with '/'"); - // } - // resUrl = "classpath:" + resUrl; - // classpath = true; - // } else { - // classpath = false; - // } - + // normalize URL if (resUrl.startsWith("classpath:")) { resUrl = resUrl.substring("classpath:".length()); classpath = true; @@ -400,12 +166,6 @@ public class JackrabbitContainer implements Repository { classpath = false; } - // Resource resource = - // resourceLoader.getResource(resUrl); - - // = classpath ? new ClassPathResource(resUrl) : new - // UrlResource(resUrl); - URL url; Bundle dataModelBundle = null; if (classpath) { @@ -428,10 +188,73 @@ public class JackrabbitContainer implements Repository { url = new URL(resUrl); } + // check existing data model nodes + new NamespaceHelper(session).registerNamespace( + ArgeoNames.ARGEO, ArgeoNames.ARGEO_NAMESPACE); + if (!session + .itemExists(ArgeoJcrConstants.DATA_MODELS_BASE_PATH)) + JcrUtils.mkdirs(session, + ArgeoJcrConstants.DATA_MODELS_BASE_PATH); + Node dataModels = session + .getNode(ArgeoJcrConstants.DATA_MODELS_BASE_PATH); + NodeIterator it = dataModels.getNodes(); + Node dataModel = null; + while (it.hasNext()) { + Node node = it.nextNode(); + if (node.getProperty(ArgeoNames.ARGEO_URI).getString() + .equals(resUrl)) { + dataModel = node; + break; + } + } + + // does nothing if data model already registered + if (dataModel != null && !forceCndImport) { + if (dataModelBundle != null) { + String version = dataModel.getProperty( + ArgeoNames.ARGEO_DATA_MODEL_VERSION) + .getString(); + String dataModelBundleVersion = dataModelBundle + .getVersion().toString(); + if (!version.equals(dataModelBundleVersion)) { + log.warn("Data model with version " + + dataModelBundleVersion + + " available, current version is " + + version); + } + } + // do not implicitly update + return; + } + Reader reader = null; try { reader = new InputStreamReader(url.openStream()); + // actually imports the CND CndImporter.registerNodeTypes(reader, session, true); + + // FIXME: what if argeo.cnd would not be the first called on + // a new repo? argeo:dataModel would not be found + String fileName = FilenameUtils.getName(url.getPath()); + if (dataModel == null) { + dataModel = dataModels.addNode(fileName); + dataModel.addMixin(ArgeoTypes.ARGEO_DATA_MODEL); + dataModel.setProperty(ArgeoNames.ARGEO_URI, resUrl); + } else { + session.getWorkspace().getVersionManager() + .checkout(dataModel.getPath()); + } + if (dataModelBundle != null) + dataModel.setProperty( + ArgeoNames.ARGEO_DATA_MODEL_VERSION, + dataModelBundle.getVersion().toString()); + else + dataModel.setProperty( + ArgeoNames.ARGEO_DATA_MODEL_VERSION, "0.0.0"); + JcrUtils.updateLastModified(dataModel); + session.save(); + session.getWorkspace().getVersionManager() + .checkin(dataModel.getPath()); } finally { IOUtils.closeQuietly(reader); } @@ -454,54 +277,78 @@ public class JackrabbitContainer implements Repository { } - /** Find which OSGi bundle provided the data model resource */ - protected Bundle findDataModelBundle(String resUrl) { - if (resUrl.startsWith("/")) - resUrl = resUrl.substring(1); - String pkg = resUrl.substring(0, resUrl.lastIndexOf('/')).replace('/', - '.'); - ServiceReference paSr = bundleContext - .getServiceReference(PackageAdmin.class.getName()); - PackageAdmin packageAdmin = (PackageAdmin) bundleContext - .getService(paSr); + /** Executes migrations, if needed. */ + protected void migrate() { + // Remote migration not supported + if (isRemote()) + return; - // find exported package - ExportedPackage exportedPackage = null; - ExportedPackage[] exportedPackages = packageAdmin - .getExportedPackages(pkg); - if (exportedPackages == null) - throw new ArgeoException("No exported package found for " + pkg); - for (ExportedPackage ep : exportedPackages) { - for (Bundle b : ep.getImportingBundles()) { - if (b.getBundleId() == bundleContext.getBundle().getBundleId()) { - exportedPackage = ep; - break; + // No migration to perform + if (dataModelMigrations.size() == 0) + return; + + Boolean restartAndClearCaches = false; + + // migrate data + Session session = null; + try { + session = login(); + for (JackrabbitDataModelMigration dataModelMigration : new TreeSet( + 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); } - Bundle exportingBundle = null; - if (exportedPackage != null) { - exportingBundle = exportedPackage.getExportingBundle(); - } else { - throw new ArgeoException("No OSGi exporting package found for " - + resUrl); + // restart repository + if (restartAndClearCaches) { + Repository repository = getRepository(); + if (repository instanceof RepositoryImpl) { + JackrabbitDataModelMigration + .clearRepositoryCaches(((RepositoryImpl) repository) + .getConfig()); + } + ((JackrabbitRepository) repository).shutdown(); + createJackrabbitRepository(); } - return exportingBundle; - } - /* - * DELEGATED JCR REPOSITORY METHODS - */ + // set data model version + try { + session = login(); + } catch (RepositoryException e) { + throw new ArgeoException("Cannot login to migrated repository", e); + } - public String getDescriptor(String key) { - return getRepository().getDescriptor(key); - } + for (JackrabbitDataModelMigration dataModelMigration : new TreeSet( + dataModelMigrations)) { + try { + if (session.itemExists(dataModelMigration + .getDataModelNodePath())) { + Node dataModelNode = session.getNode(dataModelMigration + .getDataModelNodePath()); + dataModelNode.setProperty( + ArgeoNames.ARGEO_DATA_MODEL_VERSION, + dataModelMigration.getTargetVersion()); + session.save(); + } + } catch (Exception e) { + log.error("Cannot set model version", e); + } + } + JcrUtils.logoutQuietly(session); - public String[] getDescriptorKeys() { - return getRepository().getDescriptorKeys(); } + /* + * REPOSITORY INTERCEPTOR + */ /** Central login method */ public Session login(Credentials credentials, String workspaceName) throws LoginException, NoSuchWorkspaceException, @@ -523,98 +370,83 @@ public class JackrabbitContainer implements Repository { } } - Session session; - try { - session = getRepository().login(credentials, workspaceName); - } catch (NoSuchWorkspaceException e) { - if (autocreateWorkspaces && workspaceName != null) - session = createWorkspaceAndLogsIn(credentials, workspaceName); - else - throw e; - } - processNewSession(session); - return session; - } - - public Session login() throws LoginException, RepositoryException { - return login(null, null); - } - - public Session login(Credentials credentials) throws LoginException, - RepositoryException { - return login(credentials, null); - } - - public Session login(String workspaceName) throws LoginException, - NoSuchWorkspaceException, RepositoryException { - return login(null, workspaceName); + return super.login(credentials, workspaceName); } - /** Called after a session has been created, does nothing by default. */ - protected void processNewSession(Session session) { - } - - public Boolean isRemote() { - return uri != null; - } + /* + * UTILITIES + */ - /** Wraps access to the repository, making sure it is available. */ - protected Repository getRepository() { - if (repository == null) { - throw new ArgeoException( - "No repository initialized." - + " Was the init() method called?" - + " The dispose() method should also be called on shutdown."); + @Override + protected InputStream readConfiguration() { + try { + return configuration != null ? configuration.getInputStream() + : null; + } catch (IOException e) { + throw new ArgeoException("Cannot read Jackrabbit configuration " + + configuration, e); } - return repository; } - /** - * Logs in to the default workspace, creates the required workspace, logs - * out, logs in to the required workspace. - */ - protected Session createWorkspaceAndLogsIn(Credentials credentials, - String workspaceName) throws RepositoryException { - if (workspaceName == null) - throw new ArgeoException("No workspace specified."); - Session session = getRepository().login(credentials); - session.getWorkspace().createWorkspace(workspaceName); - session.logout(); - return getRepository().login(credentials, workspaceName); + @Override + protected InputStream readVariables() { + try { + return variables != null ? variables.getInputStream() : null; + } catch (IOException e) { + throw new ArgeoException("Cannot read Jackrabbit variables " + + variables, e); + } } - public boolean isStandardDescriptor(String key) { - return getRepository().isStandardDescriptor(key); + @Override + protected String resolvePlaceholders(String string, + Map variables) { + return SystemPropertyUtils.resolvePlaceholders(string); } - public boolean isSingleValueDescriptor(String key) { - return getRepository().isSingleValueDescriptor(key); - } + /** Find which OSGi bundle provided the data model resource */ + protected Bundle findDataModelBundle(String resUrl) { + if (resUrl.startsWith("/")) + resUrl = resUrl.substring(1); + String pkg = resUrl.substring(0, resUrl.lastIndexOf('/')).replace('/', + '.'); + ServiceReference paSr = bundleContext + .getServiceReference(PackageAdmin.class.getName()); + PackageAdmin packageAdmin = (PackageAdmin) bundleContext + .getService(paSr); - public Value getDescriptorValue(String key) { - return getRepository().getDescriptorValue(key); - } + // find exported package + ExportedPackage exportedPackage = null; + ExportedPackage[] exportedPackages = packageAdmin + .getExportedPackages(pkg); + if (exportedPackages == null) + throw new ArgeoException("No exported package found for " + pkg); + for (ExportedPackage ep : exportedPackages) { + for (Bundle b : ep.getImportingBundles()) { + if (b.getBundleId() == bundleContext.getBundle().getBundleId()) { + exportedPackage = ep; + break; + } + } + } - public Value[] getDescriptorValues(String key) { - return getRepository().getDescriptorValues(key); + Bundle exportingBundle = null; + if (exportedPackage != null) { + exportingBundle = exportedPackage.getExportingBundle(); + } else { + throw new ArgeoException("No OSGi exporting package found for " + + resUrl); + } + return exportingBundle; } /* * FIELDS ACCESS */ - - public void setHomeDirectory(File homeDirectory) { - this.homeDirectory = homeDirectory; - } - public void setConfiguration(Resource configuration) { this.configuration = configuration; } - public void setInMemory(Boolean inMemory) { - this.inMemory = inMemory; - } - public void setNamespaces(Map namespaces) { this.namespaces = namespaces; } @@ -627,26 +459,10 @@ public class JackrabbitContainer implements Repository { this.variables = variables; } - public void setUri(String uri) { - this.uri = uri; - } - public void setRemoteSystemCredentials(Credentials remoteSystemCredentials) { this.remoteSystemCredentials = remoteSystemCredentials; } - public void setSystemExecutor(Executor systemExecutor) { - throw new IllegalArgumentException( - "systemExecutor is not supported anymore, use:\n" - + "\n" - + "\t\n" - + ""); - } - - public void setRepository(Repository repository) { - this.repository = repository; - } - public void setDataModelMigrations( Set dataModelMigrations) { this.dataModelMigrations = dataModelMigrations; @@ -655,4 +471,9 @@ public class JackrabbitContainer implements Repository { public void setBundleContext(BundleContext bundleContext) { this.bundleContext = bundleContext; } + + public void setForceCndImport(Boolean forceCndUpdate) { + this.forceCndImport = forceCndUpdate; + } + }