org.w3c.jigsaw.ssi.commands
Class EchoCommand

java.lang.Object
  org.w3c.jigsaw.ssi.commands.EchoCommand

All Implemented Interfaces:

Command

public class EchoCommand
extends java.lang.Object
implements Command

Implementation of the echo SSI command. As extensions, it has the parameters "reqstate" (for echoing Jigsaw request states) and "reqheader" (for echoing request header).

Also, it can take the flag "here", whose presence means that the variable is to be interpreted at the deepest request level (in the case of chained internal requests), instead of doing so at the top (external request) level. It inserts the value of a variable in the document.

Constructor Summary

EchoCommand()

Method Summary

boolean	acceptCaching() return true if reply can be cached.
Reply	execute(SSIFrame ssiframe, Request request, ArrayDictionary parameters, java.util.Dictionary variables) Executes this command.
java.lang.String	getName() Returns the name of this command.
java.lang.String	getValue(java.util.Dictionary variables, java.lang.String variable, Request request) Returns the (String) value of the given variable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EchoCommand

public EchoCommand()

Method Detail

acceptCaching

public boolean acceptCaching()

return true if reply can be cached.

Specified by:

acceptCaching in interface Command

Returns:

a boolean.

execute

public Reply execute(SSIFrame ssiframe,
                     Request request,
                     ArrayDictionary parameters,
                     java.util.Dictionary variables)

Description copied from interface: Command

Executes this command. Might modify variables. Must not modify the parameters.

It may handle conditional requests, except that if it replies with a status of HTTP.NOT_MODIFIED, it must still reply with a content (the same content that it would have returned for an inconditional request). This is because further SSI commands down the line may decide thay they have been modified, and then a content must be emitted by SSIFrame.

Specified by:

execute in interface Command

request - the original HTTP request

parameters - The parameters for this command

variables - The global variables for the parse

Returns:

a Reply with the output from the command

getName

public java.lang.String getName()

Description copied from interface: Command

Returns the name of this command. (Case sensitivity is up to the lookupCommand method in the command registry.)

Specified by:

getName in interface Command

Returns:

the name of the command

See Also:

CommandRegistry.lookupCommand(java.lang.String)

getValue

public java.lang.String getValue(java.util.Dictionary variables,
                                 java.lang.String variable,
                                 Request request)

Description copied from interface: Command

Returns the (String) value of the given variable.

Specified by:

getValue in interface Command

Returns:

a String instance.