org.w3c.jigsaw.ssi.commands
Class IncludeCommand

java.lang.Object
  org.w3c.jigsaw.ssi.commands.BasicCommand
      org.w3c.jigsaw.ssi.commands.IncludeCommand

All Implemented Interfaces:

Command

public class IncludeCommand
extends BasicCommand

Implementation of the SSI include command. (CGI scripts can be included, simply by providing a so-called virtual path to a CgiResource).

Field Summary

Fields inherited from class org.w3c.jigsaw.ssi.commands.BasicCommand

STATE_IF_MODIFIED_SINCE

Constructor Summary

IncludeCommand()

Method Summary

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 org.w3c.jigsaw.ssi.commands.BasicCommand

acceptCaching, handleSimpleIMS

Methods inherited from class java.lang.Object

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

Constructor Detail

IncludeCommand

public IncludeCommand()

Method Detail

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.)

Returns:

the name of the command

See Also:

CommandRegistry.lookupCommand(java.lang.String)

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.

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

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.

Returns:

a String instance.