org.opencms.rmi.CmsRemoteShellServer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencms-core Show documentation
OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.
There is a newer version: 17.0
Show newest version
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library 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 library 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.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.rmi;

import org.opencms.configuration.CmsSystemConfiguration;
import org.opencms.main.CmsLog;
import org.opencms.main.Messages;

import java.rmi.registry.LocateRegistry;
import java.rmi.registry.Registry;
import java.rmi.server.UnicastRemoteObject;

import org.apache.commons.logging.Log;

/**
 * This class is used to initialize the RMI mechanism and export the object used to access the remote shell.
 */
public class CmsRemoteShellServer {

    /** The log instance for this class. */
    private static final Log LOG = CmsLog.getLog(CmsRemoteShellServer.class);

    /** Indicates whether the remote shell server has been initialized. */
    private static boolean m_initialized;

    /** The port for the RMI registry. */
    private int m_port = CmsRemoteShellConstants.DEFAULT_PORT;

    /** The real instance of the shell provider. */
    private I_CmsRemoteShellProvider m_provider;

    /** The RMI registry. */
    private Registry m_registry;

    /**
     * Creates a new instance.

     *
     * @param port the port for the RMI registry
     */
    public CmsRemoteShellServer(int port) {
        m_port = port;
    }

    /**
     * Initializes the remote shell server.

     *
     * @param systemConfiguration the OpenCms system configuration read from opencms-system.xml
     *
     * @return the initialized remote shell server, or null if the server is disabled
     */
    public static CmsRemoteShellServer initialize(CmsSystemConfiguration systemConfiguration) {

        CmsRemoteShellServer result = null;

        if ((systemConfiguration.getShellServerOptions() != null)
            && systemConfiguration.getShellServerOptions().isEnabled()) {

            result = new CmsRemoteShellServer(systemConfiguration.getShellServerOptions().getPort());

            if (CmsLog.INIT.isInfoEnabled()) {
                CmsLog.INIT.info(
                    Messages.get().getBundle().key(Messages.INIT_REMOTESHELL_ENABLED_1, new Integer(result.m_port)));
            }

            result.initServer();
        } else {
            if (CmsLog.INIT.isInfoEnabled()) {
                CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_REMOTESHELL_DISABLED_0));
            }
        }

        return result;
    }

    /**
     * Initializes the RMI registry and exports the remote shell provider to it.

     */
    public void initServer() {

        if (m_initialized) {
            return;
        }
        try {
            m_registry = LocateRegistry.createRegistry(m_port);
            m_provider = new CmsRemoteShellProvider(m_port);
            I_CmsRemoteShellProvider providerStub = (I_CmsRemoteShellProvider)(UnicastRemoteObject.exportObject(
                m_provider,
                m_port));
            m_registry.bind(CmsRemoteShellConstants.PROVIDER, providerStub);
            m_initialized = true;
        } catch (Exception e) {
            LOG.error(e.getLocalizedMessage(), e);
        }
    }

    /**
     * Unregisters remote objects.
     *
     * @throws Exception in case shutting down the RMI threads failed
     */
    public void shutDown() throws Exception {

        if (CmsLog.INIT.isInfoEnabled()) {
            CmsLog.INIT.info(Messages.get().getBundle().key(Messages.INIT_SHUTDOWN_1, this.getClass().getName()));
        }
        for (String boundName : m_registry.list()) {
            m_registry.unbind(boundName);
        }
        UnicastRemoteObject.unexportObject(m_registry, true);
        UnicastRemoteObject.unexportObject(m_provider, true);
        CmsRemoteShell.unregisterAll();
    }
}