Synchronization.java

/**
 * Copyright (C) 2009 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.exoplatform.commons.chromattic;

import java.util.HashMap;
import java.util.Map;

import javax.jcr.RepositoryException;
import javax.jcr.Session;


/**
 * A global notion of synchronization for all chromattic sessions and all JCR sessions.
 *
 * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
 * @version $Revision$
 */
public class Synchronization {

    /** The sessions mapped by workspace name. */
    private final Map<String, Session> repositorySessions = new HashMap<String, Session>();

    /** . */
    private final Map<String, SynchronizedContext> contexts = new HashMap<String, SynchronizedContext>();

    /** . */
    private boolean saveOnClose = true;

    /**
     * Returns a specified global context by its name.
     *
     * @param name the global context name
     * @return the global context or null if no such context exists
     */
    public SynchronizedContext getContext(String name) {
        if (name == null) {
            throw new NullPointerException();
        }
        return contexts.get(name);
    }

    /**
     * Opens a global context related to this synchronization object.
     *
     * @param lifeCycle the life cycle for the session
     * @return the global context related to life cycle
     * @throws IllegalStateException if a context is already created for the specified life cycle
     */
    public SynchronizedContext openContext(ChromatticLifeCycle lifeCycle) throws IllegalStateException {
        if (lifeCycle == null) {
            throw new NullPointerException();
        }
        String name = lifeCycle.getDomainName();
        SynchronizedContext context = contexts.get(name);
        if (context != null) {
            throw new IllegalStateException();
        }
        context = new SynchronizedContext(lifeCycle, this);
        contexts.put(name, context);
        lifeCycle.onOpenSession(context);
        return context;
    }

    public Session doLogin(SynchronizedContext ctx) throws RepositoryException {
        if (ctx == null) {
            throw new NullPointerException();
        }
        if (ctx.synchronization != this) {
            throw new IllegalArgumentException();
        }
        String workspaceName = ctx.lifeCycle.getWorkspaceName();
        Session session = repositorySessions.get(workspaceName);
        if (session == null) {
            session = ctx.openSession();
            repositorySessions.put(workspaceName, session);
        }
        return session;
    }

    public void close(boolean save) {
        // First save all global contexts (sessions)
        for (SynchronizedContext context : contexts.values()) {
            context.close(save);
        }

        // Now close all JCR sessions
        for (Session session : repositorySessions.values()) {
            session.logout();
        }
    }

    public boolean getSaveOnClose() {
        return saveOnClose;
    }

    public void setSaveOnClose(boolean saveOnClose) {
        this.saveOnClose = saveOnClose;
    }
}