at.ac.tuwien.infosys.rnue.interfaces
Interface IHTTPServerEntry

All Known Implementing Classes:
DocumentEntry

public interface IHTTPServerEntry

This interface must be implemented by all classes that are registered in the HTTP server's document base. The registration is done using the IHTTPServer.register method.


Method Summary
 java.lang.String getDescription()
          A textual description of the entry.
 IDocument getDocument(java.lang.String path)
          Return the IDocument document according to this path.
 

Method Detail

getDocument

public IDocument getDocument(java.lang.String path)
                      throws HTTPException,
                             ShareMeException
Return the IDocument document according to this path.

Parameters:
path - java.lang.string to specify the document after the matching prefix has been stripped away. Note: Do not strip away any leading '/', '?' characters.
Returns:
Returns the IDocument document referenzed by path
Throws:
HTTPException - If the file "path" can't be found.
ShareMeException - If an error occurs.

getDescription

public java.lang.String getDescription()
A textual description of the entry.

Returns:
description