001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.main;
029
030import org.opencms.file.CmsObject;
031
032/**
033 * Provides scriptable access to a class from the CmsShell.<p>
034 *
035 * @since 6.0.0
036 */
037public interface I_CmsShellCommands {
038
039    /**
040     * Provides access to the shell CmsObject and the shell itself.<p>
041     *
042     * @param cms the shell CmsObject
043     * @param shell the CmsShell
044     */
045    void initShellCmsObject(CmsObject cms, CmsShell shell);
046
047    /**
048     * May be called after shell exit, can e.g. be used to output a goodbye message.<p>
049     *
050     * Please note: This method is not guaranteed to be called. For a shell that has more than
051     * one shell command object initialized, only the exit method of one of those will be called.<p>
052     */
053    void shellExit();
054
055    /**
056     * May be called before shell startup, can e.g. be used to output a welcome message.<p>
057     *
058     * Please note: This method is not guaranteed to be called. For a shell that has more than
059     * one shell command object initialized, only the start method of one of those will be called.<p>
060     */
061    void shellStart();
062}