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, 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.rmi;
029
030import java.rmi.Remote;
031import java.rmi.RemoteException;
032import java.util.List;
033
034/**
035 * Remote interface for executing shell commands.<p>
036 */
037public interface I_CmsRemoteShell extends Remote {
038
039    /**
040     * Signals to the remote object that the client is done with it (i.e. it can be disposed).<p>
041     *
042     * @throws RemoteException if something goes wrong
043     */
044    void end() throws RemoteException;
045
046    /**
047     * Executes a shell command .<p>
048     * @param cmd the command
049     * @param params the parameters
050     *
051     * @return the shell command result
052     *
053     * @throws RemoteException if RMI stuff goes wrong
054     */
055    CmsShellCommandResult executeCommand(String cmd, List<String> params) throws RemoteException;
056
057    /**
058     * Returns the initial prompt to use.<p>
059     *
060     * @return the prompt
061     *
062     * @throws RemoteException if RMI stuff goes wrong
063     */
064    String getPrompt() throws RemoteException;
065
066}