Package org.opencms.rmi

Class CmsRemoteShell

java.lang.Object

java.rmi.server.RemoteObject

java.rmi.server.RemoteServer

java.rmi.server.UnicastRemoteObject

org.opencms.rmi.CmsRemoteShell

All Implemented Interfaces:

java.io.Serializable, java.rmi.Remote, I_CmsRemoteShell

public class CmsRemoteShell
extends java.rmi.server.UnicastRemoteObject
implements I_CmsRemoteShell

RMI object which wraps a CmsShell and can be used for shell command execution.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

Constructors

Constructor	Description
CmsRemoteShell(java.lang.String additionalCommandsName, int port)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
void	end()	Signals to the remote object that the client is done with it (i.e.
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.
static void	unregisterAll()	Removes and unexports all instances.

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CmsRemoteShell

public CmsRemoteShell(java.lang.String additionalCommandsName,
                      int port)
               throws CmsException,
                      java.rmi.RemoteException

Creates a new instance.

Parameters:

additionalCommandsName - a class name for an additional shell commands class (may be null)

port - the port to use

Throws:

CmsException - if something goes wrong

java.rmi.RemoteException - if RMI stuff goes wrong

Method Detail

unregisterAll

public static void unregisterAll()

Removes and unexports all instances.

end

public void end()

Description copied from interface: I_CmsRemoteShell

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

Specified by:

end in interface I_CmsRemoteShell

See Also:

I_CmsRemoteShell.end()

executeCommand

public CmsShellCommandResult executeCommand(java.lang.String cmd,
                                            java.util.List<java.lang.String> params)

Description copied from interface: I_CmsRemoteShell

Executes a shell command .

Specified by:

executeCommand in interface I_CmsRemoteShell

Parameters:

cmd - the command

params - the parameters

Returns:

the shell command result

See Also:

I_CmsRemoteShell.executeCommand(java.lang.String, java.util.List)

getPrompt

public java.lang.String getPrompt()

Description copied from interface: I_CmsRemoteShell

Returns the initial prompt to use.

Specified by:

getPrompt in interface I_CmsRemoteShell

Returns:

the prompt

See Also:

I_CmsRemoteShell.getPrompt()