All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface w3c.jigsaw.ssi.Command

public interface Command
This interface is used to supply implementations of SSI commands. They have to be registered in a CommandRegistry, which in turn is used by the SSIResource.

See Also:
CommandRegistry

Method Index

o execute(SSIResource, Request, ArrayDictionary, Dictionary)
Executes this command.
o getName()
Returns the name of this command.
o getValue(Dictionary, String)
Returns the (String) value of the given variable.

Methods

o execute 
 public abstract Reply execute(SSIResource resource,
                               Request request,
                               ArrayDictionary parameters,
                               Dictionary variables)
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 SSIResource.

Parameters:
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
o getName 
 public abstract String getName()
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:
lookupCommand
o getValue 
 public abstract String getValue(Dictionary variables,
                                 String variable)
Returns the (String) value of the given variable.

Returns:
a String instance. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index