org.opencms.rmi

Interface I_CmsRemoteShell

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

CmsRemoteShell

public interface I_CmsRemoteShell
extends java.rmi.Remote

Remote interface for executing shell commands.

Method Summary

Modifier and Type	Method and Description
void	end() Signals to the remote object that the client is done with it (i.e. it can be disposed).
CmsShellCommandResult	executeCommand(java.lang.String cmd, java.util.List<java.lang.String> params) Executes a shell command .
java.lang.String	getPrompt() Returns the initial prompt to use.

Method Detail

end

void end()
  throws java.rmi.RemoteException

Signals to the remote object that the client is done with it (i.e. it can be disposed).

Throws:

java.rmi.RemoteException - if something goes wrong

executeCommand

CmsShellCommandResult executeCommand(java.lang.String cmd,
                                     java.util.List<java.lang.String> params)
                              throws java.rmi.RemoteException

Executes a shell command .

Parameters:

cmd - the command

params - the parameters

Returns:

the shell command result

Throws:

java.rmi.RemoteException - if RMI stuff goes wrong

getPrompt

java.lang.String getPrompt()
                    throws java.rmi.RemoteException

Returns the initial prompt to use.

Returns:

the prompt

Throws:

java.rmi.RemoteException - if RMI stuff goes wrong