AbstractBricketApplication.java

/**
 * Copyright 2011 the original author or authors.
 *
 * 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.bricket.web;

import brix.jcr.ThreadLocalSessionFactory;
import brix.workspace.WorkspaceManager;
import org.apache.jackrabbit.core.RepositoryImpl;
import org.apache.wicket.Request;
import org.apache.wicket.RequestCycle;
import org.apache.wicket.Response;
import org.apache.wicket.authentication.AuthenticatedWebApplication;
import org.apache.wicket.protocol.http.WebApplication;
import org.apache.wicket.protocol.http.WebRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;

import javax.jcr.Repository;

/**
 * This class takes care of peripheral duties such as creating the Jcr
 * repository, setting up JcrSessionFactory, etc.
 * 
 * @author Ingo Renner
 * @author Henning Teek
 */
public abstract class AbstractBricketApplication extends AuthenticatedWebApplication {
    private final Logger log = LoggerFactory.getLogger(AbstractBricketApplication.class);

    /** application properties */
    private BricketApplicationProperties properties;
    /** jcr repository */
    private Repository repository;

    /**
     * jcr session factory. sessions created by this factory are cleaned up by
     * {@link BricketRequestCycle}
     */
    private ThreadLocalSessionFactory sessionFactory;

    /** workspace manager to be used by brix */
    private WorkspaceManager workspaceManager;

    /** {@inheritDoc} */
    @Override
    public final RequestCycle newRequestCycle(Request request, Response response) {
        // install request cycle that will cleanup #sessionFactory at the end of
        // request
        assert (request instanceof WebRequest);
        return new BricketRequestCycle(this, (WebRequest) request, response);
    }

    @Override
    protected void init() {
        super.init();
        // read application properties
        properties = new BricketApplicationProperties();

        // create jcr repository
        repository = (Repository) getApplicationContext().getBean("repository");

        // create session factory that will be used to feed brix jcr sessions
        sessionFactory = (ThreadLocalSessionFactory) getApplicationContext().getBean("sessionFactory");

        // create workspace manager brix will use to access workspace-related
        // functionality
        workspaceManager = (WorkspaceManager) getApplicationContext().getBean("workspaceManager");

        // since creating workspace manager may require access to session we
        // need to clean up
        cleanupSessionFactory();

        getMarkupSettings().setStripWicketTags(true);
    }

    /** {@inheritDoc} */
    @Override
    protected void onDestroy() {
        // shutdown the repository cleanly
        if (repository instanceof RepositoryImpl) {
            log.info("Shutting down JackRabbit repository...");
            ((RepositoryImpl) repository).shutdown();
        }
        super.onDestroy();
    }

    /**
     * cleans up any opened sessions in session factory
     */
    public final void cleanupSessionFactory() {
        sessionFactory.cleanup();
    }

    /**
     * @return application instance
     */
    public static AbstractBricketApplication get() {
        return (AbstractBricketApplication) WebApplication.get();
    }

    /**
     * @return application properties
     */
    public final BricketApplicationProperties getProperties() {
        return properties;
    }

    /**
     * @return jcr repository
     */
    public final Repository getRepository() {
        return repository;
    }

    /**
     * @return jcr session factory
     */
    public final ThreadLocalSessionFactory getJcrSessionFactory() {
        return sessionFactory;
    }

    /**
     * @return workspace manager
     */
    public final WorkspaceManager getWorkspaceManager() {
        return workspaceManager;
    }

    /**
     * @return workspace id
     */
    public final String getWorkspaceId() {
        return getWorkspaceManager().getWorkspaces().get(0).getId();
    }

    public ApplicationContext getApplicationContext() {
        return WebApplicationContextUtils.getRequiredWebApplicationContext(getServletContext());
    }
}